Skip to content

Adding Prisma API documentation #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Adding Prisma API documentation #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .insomnia/Request/req_3429270d219b46f8b7c6590a0ec0c6ac.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
_id: req_3429270d219b46f8b7c6590a0ec0c6ac
type: Request
parentId: fld_80bc7ee1b14547dc860545b5af4878c5
modified: 1690474727059
created: 1690417154942
url: "{{ _.base_url }}/api/v1/reviews/{{ _.review_id }}/prisma"
name: Prisma
description: "Endpoint to return prisma mapping hash, its behavior depends on feature flag :prisma"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not accurate. It returns a URL where clients should navigate to in order to access the PRISMA app.
Explain the flag behaviour beyond just mentioning it.

method: GET
body: {}
parameters: []
headers:
- id: pair_70739838651447dfb8d681161a824a36
name: Authorization
value: ""
description: ""
disabled: true
authentication:
type: bearer
token: "{{ _.manual_token }}"
metaSortKey: -1690417154942
isPrivate: false
settingStoreCookies: true
settingSendCookies: false
settingDisableRenderRequestBody: false
settingEncodeUrl: true
settingRebuildPath: true
settingFollowRedirects: global