Skip to content

Commit

Permalink
fix: update docs for the "Update a secret scanning alert" API (`PATCH…
Browse files Browse the repository at this point in the history 
… /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}`) to clarify that a `resolution` must be provided when setting `state` to `resolved` and replace some `string`s with `enum`s (#292)

WIP: schema updates

Co-authored-by: Octokit Bot <octokitbot@martynus.net>
  • Loading branch information
@octokitbot
octokitbot and Octokit Bot committed Sep 14, 2022
1 parent 58951a7 commit cb05d6e
Show file tree
Hide file tree
Showing 38 changed files with 1,212 additions and 735 deletions.
81 changes: 54 additions & 27 deletions cache/api.github.com.deref.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20541,7 +20541,7 @@
"description": "The REST API URL of the code locations for this alert."
},
"state": {
"description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.",
"description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.",
"type": "string",
"enum": [
"open",
Expand Down Expand Up @@ -37094,7 +37094,7 @@
},
{
"name": "state",
"description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.",
"description": "Indicates the state of the issues to return.",
"in": "query",
"required": false,
"schema": {
Expand All @@ -37118,7 +37118,7 @@
},
{
"name": "sort",
"description": "What to sort results by. Can be either `created`, `updated`, `comments`.",
"description": "What to sort results by.",
"in": "query",
"required": false,
"schema": {
Expand Down Expand Up @@ -40423,7 +40423,7 @@
"type": "string"
},
"mode": {
"description": "The rendering mode. Can be either `markdown` or `gfm`.",
"description": "The rendering mode.",
"enum": [
"markdown",
"gfm"
Expand Down Expand Up @@ -82808,7 +82808,7 @@
},
{
"name": "state",
"description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.",
"description": "Indicates the state of the issues to return.",
"in": "query",
"required": false,
"schema": {
Expand All @@ -82832,7 +82832,7 @@
},
{
"name": "sort",
"description": "What to sort results by. Can be either `created`, `updated`, `comments`.",
"description": "What to sort results by.",
"in": "query",
"required": false,
"schema": {
Expand Down Expand Up @@ -102848,7 +102848,7 @@
},
{
"name": "state",
"description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.",
"description": "Indicates the state of the projects to return.",
"in": "query",
"required": false,
"schema": {
Expand Down Expand Up @@ -107797,7 +107797,7 @@
"description": "The REST API URL of the code locations for this alert."
},
"state": {
"description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.",
"description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.",
"type": "string",
"enum": [
"open",
Expand Down Expand Up @@ -141580,7 +141580,16 @@
"description": "The outcome of the job.",
"example": "success",
"type": "string",
"nullable": true
"nullable": true,
"enum": [
"success",
"failure",
"neutral",
"cancelled",
"skipped",
"timed_out",
"action_required"
]
},
"started_at": {
"description": "The time that the job started, in ISO 8601 format.",
Expand Down Expand Up @@ -161315,7 +161324,16 @@
"description": "The outcome of the job.",
"example": "success",
"type": "string",
"nullable": true
"nullable": true,
"enum": [
"success",
"failure",
"neutral",
"cancelled",
"skipped",
"timed_out",
"action_required"
]
},
"started_at": {
"description": "The time that the job started, in ISO 8601 format.",
Expand Down Expand Up @@ -161928,7 +161946,16 @@
"description": "The outcome of the job.",
"example": "success",
"type": "string",
"nullable": true
"nullable": true,
"enum": [
"success",
"failure",
"neutral",
"cancelled",
"skipped",
"timed_out",
"action_required"
]
},
"started_at": {
"description": "The time that the job started, in ISO 8601 format.",
Expand Down Expand Up @@ -252395,7 +252422,7 @@
},
{
"name": "sort",
"description": "The sort order. Can be either `newest`, `oldest`, or `stargazers`.",
"description": "The sort order. `stargazers` will sort by star count.",
"in": "query",
"required": false,
"schema": {
Expand Down Expand Up @@ -273229,7 +273256,7 @@
},
{
"name": "state",
"description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.",
"description": "Indicates the state of the issues to return.",
"in": "query",
"required": false,
"schema": {
Expand Down Expand Up @@ -273280,7 +273307,7 @@
},
{
"name": "sort",
"description": "What to sort results by. Can be either `created`, `updated`, `comments`.",
"description": "What to sort results by.",
"in": "query",
"required": false,
"schema": {
Expand Down Expand Up @@ -333999,7 +334026,7 @@
},
{
"name": "state",
"description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.",
"description": "Indicates the state of the projects to return.",
"in": "query",
"required": false,
"schema": {
Expand Down Expand Up @@ -334977,7 +335004,7 @@
},
{
"name": "sort",
"description": "What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month).",
"description": "What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month.",
"in": "query",
"required": false,
"schema": {
Expand All @@ -334993,7 +335020,7 @@
},
{
"name": "direction",
"description": "The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.",
"description": "The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.",
"in": "query",
"required": false,
"schema": {
Expand Down Expand Up @@ -343141,7 +343168,7 @@
},
{
"name": "direction",
"description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.",
"description": "The direction to sort results. Ignored without `sort` parameter.",
"in": "query",
"required": false,
"schema": {
Expand Down Expand Up @@ -357665,7 +357692,7 @@
},
{
"name": "direction",
"description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.",
"description": "The direction to sort results. Ignored without `sort` parameter.",
"in": "query",
"required": false,
"schema": {
Expand Down Expand Up @@ -381395,7 +381422,7 @@
"description": "The REST API URL of the code locations for this alert."
},
"state": {
"description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.",
"description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.",
"type": "string",
"enum": [
"open",
Expand Down Expand Up @@ -381886,7 +381913,7 @@
"description": "The REST API URL of the code locations for this alert."
},
"state": {
"description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.",
"description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.",
"type": "string",
"enum": [
"open",
Expand Down Expand Up @@ -382285,7 +382312,7 @@
"type": "object",
"properties": {
"state": {
"description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.",
"description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.",
"type": "string",
"enum": [
"open",
Expand Down Expand Up @@ -382363,7 +382390,7 @@
"description": "The REST API URL of the code locations for this alert."
},
"state": {
"description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.",
"description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.",
"type": "string",
"enum": [
"open",
Expand Down Expand Up @@ -451534,7 +451561,7 @@
},
{
"name": "state",
"description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.",
"description": "Indicates the state of the issues to return.",
"in": "query",
"required": false,
"schema": {
Expand All @@ -451558,7 +451585,7 @@
},
{
"name": "sort",
"description": "What to sort results by. Can be either `created`, `updated`, `comments`.",
"description": "What to sort results by.",
"in": "query",
"required": false,
"schema": {
Expand Down Expand Up @@ -455738,7 +455765,7 @@
"parameters": [
{
"name": "state",
"description": "Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships.",
"description": "Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships.",
"in": "query",
"required": false,
"schema": {
Expand Down Expand Up @@ -501389,7 +501416,7 @@
},
{
"name": "state",
"description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.",
"description": "Indicates the state of the projects to return.",
"in": "query",
"required": false,
"schema": {
Expand Down
Loading

0 comments on commit cb05d6e

Please sign in to comment.