-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(docs/github&jira): added bruno files for the whole github rest-a…
…pi & updated jira docs
- Loading branch information
1 parent
47d76f2
commit 2627d31
Showing
935 changed files
with
497,395 additions
and
1 deletion.
There are no files selected for viewing
15 changes: 15 additions & 0 deletions
15
docs/github/api.github.com.2022-11-28/GitHub v3 REST API/-/GitHub API Root.bru
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| meta { | ||
| name: GitHub API Root | ||
| type: http | ||
| seq: 1 | ||
| } | ||
|
|
||
| get { | ||
| url: {{baseUrl}}/ | ||
| body: none | ||
| auth: none | ||
| } | ||
|
|
||
| headers { | ||
| Accept: application/json | ||
| } |
15 changes: 15 additions & 0 deletions
15
...com.2022-11-28/GitHub v3 REST API/advisories/-ghsa_id-/Get a global security advisory.bru
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| meta { | ||
| name: Get a global security advisory | ||
| type: http | ||
| seq: 1 | ||
| } | ||
|
|
||
| get { | ||
| url: {{baseUrl}}/advisories/:ghsa_id | ||
| body: none | ||
| auth: none | ||
| } | ||
|
|
||
| headers { | ||
| Accept: application/json | ||
| } |
34 changes: 34 additions & 0 deletions
34
...i.github.com.2022-11-28/GitHub v3 REST API/advisories/List global security advisories.bru
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| meta { | ||
| name: List global security advisories | ||
| type: http | ||
| seq: 1 | ||
| } | ||
|
|
||
| get { | ||
| url: {{baseUrl}}/advisories?ghsa_id=<string>&type=reviewed&cve_id=<string>&ecosystem=pub&severity=medium&cwes=<string>&is_withdrawn=<boolean>&affects=<string>&published=<string>&updated=<string>&modified=<string>&before=<string>&after=<string>&direction=desc&per_page=30&sort=published | ||
| body: none | ||
| auth: none | ||
| } | ||
|
|
||
| query { | ||
| ghsa_id: <string> | ||
| type: reviewed | ||
| cve_id: <string> | ||
| ecosystem: pub | ||
| severity: medium | ||
| cwes: <string> | ||
| is_withdrawn: <boolean> | ||
| affects: <string> | ||
| published: <string> | ||
| updated: <string> | ||
| modified: <string> | ||
| before: <string> | ||
| after: <string> | ||
| direction: desc | ||
| per_page: 30 | ||
| sort: published | ||
| } | ||
|
|
||
| headers { | ||
| Accept: application/json | ||
| } |
15 changes: 15 additions & 0 deletions
15
...tHub v3 REST API/app-manifests/-code-/conversions/Create a GitHub App from a manifest.bru
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| meta { | ||
| name: Create a GitHub App from a manifest | ||
| type: http | ||
| seq: 1 | ||
| } | ||
|
|
||
| post { | ||
| url: {{baseUrl}}/app-manifests/:code/conversions | ||
| body: none | ||
| auth: none | ||
| } | ||
|
|
||
| headers { | ||
| Accept: application/json | ||
| } |
15 changes: 15 additions & 0 deletions
15
docs/github/api.github.com.2022-11-28/GitHub v3 REST API/app/Get the authenticated app.bru
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| meta { | ||
| name: Get the authenticated app | ||
| type: http | ||
| seq: 1 | ||
| } | ||
|
|
||
| get { | ||
| url: {{baseUrl}}/app | ||
| body: none | ||
| auth: none | ||
| } | ||
|
|
||
| headers { | ||
| Accept: application/json | ||
| } |
15 changes: 15 additions & 0 deletions
15
....2022-11-28/GitHub v3 REST API/app/hook/config/Get a webhook configuration for an app.bru
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| meta { | ||
| name: Get a webhook configuration for an app | ||
| type: http | ||
| seq: 1 | ||
| } | ||
|
|
||
| get { | ||
| url: {{baseUrl}}/app/hook/config | ||
| body: none | ||
| auth: none | ||
| } | ||
|
|
||
| headers { | ||
| Accept: application/json | ||
| } |
25 changes: 25 additions & 0 deletions
25
...22-11-28/GitHub v3 REST API/app/hook/config/Update a webhook configuration for an app.bru
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| meta { | ||
| name: Update a webhook configuration for an app | ||
| type: http | ||
| seq: 2 | ||
| } | ||
|
|
||
| patch { | ||
| url: {{baseUrl}}/app/hook/config | ||
| body: json | ||
| auth: none | ||
| } | ||
|
|
||
| headers { | ||
| Content-Type: application/json | ||
| Accept: application/json | ||
| } | ||
|
|
||
| body:json { | ||
| { | ||
| "url": "<uri>", | ||
| "content_type": "<string>", | ||
| "secret": "<string>", | ||
| "insecure_ssl": "<string>" | ||
| } | ||
| } |
15 changes: 15 additions & 0 deletions
15
...itHub v3 REST API/app/hook/deliveries/-delivery_id-/Get a delivery for an app webhook.bru
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| meta { | ||
| name: Get a delivery for an app webhook | ||
| type: http | ||
| seq: 1 | ||
| } | ||
|
|
||
| get { | ||
| url: {{baseUrl}}/app/hook/deliveries/:delivery_id | ||
| body: none | ||
| auth: none | ||
| } | ||
|
|
||
| headers { | ||
| Accept: application/json | ||
| } |
15 changes: 15 additions & 0 deletions
15
...PI/app/hook/deliveries/-delivery_id-/attempts/Redeliver a delivery for an app webhook.bru
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| meta { | ||
| name: Redeliver a delivery for an app webhook | ||
| type: http | ||
| seq: 1 | ||
| } | ||
|
|
||
| post { | ||
| url: {{baseUrl}}/app/hook/deliveries/:delivery_id/attempts | ||
| body: none | ||
| auth: none | ||
| } | ||
|
|
||
| headers { | ||
| Accept: application/json | ||
| } |
21 changes: 21 additions & 0 deletions
21
....2022-11-28/GitHub v3 REST API/app/hook/deliveries/List deliveries for an app webhook.bru
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| meta { | ||
| name: List deliveries for an app webhook | ||
| type: http | ||
| seq: 1 | ||
| } | ||
|
|
||
| get { | ||
| url: {{baseUrl}}/app/hook/deliveries?per_page=30&cursor=<string>&redelivery=<boolean> | ||
| body: none | ||
| auth: none | ||
| } | ||
|
|
||
| query { | ||
| per_page: 30 | ||
| cursor: <string> | ||
| redelivery: <boolean> | ||
| } | ||
|
|
||
| headers { | ||
| Accept: application/json | ||
| } |
20 changes: 20 additions & 0 deletions
20
...ST API/app/installation-requests/List installation requests for the authenticated app.bru
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| meta { | ||
| name: List installation requests for the authenticated app | ||
| type: http | ||
| seq: 1 | ||
| } | ||
|
|
||
| get { | ||
| url: {{baseUrl}}/app/installation-requests?per_page=30&page=1 | ||
| body: none | ||
| auth: none | ||
| } | ||
|
|
||
| query { | ||
| per_page: 30 | ||
| page: 1 | ||
| } | ||
|
|
||
| headers { | ||
| Accept: application/json | ||
| } |
15 changes: 15 additions & 0 deletions
15
.../app/installations/-installation_id-/Delete an installation for the authenticated app.bru
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| meta { | ||
| name: Delete an installation for the authenticated app | ||
| type: http | ||
| seq: 2 | ||
| } | ||
|
|
||
| delete { | ||
| url: {{baseUrl}}/app/installations/:installation_id | ||
| body: none | ||
| auth: none | ||
| } | ||
|
|
||
| headers { | ||
| Accept: application/json | ||
| } |
15 changes: 15 additions & 0 deletions
15
...API/app/installations/-installation_id-/Get an installation for the authenticated app.bru
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| meta { | ||
| name: Get an installation for the authenticated app | ||
| type: http | ||
| seq: 1 | ||
| } | ||
|
|
||
| get { | ||
| url: {{baseUrl}}/app/installations/:installation_id | ||
| body: none | ||
| auth: none | ||
| } | ||
|
|
||
| headers { | ||
| Accept: application/json | ||
| } |
79 changes: 79 additions & 0 deletions
79
...ations/-installation_id-/access_tokens/Create an installation access token for an app.bru
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| meta { | ||
| name: Create an installation access token for an app | ||
| type: http | ||
| seq: 1 | ||
| } | ||
|
|
||
| post { | ||
| url: {{baseUrl}}/app/installations/:installation_id/access_tokens | ||
| body: json | ||
| auth: none | ||
| } | ||
|
|
||
| headers { | ||
| Content-Type: application/json | ||
| Accept: application/json | ||
| } | ||
|
|
||
| body:json { | ||
| { | ||
| "repositories": [ | ||
| "<string>", | ||
| "<string>" | ||
| ], | ||
| "repository_ids": [ | ||
| "<integer>", | ||
| "<integer>" | ||
| ], | ||
| "permissions": { | ||
| "actions": "write", | ||
| "administration": "read", | ||
| "checks": "read", | ||
| "codespaces": "write", | ||
| "contents": "read", | ||
| "dependabot_secrets": "write", | ||
| "deployments": "read", | ||
| "environments": "read", | ||
| "issues": "read", | ||
| "metadata": "write", | ||
| "packages": "read", | ||
| "pages": "read", | ||
| "pull_requests": "read", | ||
| "repository_custom_properties": "write", | ||
| "repository_hooks": "write", | ||
| "repository_projects": "admin", | ||
| "secret_scanning_alerts": "read", | ||
| "secrets": "write", | ||
| "security_events": "read", | ||
| "single_file": "write", | ||
| "statuses": "read", | ||
| "vulnerability_alerts": "read", | ||
| "workflows": "write", | ||
| "members": "write", | ||
| "organization_administration": "read", | ||
| "organization_custom_roles": "write", | ||
| "organization_custom_org_roles": "read", | ||
| "organization_custom_properties": "admin", | ||
| "organization_copilot_seat_management": "write", | ||
| "organization_announcement_banners": "write", | ||
| "organization_events": "read", | ||
| "organization_hooks": "write", | ||
| "organization_personal_access_tokens": "write", | ||
| "organization_personal_access_token_requests": "read", | ||
| "organization_plan": "read", | ||
| "organization_projects": "write", | ||
| "organization_packages": "read", | ||
| "organization_secrets": "write", | ||
| "organization_self_hosted_runners": "write", | ||
| "organization_user_blocking": "read", | ||
| "team_discussions": "read", | ||
| "email_addresses": "read", | ||
| "followers": "read", | ||
| "git_ssh_keys": "write", | ||
| "gpg_keys": "read", | ||
| "interaction_limits": "write", | ||
| "profile": "write", | ||
| "starring": "read" | ||
| } | ||
| } | ||
| } |
15 changes: 15 additions & 0 deletions
15
...v3 REST API/app/installations/-installation_id-/suspended/Suspend an app installation.bru
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| meta { | ||
| name: Suspend an app installation | ||
| type: http | ||
| seq: 1 | ||
| } | ||
|
|
||
| put { | ||
| url: {{baseUrl}}/app/installations/:installation_id/suspended | ||
| body: none | ||
| auth: none | ||
| } | ||
|
|
||
| headers { | ||
| Accept: application/json | ||
| } |
15 changes: 15 additions & 0 deletions
15
... REST API/app/installations/-installation_id-/suspended/Unsuspend an app installation.bru
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| meta { | ||
| name: Unsuspend an app installation | ||
| type: http | ||
| seq: 2 | ||
| } | ||
|
|
||
| delete { | ||
| url: {{baseUrl}}/app/installations/:installation_id/suspended | ||
| body: none | ||
| auth: none | ||
| } | ||
|
|
||
| headers { | ||
| Accept: application/json | ||
| } |
22 changes: 22 additions & 0 deletions
22
...-28/GitHub v3 REST API/app/installations/List installations for the authenticated app.bru
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| meta { | ||
| name: List installations for the authenticated app | ||
| type: http | ||
| seq: 1 | ||
| } | ||
|
|
||
| get { | ||
| url: {{baseUrl}}/app/installations?per_page=30&page=1&since=<dateTime>&outdated=<string> | ||
| body: none | ||
| auth: none | ||
| } | ||
|
|
||
| query { | ||
| per_page: 30 | ||
| page: 1 | ||
| since: <dateTime> | ||
| outdated: <string> | ||
| } | ||
|
|
||
| headers { | ||
| Accept: application/json | ||
| } |
Oops, something went wrong.