diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json index d6637ff38..9b377417a 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions/api.github.com/api.github.com.2022-11-28.json @@ -25232,58 +25232,49 @@ ], "requestBody": { "required": true, - "description": "Details of the item to add to the project. You can specify either the database ID or the repository owner, name, and issue/PR number.", + "description": "Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number.", "content": { "application/json": { "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "enum": [ + "Issue", + "PullRequest" + ], + "description": "The type of item to add to the project. Must be either Issue or PullRequest." + }, + "id": { + "type": "integer", + "description": "The unique identifier of the issue or pull request to add to the project." + }, + "owner": { + "type": "string", + "description": "The repository owner login." + }, + "repo": { + "type": "string", + "description": "The repository name." + }, + "number": { + "type": "integer", + "description": "The issue or pull request number." + } + }, + "required": [ + "type" + ], "oneOf": [ { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "id": { - "type": "integer", - "description": "The unique ID of the issue or pull request to add to the project." - } - }, "required": [ - "type", "id" ] }, { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "owner": { - "type": "string", - "description": "The repository owner login." - }, - "repo": { - "type": "string", - "description": "The repository name." - }, - "number": { - "type": "integer", - "description": "The issue or pull request number." - } - }, "required": [ - "type", "owner", "repo", "number" @@ -25292,22 +25283,22 @@ ] }, "examples": { - "issue-with-id": { - "summary": "Add issue by database ID", + "issue_with_id": { + "summary": "Add an issue using its unique ID", "value": { "type": "Issue", "id": 3 } }, - "pull_request-with-id": { - "summary": "Add pull request by database ID", + "pull_request_with_id": { + "summary": "Add a pull request using its unique ID", "value": { "type": "PullRequest", "id": 3 } }, - "issue-with-nwo": { - "summary": "Add issue by repository and number", + "issue_with_nwo": { + "summary": "Add an issue using repository owner, name, and issue number", "value": { "type": "Issue", "owner": "octocat", @@ -25315,8 +25306,8 @@ "number": 42 } }, - "pull_request-with-nwo": { - "summary": "Add pull request by repository and number", + "pull_request_with_nwo": { + "summary": "Add a pull request using repository owner, name, and PR number", "value": { "type": "PullRequest", "owner": "octocat", @@ -25337,11 +25328,29 @@ "$ref": "#/components/schemas/projects-v2-item-simple" }, "examples": { - "issue": { - "$ref": "#/components/examples/projects-v2-item-simple" + "issue_with_id": { + "summary": "Response for adding an issue using its unique ID", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } }, - "pull_request": { - "$ref": "#/components/examples/projects-v2-item-simple" + "pull_request_with_id": { + "summary": "Response for adding a pull request using its unique ID", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } + }, + "issue_with_nwo": { + "summary": "Response for adding an issue using repository owner, name, and issue number", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } + }, + "pull_request_with_nwo": { + "summary": "Response for adding a pull request using repository owner, name, and PR number", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } } } } @@ -34869,20 +34878,8 @@ } ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/workflow-dispatch-response" - }, - "examples": { - "default": { - "$ref": "#/components/examples/workflow-dispatch-response" - } - } - } - } + "204": { + "description": "Response" } }, "requestBody": { @@ -74530,58 +74527,49 @@ ], "requestBody": { "required": true, - "description": "Details of the item to add to the project. You can specify either the database ID or the repository owner, name, and issue/PR number.", + "description": "Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number.", "content": { "application/json": { "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "enum": [ + "Issue", + "PullRequest" + ], + "description": "The type of item to add to the project. Must be either Issue or PullRequest." + }, + "id": { + "type": "integer", + "description": "The unique identifier of the issue or pull request to add to the project." + }, + "owner": { + "type": "string", + "description": "The repository owner login." + }, + "repo": { + "type": "string", + "description": "The repository name." + }, + "number": { + "type": "integer", + "description": "The issue or pull request number." + } + }, + "required": [ + "type" + ], "oneOf": [ { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "id": { - "type": "integer", - "description": "The unique ID of the issue or pull request to add to the project." - } - }, "required": [ - "type", "id" ] }, { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "owner": { - "type": "string", - "description": "The repository owner login." - }, - "repo": { - "type": "string", - "description": "The repository name." - }, - "number": { - "type": "integer", - "description": "The issue or pull request number." - } - }, "required": [ - "type", "owner", "repo", "number" @@ -74590,22 +74578,22 @@ ] }, "examples": { - "issue-with-id": { - "summary": "Add issue by database ID", + "issue_with_id": { + "summary": "Add an issue using its unique ID", "value": { "type": "Issue", "id": 3 } }, - "pull_request-with-id": { - "summary": "Add pull request by database ID", + "pull_request_with_id": { + "summary": "Add a pull request using its unique ID", "value": { "type": "PullRequest", "id": 3 } }, - "issue-with-nwo": { - "summary": "Add issue by repository and number", + "issue_with_nwo": { + "summary": "Add an issue using repository owner, name, and issue number", "value": { "type": "Issue", "owner": "octocat", @@ -74613,8 +74601,8 @@ "number": 42 } }, - "pull_request-with-nwo": { - "summary": "Add pull request by repository and number", + "pull_request_with_nwo": { + "summary": "Add a pull request using repository owner, name, and PR number", "value": { "type": "PullRequest", "owner": "octocat", @@ -74635,11 +74623,29 @@ "$ref": "#/components/schemas/projects-v2-item-simple" }, "examples": { - "issue": { - "$ref": "#/components/examples/projects-v2-item-simple" + "issue_with_id": { + "summary": "Response for adding an issue using its unique ID", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } }, - "pull_request": { - "$ref": "#/components/examples/projects-v2-item-simple" + "pull_request_with_id": { + "summary": "Response for adding a pull request using its unique ID", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } + }, + "issue_with_nwo": { + "summary": "Response for adding an issue using repository owner, name, and issue number", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } + }, + "pull_request_with_nwo": { + "summary": "Response for adding a pull request using repository owner, name, and PR number", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } } } } @@ -130769,7 +130775,7 @@ "type": "integer" }, "user": { - "$ref": "#/components/schemas/simple-user" + "$ref": "#/components/schemas/nullable-simple-user" }, "body": { "description": "The text of the comment.", diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml index 0a43113bf..0e7ed4b25 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml @@ -18290,70 +18290,62 @@ paths: requestBody: required: true description: Details of the item to add to the project. You can specify either - the database ID or the repository owner, name, and issue/PR number. + the unique ID or the repository owner, name, and issue/PR number. content: application/json: schema: + type: object + additionalProperties: false + properties: + type: + type: string + enum: + - Issue + - PullRequest + description: The type of item to add to the project. Must be either + Issue or PullRequest. + id: + type: integer + description: The unique identifier of the issue or pull request + to add to the project. + owner: + type: string + description: The repository owner login. + repo: + type: string + description: The repository name. + number: + type: integer + description: The issue or pull request number. + required: + - type oneOf: - - type: object - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - id: - type: integer - description: The unique ID of the issue or pull request to add - to the project. - required: - - type + - required: - id - - type: object - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - owner: - type: string - description: The repository owner login. - repo: - type: string - description: The repository name. - number: - type: integer - description: The issue or pull request number. - required: - - type + - required: - owner - repo - number examples: - issue-with-id: - summary: Add issue by database ID + issue_with_id: + summary: Add an issue using its unique ID value: type: Issue id: 3 - pull_request-with-id: - summary: Add pull request by database ID + pull_request_with_id: + summary: Add a pull request using its unique ID value: type: PullRequest id: 3 - issue-with-nwo: - summary: Add issue by repository and number + issue_with_nwo: + summary: Add an issue using repository owner, name, and issue number value: type: Issue owner: octocat repo: hello-world number: 42 - pull_request-with-nwo: - summary: Add pull request by repository and number + pull_request_with_nwo: + summary: Add a pull request using repository owner, name, and PR number value: type: PullRequest owner: octocat @@ -18367,10 +18359,24 @@ paths: schema: "$ref": "#/components/schemas/projects-v2-item-simple" examples: - issue: - "$ref": "#/components/examples/projects-v2-item-simple" - pull_request: - "$ref": "#/components/examples/projects-v2-item-simple" + issue_with_id: + summary: Response for adding an issue using its unique ID + value: + "$ref": "#/components/examples/projects-v2-item-simple" + pull_request_with_id: + summary: Response for adding a pull request using its unique ID + value: + "$ref": "#/components/examples/projects-v2-item-simple" + issue_with_nwo: + summary: Response for adding an issue using repository owner, name, + and issue number + value: + "$ref": "#/components/examples/projects-v2-item-simple" + pull_request_with_nwo: + summary: Response for adding a pull request using repository owner, + name, and PR number + value: + "$ref": "#/components/examples/projects-v2-item-simple" '304': "$ref": "#/components/responses/not_modified" '403': @@ -25255,15 +25261,8 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/workflow-id" responses: - '200': + '204': description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/workflow-dispatch-response" - examples: - default: - "$ref": "#/components/examples/workflow-dispatch-response" requestBody: required: true content: @@ -54016,70 +54015,62 @@ paths: requestBody: required: true description: Details of the item to add to the project. You can specify either - the database ID or the repository owner, name, and issue/PR number. + the unique ID or the repository owner, name, and issue/PR number. content: application/json: schema: + type: object + additionalProperties: false + properties: + type: + type: string + enum: + - Issue + - PullRequest + description: The type of item to add to the project. Must be either + Issue or PullRequest. + id: + type: integer + description: The unique identifier of the issue or pull request + to add to the project. + owner: + type: string + description: The repository owner login. + repo: + type: string + description: The repository name. + number: + type: integer + description: The issue or pull request number. + required: + - type oneOf: - - type: object - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - id: - type: integer - description: The unique ID of the issue or pull request to add - to the project. - required: - - type + - required: - id - - type: object - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - owner: - type: string - description: The repository owner login. - repo: - type: string - description: The repository name. - number: - type: integer - description: The issue or pull request number. - required: - - type + - required: - owner - repo - number examples: - issue-with-id: - summary: Add issue by database ID + issue_with_id: + summary: Add an issue using its unique ID value: type: Issue id: 3 - pull_request-with-id: - summary: Add pull request by database ID + pull_request_with_id: + summary: Add a pull request using its unique ID value: type: PullRequest id: 3 - issue-with-nwo: - summary: Add issue by repository and number + issue_with_nwo: + summary: Add an issue using repository owner, name, and issue number value: type: Issue owner: octocat repo: hello-world number: 42 - pull_request-with-nwo: - summary: Add pull request by repository and number + pull_request_with_nwo: + summary: Add a pull request using repository owner, name, and PR number value: type: PullRequest owner: octocat @@ -54093,10 +54084,24 @@ paths: schema: "$ref": "#/components/schemas/projects-v2-item-simple" examples: - issue: - "$ref": "#/components/examples/projects-v2-item-simple" - pull_request: - "$ref": "#/components/examples/projects-v2-item-simple" + issue_with_id: + summary: Response for adding an issue using its unique ID + value: + "$ref": "#/components/examples/projects-v2-item-simple" + pull_request_with_id: + summary: Response for adding a pull request using its unique ID + value: + "$ref": "#/components/examples/projects-v2-item-simple" + issue_with_nwo: + summary: Response for adding an issue using repository owner, name, + and issue number + value: + "$ref": "#/components/examples/projects-v2-item-simple" + pull_request_with_nwo: + summary: Response for adding a pull request using repository owner, + name, and PR number + value: + "$ref": "#/components/examples/projects-v2-item-simple" '304': "$ref": "#/components/responses/not_modified" '403': @@ -96367,7 +96372,7 @@ components: example: 8 type: integer user: - "$ref": "#/components/schemas/simple-user" + "$ref": "#/components/schemas/nullable-simple-user" body: description: The text of the comment. example: We should probably include a check for null values here. diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index d6637ff38..9b377417a 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -25232,58 +25232,49 @@ ], "requestBody": { "required": true, - "description": "Details of the item to add to the project. You can specify either the database ID or the repository owner, name, and issue/PR number.", + "description": "Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number.", "content": { "application/json": { "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "enum": [ + "Issue", + "PullRequest" + ], + "description": "The type of item to add to the project. Must be either Issue or PullRequest." + }, + "id": { + "type": "integer", + "description": "The unique identifier of the issue or pull request to add to the project." + }, + "owner": { + "type": "string", + "description": "The repository owner login." + }, + "repo": { + "type": "string", + "description": "The repository name." + }, + "number": { + "type": "integer", + "description": "The issue or pull request number." + } + }, + "required": [ + "type" + ], "oneOf": [ { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "id": { - "type": "integer", - "description": "The unique ID of the issue or pull request to add to the project." - } - }, "required": [ - "type", "id" ] }, { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "owner": { - "type": "string", - "description": "The repository owner login." - }, - "repo": { - "type": "string", - "description": "The repository name." - }, - "number": { - "type": "integer", - "description": "The issue or pull request number." - } - }, "required": [ - "type", "owner", "repo", "number" @@ -25292,22 +25283,22 @@ ] }, "examples": { - "issue-with-id": { - "summary": "Add issue by database ID", + "issue_with_id": { + "summary": "Add an issue using its unique ID", "value": { "type": "Issue", "id": 3 } }, - "pull_request-with-id": { - "summary": "Add pull request by database ID", + "pull_request_with_id": { + "summary": "Add a pull request using its unique ID", "value": { "type": "PullRequest", "id": 3 } }, - "issue-with-nwo": { - "summary": "Add issue by repository and number", + "issue_with_nwo": { + "summary": "Add an issue using repository owner, name, and issue number", "value": { "type": "Issue", "owner": "octocat", @@ -25315,8 +25306,8 @@ "number": 42 } }, - "pull_request-with-nwo": { - "summary": "Add pull request by repository and number", + "pull_request_with_nwo": { + "summary": "Add a pull request using repository owner, name, and PR number", "value": { "type": "PullRequest", "owner": "octocat", @@ -25337,11 +25328,29 @@ "$ref": "#/components/schemas/projects-v2-item-simple" }, "examples": { - "issue": { - "$ref": "#/components/examples/projects-v2-item-simple" + "issue_with_id": { + "summary": "Response for adding an issue using its unique ID", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } }, - "pull_request": { - "$ref": "#/components/examples/projects-v2-item-simple" + "pull_request_with_id": { + "summary": "Response for adding a pull request using its unique ID", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } + }, + "issue_with_nwo": { + "summary": "Response for adding an issue using repository owner, name, and issue number", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } + }, + "pull_request_with_nwo": { + "summary": "Response for adding a pull request using repository owner, name, and PR number", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } } } } @@ -34869,20 +34878,8 @@ } ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/workflow-dispatch-response" - }, - "examples": { - "default": { - "$ref": "#/components/examples/workflow-dispatch-response" - } - } - } - } + "204": { + "description": "Response" } }, "requestBody": { @@ -74530,58 +74527,49 @@ ], "requestBody": { "required": true, - "description": "Details of the item to add to the project. You can specify either the database ID or the repository owner, name, and issue/PR number.", + "description": "Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number.", "content": { "application/json": { "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "enum": [ + "Issue", + "PullRequest" + ], + "description": "The type of item to add to the project. Must be either Issue or PullRequest." + }, + "id": { + "type": "integer", + "description": "The unique identifier of the issue or pull request to add to the project." + }, + "owner": { + "type": "string", + "description": "The repository owner login." + }, + "repo": { + "type": "string", + "description": "The repository name." + }, + "number": { + "type": "integer", + "description": "The issue or pull request number." + } + }, + "required": [ + "type" + ], "oneOf": [ { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "id": { - "type": "integer", - "description": "The unique ID of the issue or pull request to add to the project." - } - }, "required": [ - "type", "id" ] }, { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "owner": { - "type": "string", - "description": "The repository owner login." - }, - "repo": { - "type": "string", - "description": "The repository name." - }, - "number": { - "type": "integer", - "description": "The issue or pull request number." - } - }, "required": [ - "type", "owner", "repo", "number" @@ -74590,22 +74578,22 @@ ] }, "examples": { - "issue-with-id": { - "summary": "Add issue by database ID", + "issue_with_id": { + "summary": "Add an issue using its unique ID", "value": { "type": "Issue", "id": 3 } }, - "pull_request-with-id": { - "summary": "Add pull request by database ID", + "pull_request_with_id": { + "summary": "Add a pull request using its unique ID", "value": { "type": "PullRequest", "id": 3 } }, - "issue-with-nwo": { - "summary": "Add issue by repository and number", + "issue_with_nwo": { + "summary": "Add an issue using repository owner, name, and issue number", "value": { "type": "Issue", "owner": "octocat", @@ -74613,8 +74601,8 @@ "number": 42 } }, - "pull_request-with-nwo": { - "summary": "Add pull request by repository and number", + "pull_request_with_nwo": { + "summary": "Add a pull request using repository owner, name, and PR number", "value": { "type": "PullRequest", "owner": "octocat", @@ -74635,11 +74623,29 @@ "$ref": "#/components/schemas/projects-v2-item-simple" }, "examples": { - "issue": { - "$ref": "#/components/examples/projects-v2-item-simple" + "issue_with_id": { + "summary": "Response for adding an issue using its unique ID", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } }, - "pull_request": { - "$ref": "#/components/examples/projects-v2-item-simple" + "pull_request_with_id": { + "summary": "Response for adding a pull request using its unique ID", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } + }, + "issue_with_nwo": { + "summary": "Response for adding an issue using repository owner, name, and issue number", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } + }, + "pull_request_with_nwo": { + "summary": "Response for adding a pull request using repository owner, name, and PR number", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } } } } @@ -130769,7 +130775,7 @@ "type": "integer" }, "user": { - "$ref": "#/components/schemas/simple-user" + "$ref": "#/components/schemas/nullable-simple-user" }, "body": { "description": "The text of the comment.", diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index 0a43113bf..0e7ed4b25 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -18290,70 +18290,62 @@ paths: requestBody: required: true description: Details of the item to add to the project. You can specify either - the database ID or the repository owner, name, and issue/PR number. + the unique ID or the repository owner, name, and issue/PR number. content: application/json: schema: + type: object + additionalProperties: false + properties: + type: + type: string + enum: + - Issue + - PullRequest + description: The type of item to add to the project. Must be either + Issue or PullRequest. + id: + type: integer + description: The unique identifier of the issue or pull request + to add to the project. + owner: + type: string + description: The repository owner login. + repo: + type: string + description: The repository name. + number: + type: integer + description: The issue or pull request number. + required: + - type oneOf: - - type: object - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - id: - type: integer - description: The unique ID of the issue or pull request to add - to the project. - required: - - type + - required: - id - - type: object - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - owner: - type: string - description: The repository owner login. - repo: - type: string - description: The repository name. - number: - type: integer - description: The issue or pull request number. - required: - - type + - required: - owner - repo - number examples: - issue-with-id: - summary: Add issue by database ID + issue_with_id: + summary: Add an issue using its unique ID value: type: Issue id: 3 - pull_request-with-id: - summary: Add pull request by database ID + pull_request_with_id: + summary: Add a pull request using its unique ID value: type: PullRequest id: 3 - issue-with-nwo: - summary: Add issue by repository and number + issue_with_nwo: + summary: Add an issue using repository owner, name, and issue number value: type: Issue owner: octocat repo: hello-world number: 42 - pull_request-with-nwo: - summary: Add pull request by repository and number + pull_request_with_nwo: + summary: Add a pull request using repository owner, name, and PR number value: type: PullRequest owner: octocat @@ -18367,10 +18359,24 @@ paths: schema: "$ref": "#/components/schemas/projects-v2-item-simple" examples: - issue: - "$ref": "#/components/examples/projects-v2-item-simple" - pull_request: - "$ref": "#/components/examples/projects-v2-item-simple" + issue_with_id: + summary: Response for adding an issue using its unique ID + value: + "$ref": "#/components/examples/projects-v2-item-simple" + pull_request_with_id: + summary: Response for adding a pull request using its unique ID + value: + "$ref": "#/components/examples/projects-v2-item-simple" + issue_with_nwo: + summary: Response for adding an issue using repository owner, name, + and issue number + value: + "$ref": "#/components/examples/projects-v2-item-simple" + pull_request_with_nwo: + summary: Response for adding a pull request using repository owner, + name, and PR number + value: + "$ref": "#/components/examples/projects-v2-item-simple" '304': "$ref": "#/components/responses/not_modified" '403': @@ -25255,15 +25261,8 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/workflow-id" responses: - '200': + '204': description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/workflow-dispatch-response" - examples: - default: - "$ref": "#/components/examples/workflow-dispatch-response" requestBody: required: true content: @@ -54016,70 +54015,62 @@ paths: requestBody: required: true description: Details of the item to add to the project. You can specify either - the database ID or the repository owner, name, and issue/PR number. + the unique ID or the repository owner, name, and issue/PR number. content: application/json: schema: + type: object + additionalProperties: false + properties: + type: + type: string + enum: + - Issue + - PullRequest + description: The type of item to add to the project. Must be either + Issue or PullRequest. + id: + type: integer + description: The unique identifier of the issue or pull request + to add to the project. + owner: + type: string + description: The repository owner login. + repo: + type: string + description: The repository name. + number: + type: integer + description: The issue or pull request number. + required: + - type oneOf: - - type: object - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - id: - type: integer - description: The unique ID of the issue or pull request to add - to the project. - required: - - type + - required: - id - - type: object - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - owner: - type: string - description: The repository owner login. - repo: - type: string - description: The repository name. - number: - type: integer - description: The issue or pull request number. - required: - - type + - required: - owner - repo - number examples: - issue-with-id: - summary: Add issue by database ID + issue_with_id: + summary: Add an issue using its unique ID value: type: Issue id: 3 - pull_request-with-id: - summary: Add pull request by database ID + pull_request_with_id: + summary: Add a pull request using its unique ID value: type: PullRequest id: 3 - issue-with-nwo: - summary: Add issue by repository and number + issue_with_nwo: + summary: Add an issue using repository owner, name, and issue number value: type: Issue owner: octocat repo: hello-world number: 42 - pull_request-with-nwo: - summary: Add pull request by repository and number + pull_request_with_nwo: + summary: Add a pull request using repository owner, name, and PR number value: type: PullRequest owner: octocat @@ -54093,10 +54084,24 @@ paths: schema: "$ref": "#/components/schemas/projects-v2-item-simple" examples: - issue: - "$ref": "#/components/examples/projects-v2-item-simple" - pull_request: - "$ref": "#/components/examples/projects-v2-item-simple" + issue_with_id: + summary: Response for adding an issue using its unique ID + value: + "$ref": "#/components/examples/projects-v2-item-simple" + pull_request_with_id: + summary: Response for adding a pull request using its unique ID + value: + "$ref": "#/components/examples/projects-v2-item-simple" + issue_with_nwo: + summary: Response for adding an issue using repository owner, name, + and issue number + value: + "$ref": "#/components/examples/projects-v2-item-simple" + pull_request_with_nwo: + summary: Response for adding a pull request using repository owner, + name, and PR number + value: + "$ref": "#/components/examples/projects-v2-item-simple" '304': "$ref": "#/components/responses/not_modified" '403': @@ -96367,7 +96372,7 @@ components: example: 8 type: integer user: - "$ref": "#/components/schemas/simple-user" + "$ref": "#/components/schemas/nullable-simple-user" body: description: The text of the comment. example: We should probably include a check for null values here. diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index b59a9a31e..957e9be8a 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -159730,58 +159730,49 @@ ], "requestBody": { "required": true, - "description": "Details of the item to add to the project. You can specify either the database ID or the repository owner, name, and issue/PR number.", + "description": "Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number.", "content": { "application/json": { "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "enum": [ + "Issue", + "PullRequest" + ], + "description": "The type of item to add to the project. Must be either Issue or PullRequest." + }, + "id": { + "type": "integer", + "description": "The unique identifier of the issue or pull request to add to the project." + }, + "owner": { + "type": "string", + "description": "The repository owner login." + }, + "repo": { + "type": "string", + "description": "The repository name." + }, + "number": { + "type": "integer", + "description": "The issue or pull request number." + } + }, + "required": [ + "type" + ], "oneOf": [ { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "id": { - "type": "integer", - "description": "The unique ID of the issue or pull request to add to the project." - } - }, "required": [ - "type", "id" ] }, { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "owner": { - "type": "string", - "description": "The repository owner login." - }, - "repo": { - "type": "string", - "description": "The repository name." - }, - "number": { - "type": "integer", - "description": "The issue or pull request number." - } - }, "required": [ - "type", "owner", "repo", "number" @@ -159790,22 +159781,22 @@ ] }, "examples": { - "issue-with-id": { - "summary": "Add issue by database ID", + "issue_with_id": { + "summary": "Add an issue using its unique ID", "value": { "type": "Issue", "id": 3 } }, - "pull_request-with-id": { - "summary": "Add pull request by database ID", + "pull_request_with_id": { + "summary": "Add a pull request using its unique ID", "value": { "type": "PullRequest", "id": 3 } }, - "issue-with-nwo": { - "summary": "Add issue by repository and number", + "issue_with_nwo": { + "summary": "Add an issue using repository owner, name, and issue number", "value": { "type": "Issue", "owner": "octocat", @@ -159813,8 +159804,8 @@ "number": 42 } }, - "pull_request-with-nwo": { - "summary": "Add pull request by repository and number", + "pull_request_with_nwo": { + "summary": "Add a pull request using repository owner, name, and PR number", "value": { "type": "PullRequest", "owner": "octocat", @@ -165612,18 +165603,105 @@ ] }, "examples": { - "issue": { + "issue_with_id": { + "summary": "Response for adding an issue using its unique ID", "value": { - "id": 17, - "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", - "content": { - "id": 38, - "node_id": "I_kwDOANN5s85FtLts", - "title": "Example Draft Issue", - "body": "This is a draft issue in the project.", + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, "created_at": "2022-04-28T12:00:00Z", "updated_at": "2022-04-28T12:00:00Z", - "user": { + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } + } + }, + "pull_request_with_id": { + "summary": "Response for adding a pull request using its unique ID", + "value": { + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -165642,48 +165720,114 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - } - }, - "content_type": "DraftIssue", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "archived_at": null, - "project_url": "https://api.github.com/users/octocat/projectsV2/1", - "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } } }, - "pull_request": { + "issue_with_nwo": { + "summary": "Response for adding an issue using repository owner, name, and issue number", "value": { - "id": 17, - "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", - "content": { - "id": 38, - "node_id": "I_kwDOANN5s85FtLts", - "title": "Example Draft Issue", - "body": "This is a draft issue in the project.", + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, "created_at": "2022-04-28T12:00:00Z", "updated_at": "2022-04-28T12:00:00Z", - "user": { + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } + } + }, + "pull_request_with_nwo": { + "summary": "Response for adding a pull request using repository owner, name, and PR number", + "value": { + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -165702,34 +165846,13 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - } - }, - "content_type": "DraftIssue", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "archived_at": null, - "project_url": "https://api.github.com/users/octocat/projectsV2/1", - "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } } } } @@ -232527,48 +232650,8 @@ } ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Workflow Dispatch Response", - "description": "Response containing the workflow run ID and URLs.", - "type": "object", - "properties": { - "workflow_run_id": { - "title": "Workflow Run ID", - "description": "The ID of the workflow run.", - "type": "integer", - "format": "int64" - }, - "run_url": { - "type": "string", - "format": "uri", - "description": "The URL to the workflow run." - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "workflow_run_id", - "run_url", - "html_url" - ] - }, - "examples": { - "default": { - "value": { - "workflow_run_id": 1, - "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1", - "html_url": "https://github.com/octo-org/octo-repo/actions/runs/1" - } - } - } - } - } + "204": { + "description": "Response" } }, "requestBody": { @@ -423069,7 +423152,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -442815,7 +442899,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -443350,7 +443435,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -443924,7 +444010,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -456492,7 +456579,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -457113,7 +457201,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -457776,7 +457865,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -632008,58 +632098,49 @@ ], "requestBody": { "required": true, - "description": "Details of the item to add to the project. You can specify either the database ID or the repository owner, name, and issue/PR number.", + "description": "Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number.", "content": { "application/json": { "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "enum": [ + "Issue", + "PullRequest" + ], + "description": "The type of item to add to the project. Must be either Issue or PullRequest." + }, + "id": { + "type": "integer", + "description": "The unique identifier of the issue or pull request to add to the project." + }, + "owner": { + "type": "string", + "description": "The repository owner login." + }, + "repo": { + "type": "string", + "description": "The repository name." + }, + "number": { + "type": "integer", + "description": "The issue or pull request number." + } + }, + "required": [ + "type" + ], "oneOf": [ { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "id": { - "type": "integer", - "description": "The unique ID of the issue or pull request to add to the project." - } - }, "required": [ - "type", "id" ] }, { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "owner": { - "type": "string", - "description": "The repository owner login." - }, - "repo": { - "type": "string", - "description": "The repository name." - }, - "number": { - "type": "integer", - "description": "The issue or pull request number." - } - }, "required": [ - "type", "owner", "repo", "number" @@ -632068,22 +632149,22 @@ ] }, "examples": { - "issue-with-id": { - "summary": "Add issue by database ID", + "issue_with_id": { + "summary": "Add an issue using its unique ID", "value": { "type": "Issue", "id": 3 } }, - "pull_request-with-id": { - "summary": "Add pull request by database ID", + "pull_request_with_id": { + "summary": "Add a pull request using its unique ID", "value": { "type": "PullRequest", "id": 3 } }, - "issue-with-nwo": { - "summary": "Add issue by repository and number", + "issue_with_nwo": { + "summary": "Add an issue using repository owner, name, and issue number", "value": { "type": "Issue", "owner": "octocat", @@ -632091,8 +632172,8 @@ "number": 42 } }, - "pull_request-with-nwo": { - "summary": "Add pull request by repository and number", + "pull_request_with_nwo": { + "summary": "Add a pull request using repository owner, name, and PR number", "value": { "type": "PullRequest", "owner": "octocat", @@ -637890,18 +637971,105 @@ ] }, "examples": { - "issue": { + "issue_with_id": { + "summary": "Response for adding an issue using its unique ID", "value": { - "id": 17, - "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", - "content": { - "id": 38, - "node_id": "I_kwDOANN5s85FtLts", - "title": "Example Draft Issue", - "body": "This is a draft issue in the project.", + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, "created_at": "2022-04-28T12:00:00Z", "updated_at": "2022-04-28T12:00:00Z", - "user": { + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } + } + }, + "pull_request_with_id": { + "summary": "Response for adding a pull request using its unique ID", + "value": { + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -637920,48 +638088,114 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - } - }, - "content_type": "DraftIssue", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "archived_at": null, - "project_url": "https://api.github.com/users/octocat/projectsV2/1", - "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } } }, - "pull_request": { + "issue_with_nwo": { + "summary": "Response for adding an issue using repository owner, name, and issue number", "value": { - "id": 17, - "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", - "content": { - "id": 38, - "node_id": "I_kwDOANN5s85FtLts", - "title": "Example Draft Issue", - "body": "This is a draft issue in the project.", + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, "created_at": "2022-04-28T12:00:00Z", "updated_at": "2022-04-28T12:00:00Z", - "user": { + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } + } + }, + "pull_request_with_nwo": { + "summary": "Response for adding a pull request using repository owner, name, and PR number", + "value": { + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -637980,34 +638214,13 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - } - }, - "content_type": "DraftIssue", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "archived_at": null, - "project_url": "https://api.github.com/users/octocat/projectsV2/1", - "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } } } } diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 2a74a3f1c..5e251be8e 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -39742,70 +39742,62 @@ paths: requestBody: required: true description: Details of the item to add to the project. You can specify either - the database ID or the repository owner, name, and issue/PR number. + the unique ID or the repository owner, name, and issue/PR number. content: application/json: schema: + type: object + additionalProperties: false + properties: + type: + type: string + enum: + - Issue + - PullRequest + description: The type of item to add to the project. Must be either + Issue or PullRequest. + id: + type: integer + description: The unique identifier of the issue or pull request + to add to the project. + owner: + type: string + description: The repository owner login. + repo: + type: string + description: The repository name. + number: + type: integer + description: The issue or pull request number. + required: + - type oneOf: - - type: object - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - id: - type: integer - description: The unique ID of the issue or pull request to add - to the project. - required: - - type + - required: - id - - type: object - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - owner: - type: string - description: The repository owner login. - repo: - type: string - description: The repository name. - number: - type: integer - description: The issue or pull request number. - required: - - type + - required: - owner - repo - number examples: - issue-with-id: - summary: Add issue by database ID + issue_with_id: + summary: Add an issue using its unique ID value: type: Issue id: 3 - pull_request-with-id: - summary: Add pull request by database ID + pull_request_with_id: + summary: Add a pull request using its unique ID value: type: PullRequest id: 3 - issue-with-nwo: - summary: Add issue by repository and number + issue_with_nwo: + summary: Add an issue using repository owner, name, and issue number value: type: Issue owner: octocat repo: hello-world number: 42 - pull_request-with-nwo: - summary: Add pull request by repository and number + pull_request_with_nwo: + summary: Add a pull request using repository owner, name, and PR number value: type: PullRequest owner: octocat @@ -39818,8 +39810,20 @@ paths: application/json: schema: *269 examples: - issue: *270 - pull_request: *270 + issue_with_id: + summary: Response for adding an issue using its unique ID + value: *270 + pull_request_with_id: + summary: Response for adding a pull request using its unique ID + value: *270 + issue_with_nwo: + summary: Response for adding an issue using repository owner, name, + and issue number + value: *270 + pull_request_with_nwo: + summary: Response for adding a pull request using repository owner, + name, and PR number + value: *270 '304': *37 '403': *29 '401': *25 @@ -54484,37 +54488,8 @@ paths: - *328 - *379 responses: - '200': + '204': description: Response - content: - application/json: - schema: - title: Workflow Dispatch Response - description: Response containing the workflow run ID and URLs. - type: object - properties: - workflow_run_id: - title: Workflow Run ID - description: The ID of the workflow run. - type: integer - format: int64 - run_url: - type: string - format: uri - description: The URL to the workflow run. - html_url: - type: string - format: uri - required: - - workflow_run_id - - run_url - - html_url - examples: - default: - value: - workflow_run_id: 1 - run_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/1 - html_url: https://github.com/octo-org/octo-repo/actions/runs/1 requestBody: required: true content: @@ -80700,7 +80675,13 @@ paths: description: The comment ID to reply to. example: 8 type: integer - user: *4 + user: + title: Simple User + description: A GitHub user. + type: object + properties: *20 + required: *21 + nullable: true body: description: The text of the comment. example: We should probably include a check for null @@ -105410,70 +105391,62 @@ paths: requestBody: required: true description: Details of the item to add to the project. You can specify either - the database ID or the repository owner, name, and issue/PR number. + the unique ID or the repository owner, name, and issue/PR number. content: application/json: schema: + type: object + additionalProperties: false + properties: + type: + type: string + enum: + - Issue + - PullRequest + description: The type of item to add to the project. Must be either + Issue or PullRequest. + id: + type: integer + description: The unique identifier of the issue or pull request + to add to the project. + owner: + type: string + description: The repository owner login. + repo: + type: string + description: The repository name. + number: + type: integer + description: The issue or pull request number. + required: + - type oneOf: - - type: object - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - id: - type: integer - description: The unique ID of the issue or pull request to add - to the project. - required: - - type + - required: - id - - type: object - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - owner: - type: string - description: The repository owner login. - repo: - type: string - description: The repository name. - number: - type: integer - description: The issue or pull request number. - required: - - type + - required: - owner - repo - number examples: - issue-with-id: - summary: Add issue by database ID + issue_with_id: + summary: Add an issue using its unique ID value: type: Issue id: 3 - pull_request-with-id: - summary: Add pull request by database ID + pull_request_with_id: + summary: Add a pull request using its unique ID value: type: PullRequest id: 3 - issue-with-nwo: - summary: Add issue by repository and number + issue_with_nwo: + summary: Add an issue using repository owner, name, and issue number value: type: Issue owner: octocat repo: hello-world number: 42 - pull_request-with-nwo: - summary: Add pull request by repository and number + pull_request_with_nwo: + summary: Add a pull request using repository owner, name, and PR number value: type: PullRequest owner: octocat @@ -105486,8 +105459,20 @@ paths: application/json: schema: *269 examples: - issue: *270 - pull_request: *270 + issue_with_id: + summary: Response for adding an issue using its unique ID + value: *270 + pull_request_with_id: + summary: Response for adding a pull request using its unique ID + value: *270 + issue_with_nwo: + summary: Response for adding an issue using repository owner, name, + and issue number + value: *270 + pull_request_with_nwo: + summary: Response for adding a pull request using repository owner, + name, and PR number + value: *270 '304': *37 '403': *29 '401': *25 diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index b59a9a31e..957e9be8a 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -159730,58 +159730,49 @@ ], "requestBody": { "required": true, - "description": "Details of the item to add to the project. You can specify either the database ID or the repository owner, name, and issue/PR number.", + "description": "Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number.", "content": { "application/json": { "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "enum": [ + "Issue", + "PullRequest" + ], + "description": "The type of item to add to the project. Must be either Issue or PullRequest." + }, + "id": { + "type": "integer", + "description": "The unique identifier of the issue or pull request to add to the project." + }, + "owner": { + "type": "string", + "description": "The repository owner login." + }, + "repo": { + "type": "string", + "description": "The repository name." + }, + "number": { + "type": "integer", + "description": "The issue or pull request number." + } + }, + "required": [ + "type" + ], "oneOf": [ { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "id": { - "type": "integer", - "description": "The unique ID of the issue or pull request to add to the project." - } - }, "required": [ - "type", "id" ] }, { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "owner": { - "type": "string", - "description": "The repository owner login." - }, - "repo": { - "type": "string", - "description": "The repository name." - }, - "number": { - "type": "integer", - "description": "The issue or pull request number." - } - }, "required": [ - "type", "owner", "repo", "number" @@ -159790,22 +159781,22 @@ ] }, "examples": { - "issue-with-id": { - "summary": "Add issue by database ID", + "issue_with_id": { + "summary": "Add an issue using its unique ID", "value": { "type": "Issue", "id": 3 } }, - "pull_request-with-id": { - "summary": "Add pull request by database ID", + "pull_request_with_id": { + "summary": "Add a pull request using its unique ID", "value": { "type": "PullRequest", "id": 3 } }, - "issue-with-nwo": { - "summary": "Add issue by repository and number", + "issue_with_nwo": { + "summary": "Add an issue using repository owner, name, and issue number", "value": { "type": "Issue", "owner": "octocat", @@ -159813,8 +159804,8 @@ "number": 42 } }, - "pull_request-with-nwo": { - "summary": "Add pull request by repository and number", + "pull_request_with_nwo": { + "summary": "Add a pull request using repository owner, name, and PR number", "value": { "type": "PullRequest", "owner": "octocat", @@ -165612,18 +165603,105 @@ ] }, "examples": { - "issue": { + "issue_with_id": { + "summary": "Response for adding an issue using its unique ID", "value": { - "id": 17, - "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", - "content": { - "id": 38, - "node_id": "I_kwDOANN5s85FtLts", - "title": "Example Draft Issue", - "body": "This is a draft issue in the project.", + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, "created_at": "2022-04-28T12:00:00Z", "updated_at": "2022-04-28T12:00:00Z", - "user": { + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } + } + }, + "pull_request_with_id": { + "summary": "Response for adding a pull request using its unique ID", + "value": { + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -165642,48 +165720,114 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - } - }, - "content_type": "DraftIssue", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "archived_at": null, - "project_url": "https://api.github.com/users/octocat/projectsV2/1", - "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } } }, - "pull_request": { + "issue_with_nwo": { + "summary": "Response for adding an issue using repository owner, name, and issue number", "value": { - "id": 17, - "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", - "content": { - "id": 38, - "node_id": "I_kwDOANN5s85FtLts", - "title": "Example Draft Issue", - "body": "This is a draft issue in the project.", + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, "created_at": "2022-04-28T12:00:00Z", "updated_at": "2022-04-28T12:00:00Z", - "user": { + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } + } + }, + "pull_request_with_nwo": { + "summary": "Response for adding a pull request using repository owner, name, and PR number", + "value": { + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -165702,34 +165846,13 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - } - }, - "content_type": "DraftIssue", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "archived_at": null, - "project_url": "https://api.github.com/users/octocat/projectsV2/1", - "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } } } } @@ -232527,48 +232650,8 @@ } ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Workflow Dispatch Response", - "description": "Response containing the workflow run ID and URLs.", - "type": "object", - "properties": { - "workflow_run_id": { - "title": "Workflow Run ID", - "description": "The ID of the workflow run.", - "type": "integer", - "format": "int64" - }, - "run_url": { - "type": "string", - "format": "uri", - "description": "The URL to the workflow run." - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "workflow_run_id", - "run_url", - "html_url" - ] - }, - "examples": { - "default": { - "value": { - "workflow_run_id": 1, - "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1", - "html_url": "https://github.com/octo-org/octo-repo/actions/runs/1" - } - } - } - } - } + "204": { + "description": "Response" } }, "requestBody": { @@ -423069,7 +423152,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -442815,7 +442899,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -443350,7 +443435,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -443924,7 +444010,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -456492,7 +456579,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -457113,7 +457201,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -457776,7 +457865,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -632008,58 +632098,49 @@ ], "requestBody": { "required": true, - "description": "Details of the item to add to the project. You can specify either the database ID or the repository owner, name, and issue/PR number.", + "description": "Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number.", "content": { "application/json": { "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "enum": [ + "Issue", + "PullRequest" + ], + "description": "The type of item to add to the project. Must be either Issue or PullRequest." + }, + "id": { + "type": "integer", + "description": "The unique identifier of the issue or pull request to add to the project." + }, + "owner": { + "type": "string", + "description": "The repository owner login." + }, + "repo": { + "type": "string", + "description": "The repository name." + }, + "number": { + "type": "integer", + "description": "The issue or pull request number." + } + }, + "required": [ + "type" + ], "oneOf": [ { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "id": { - "type": "integer", - "description": "The unique ID of the issue or pull request to add to the project." - } - }, "required": [ - "type", "id" ] }, { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "owner": { - "type": "string", - "description": "The repository owner login." - }, - "repo": { - "type": "string", - "description": "The repository name." - }, - "number": { - "type": "integer", - "description": "The issue or pull request number." - } - }, "required": [ - "type", "owner", "repo", "number" @@ -632068,22 +632149,22 @@ ] }, "examples": { - "issue-with-id": { - "summary": "Add issue by database ID", + "issue_with_id": { + "summary": "Add an issue using its unique ID", "value": { "type": "Issue", "id": 3 } }, - "pull_request-with-id": { - "summary": "Add pull request by database ID", + "pull_request_with_id": { + "summary": "Add a pull request using its unique ID", "value": { "type": "PullRequest", "id": 3 } }, - "issue-with-nwo": { - "summary": "Add issue by repository and number", + "issue_with_nwo": { + "summary": "Add an issue using repository owner, name, and issue number", "value": { "type": "Issue", "owner": "octocat", @@ -632091,8 +632172,8 @@ "number": 42 } }, - "pull_request-with-nwo": { - "summary": "Add pull request by repository and number", + "pull_request_with_nwo": { + "summary": "Add a pull request using repository owner, name, and PR number", "value": { "type": "PullRequest", "owner": "octocat", @@ -637890,18 +637971,105 @@ ] }, "examples": { - "issue": { + "issue_with_id": { + "summary": "Response for adding an issue using its unique ID", "value": { - "id": 17, - "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", - "content": { - "id": 38, - "node_id": "I_kwDOANN5s85FtLts", - "title": "Example Draft Issue", - "body": "This is a draft issue in the project.", + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, "created_at": "2022-04-28T12:00:00Z", "updated_at": "2022-04-28T12:00:00Z", - "user": { + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } + } + }, + "pull_request_with_id": { + "summary": "Response for adding a pull request using its unique ID", + "value": { + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -637920,48 +638088,114 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - } - }, - "content_type": "DraftIssue", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "archived_at": null, - "project_url": "https://api.github.com/users/octocat/projectsV2/1", - "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } } }, - "pull_request": { + "issue_with_nwo": { + "summary": "Response for adding an issue using repository owner, name, and issue number", "value": { - "id": 17, - "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", - "content": { - "id": 38, - "node_id": "I_kwDOANN5s85FtLts", - "title": "Example Draft Issue", - "body": "This is a draft issue in the project.", + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, "created_at": "2022-04-28T12:00:00Z", "updated_at": "2022-04-28T12:00:00Z", - "user": { + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } + } + }, + "pull_request_with_nwo": { + "summary": "Response for adding a pull request using repository owner, name, and PR number", + "value": { + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -637980,34 +638214,13 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - } - }, - "content_type": "DraftIssue", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "archived_at": null, - "project_url": "https://api.github.com/users/octocat/projectsV2/1", - "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } } } } diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index 2a74a3f1c..5e251be8e 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -39742,70 +39742,62 @@ paths: requestBody: required: true description: Details of the item to add to the project. You can specify either - the database ID or the repository owner, name, and issue/PR number. + the unique ID or the repository owner, name, and issue/PR number. content: application/json: schema: + type: object + additionalProperties: false + properties: + type: + type: string + enum: + - Issue + - PullRequest + description: The type of item to add to the project. Must be either + Issue or PullRequest. + id: + type: integer + description: The unique identifier of the issue or pull request + to add to the project. + owner: + type: string + description: The repository owner login. + repo: + type: string + description: The repository name. + number: + type: integer + description: The issue or pull request number. + required: + - type oneOf: - - type: object - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - id: - type: integer - description: The unique ID of the issue or pull request to add - to the project. - required: - - type + - required: - id - - type: object - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - owner: - type: string - description: The repository owner login. - repo: - type: string - description: The repository name. - number: - type: integer - description: The issue or pull request number. - required: - - type + - required: - owner - repo - number examples: - issue-with-id: - summary: Add issue by database ID + issue_with_id: + summary: Add an issue using its unique ID value: type: Issue id: 3 - pull_request-with-id: - summary: Add pull request by database ID + pull_request_with_id: + summary: Add a pull request using its unique ID value: type: PullRequest id: 3 - issue-with-nwo: - summary: Add issue by repository and number + issue_with_nwo: + summary: Add an issue using repository owner, name, and issue number value: type: Issue owner: octocat repo: hello-world number: 42 - pull_request-with-nwo: - summary: Add pull request by repository and number + pull_request_with_nwo: + summary: Add a pull request using repository owner, name, and PR number value: type: PullRequest owner: octocat @@ -39818,8 +39810,20 @@ paths: application/json: schema: *269 examples: - issue: *270 - pull_request: *270 + issue_with_id: + summary: Response for adding an issue using its unique ID + value: *270 + pull_request_with_id: + summary: Response for adding a pull request using its unique ID + value: *270 + issue_with_nwo: + summary: Response for adding an issue using repository owner, name, + and issue number + value: *270 + pull_request_with_nwo: + summary: Response for adding a pull request using repository owner, + name, and PR number + value: *270 '304': *37 '403': *29 '401': *25 @@ -54484,37 +54488,8 @@ paths: - *328 - *379 responses: - '200': + '204': description: Response - content: - application/json: - schema: - title: Workflow Dispatch Response - description: Response containing the workflow run ID and URLs. - type: object - properties: - workflow_run_id: - title: Workflow Run ID - description: The ID of the workflow run. - type: integer - format: int64 - run_url: - type: string - format: uri - description: The URL to the workflow run. - html_url: - type: string - format: uri - required: - - workflow_run_id - - run_url - - html_url - examples: - default: - value: - workflow_run_id: 1 - run_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/1 - html_url: https://github.com/octo-org/octo-repo/actions/runs/1 requestBody: required: true content: @@ -80700,7 +80675,13 @@ paths: description: The comment ID to reply to. example: 8 type: integer - user: *4 + user: + title: Simple User + description: A GitHub user. + type: object + properties: *20 + required: *21 + nullable: true body: description: The text of the comment. example: We should probably include a check for null @@ -105410,70 +105391,62 @@ paths: requestBody: required: true description: Details of the item to add to the project. You can specify either - the database ID or the repository owner, name, and issue/PR number. + the unique ID or the repository owner, name, and issue/PR number. content: application/json: schema: + type: object + additionalProperties: false + properties: + type: + type: string + enum: + - Issue + - PullRequest + description: The type of item to add to the project. Must be either + Issue or PullRequest. + id: + type: integer + description: The unique identifier of the issue or pull request + to add to the project. + owner: + type: string + description: The repository owner login. + repo: + type: string + description: The repository name. + number: + type: integer + description: The issue or pull request number. + required: + - type oneOf: - - type: object - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - id: - type: integer - description: The unique ID of the issue or pull request to add - to the project. - required: - - type + - required: - id - - type: object - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - owner: - type: string - description: The repository owner login. - repo: - type: string - description: The repository name. - number: - type: integer - description: The issue or pull request number. - required: - - type + - required: - owner - repo - number examples: - issue-with-id: - summary: Add issue by database ID + issue_with_id: + summary: Add an issue using its unique ID value: type: Issue id: 3 - pull_request-with-id: - summary: Add pull request by database ID + pull_request_with_id: + summary: Add a pull request using its unique ID value: type: PullRequest id: 3 - issue-with-nwo: - summary: Add issue by repository and number + issue_with_nwo: + summary: Add an issue using repository owner, name, and issue number value: type: Issue owner: octocat repo: hello-world number: 42 - pull_request-with-nwo: - summary: Add pull request by repository and number + pull_request_with_nwo: + summary: Add a pull request using repository owner, name, and PR number value: type: PullRequest owner: octocat @@ -105486,8 +105459,20 @@ paths: application/json: schema: *269 examples: - issue: *270 - pull_request: *270 + issue_with_id: + summary: Response for adding an issue using its unique ID + value: *270 + pull_request_with_id: + summary: Response for adding a pull request using its unique ID + value: *270 + issue_with_nwo: + summary: Response for adding an issue using repository owner, name, + and issue number + value: *270 + pull_request_with_nwo: + summary: Response for adding a pull request using repository owner, + name, and PR number + value: *270 '304': *37 '403': *29 '401': *25 diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json index fd6f9e06e..ec2b38b56 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -210867,58 +210867,49 @@ ], "requestBody": { "required": true, - "description": "Details of the item to add to the project. You can specify either the database ID or the repository owner, name, and issue/PR number.", + "description": "Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number.", "content": { "application/json": { "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "enum": [ + "Issue", + "PullRequest" + ], + "description": "The type of item to add to the project. Must be either Issue or PullRequest." + }, + "id": { + "type": "integer", + "description": "The unique identifier of the issue or pull request to add to the project." + }, + "owner": { + "type": "string", + "description": "The repository owner login." + }, + "repo": { + "type": "string", + "description": "The repository name." + }, + "number": { + "type": "integer", + "description": "The issue or pull request number." + } + }, + "required": [ + "type" + ], "oneOf": [ { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "id": { - "type": "integer", - "description": "The unique ID of the issue or pull request to add to the project." - } - }, "required": [ - "type", "id" ] }, { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "owner": { - "type": "string", - "description": "The repository owner login." - }, - "repo": { - "type": "string", - "description": "The repository name." - }, - "number": { - "type": "integer", - "description": "The issue or pull request number." - } - }, "required": [ - "type", "owner", "repo", "number" @@ -210927,22 +210918,22 @@ ] }, "examples": { - "issue-with-id": { - "summary": "Add issue by database ID", + "issue_with_id": { + "summary": "Add an issue using its unique ID", "value": { "type": "Issue", "id": 3 } }, - "pull_request-with-id": { - "summary": "Add pull request by database ID", + "pull_request_with_id": { + "summary": "Add a pull request using its unique ID", "value": { "type": "PullRequest", "id": 3 } }, - "issue-with-nwo": { - "summary": "Add issue by repository and number", + "issue_with_nwo": { + "summary": "Add an issue using repository owner, name, and issue number", "value": { "type": "Issue", "owner": "octocat", @@ -210950,8 +210941,8 @@ "number": 42 } }, - "pull_request-with-nwo": { - "summary": "Add pull request by repository and number", + "pull_request_with_nwo": { + "summary": "Add a pull request using repository owner, name, and PR number", "value": { "type": "PullRequest", "owner": "octocat", @@ -216749,18 +216740,105 @@ ] }, "examples": { - "issue": { + "issue_with_id": { + "summary": "Response for adding an issue using its unique ID", "value": { - "id": 17, - "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", - "content": { - "id": 38, - "node_id": "I_kwDOANN5s85FtLts", - "title": "Example Draft Issue", - "body": "This is a draft issue in the project.", + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, "created_at": "2022-04-28T12:00:00Z", "updated_at": "2022-04-28T12:00:00Z", - "user": { + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } + } + }, + "pull_request_with_id": { + "summary": "Response for adding a pull request using its unique ID", + "value": { + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -216779,48 +216857,114 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - } - }, - "content_type": "DraftIssue", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "archived_at": null, - "project_url": "https://api.github.com/users/octocat/projectsV2/1", - "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } } }, - "pull_request": { + "issue_with_nwo": { + "summary": "Response for adding an issue using repository owner, name, and issue number", "value": { - "id": 17, - "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", - "content": { - "id": 38, - "node_id": "I_kwDOANN5s85FtLts", - "title": "Example Draft Issue", - "body": "This is a draft issue in the project.", + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, "created_at": "2022-04-28T12:00:00Z", "updated_at": "2022-04-28T12:00:00Z", - "user": { + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } + } + }, + "pull_request_with_nwo": { + "summary": "Response for adding a pull request using repository owner, name, and PR number", + "value": { + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -216839,34 +216983,13 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - } - }, - "content_type": "DraftIssue", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "archived_at": null, - "project_url": "https://api.github.com/users/octocat/projectsV2/1", - "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } } } } @@ -284918,48 +285041,8 @@ } ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Workflow Dispatch Response", - "description": "Response containing the workflow run ID and URLs.", - "type": "object", - "properties": { - "workflow_run_id": { - "title": "Workflow Run ID", - "description": "The ID of the workflow run.", - "type": "integer", - "format": "int64" - }, - "run_url": { - "type": "string", - "format": "uri", - "description": "The URL to the workflow run." - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "workflow_run_id", - "run_url", - "html_url" - ] - }, - "examples": { - "default": { - "value": { - "workflow_run_id": 1, - "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1", - "html_url": "https://github.com/octo-org/octo-repo/actions/runs/1" - } - } - } - } - } + "204": { + "description": "Response" } }, "requestBody": { @@ -481611,7 +481694,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -501476,7 +501560,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -502011,7 +502096,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -502585,7 +502671,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -515177,7 +515264,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -515798,7 +515886,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -516461,7 +516550,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -701499,58 +701589,49 @@ ], "requestBody": { "required": true, - "description": "Details of the item to add to the project. You can specify either the database ID or the repository owner, name, and issue/PR number.", + "description": "Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number.", "content": { "application/json": { "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "enum": [ + "Issue", + "PullRequest" + ], + "description": "The type of item to add to the project. Must be either Issue or PullRequest." + }, + "id": { + "type": "integer", + "description": "The unique identifier of the issue or pull request to add to the project." + }, + "owner": { + "type": "string", + "description": "The repository owner login." + }, + "repo": { + "type": "string", + "description": "The repository name." + }, + "number": { + "type": "integer", + "description": "The issue or pull request number." + } + }, + "required": [ + "type" + ], "oneOf": [ { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "id": { - "type": "integer", - "description": "The unique ID of the issue or pull request to add to the project." - } - }, "required": [ - "type", "id" ] }, { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "owner": { - "type": "string", - "description": "The repository owner login." - }, - "repo": { - "type": "string", - "description": "The repository name." - }, - "number": { - "type": "integer", - "description": "The issue or pull request number." - } - }, "required": [ - "type", "owner", "repo", "number" @@ -701559,22 +701640,22 @@ ] }, "examples": { - "issue-with-id": { - "summary": "Add issue by database ID", + "issue_with_id": { + "summary": "Add an issue using its unique ID", "value": { "type": "Issue", "id": 3 } }, - "pull_request-with-id": { - "summary": "Add pull request by database ID", + "pull_request_with_id": { + "summary": "Add a pull request using its unique ID", "value": { "type": "PullRequest", "id": 3 } }, - "issue-with-nwo": { - "summary": "Add issue by repository and number", + "issue_with_nwo": { + "summary": "Add an issue using repository owner, name, and issue number", "value": { "type": "Issue", "owner": "octocat", @@ -701582,8 +701663,8 @@ "number": 42 } }, - "pull_request-with-nwo": { - "summary": "Add pull request by repository and number", + "pull_request_with_nwo": { + "summary": "Add a pull request using repository owner, name, and PR number", "value": { "type": "PullRequest", "owner": "octocat", @@ -707381,18 +707462,105 @@ ] }, "examples": { - "issue": { + "issue_with_id": { + "summary": "Response for adding an issue using its unique ID", "value": { - "id": 17, - "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", - "content": { - "id": 38, - "node_id": "I_kwDOANN5s85FtLts", - "title": "Example Draft Issue", - "body": "This is a draft issue in the project.", + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, "created_at": "2022-04-28T12:00:00Z", "updated_at": "2022-04-28T12:00:00Z", - "user": { + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } + } + }, + "pull_request_with_id": { + "summary": "Response for adding a pull request using its unique ID", + "value": { + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -707411,48 +707579,114 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - } - }, - "content_type": "DraftIssue", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "archived_at": null, - "project_url": "https://api.github.com/users/octocat/projectsV2/1", - "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } } }, - "pull_request": { + "issue_with_nwo": { + "summary": "Response for adding an issue using repository owner, name, and issue number", "value": { - "id": 17, - "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", - "content": { - "id": 38, - "node_id": "I_kwDOANN5s85FtLts", - "title": "Example Draft Issue", - "body": "This is a draft issue in the project.", + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, "created_at": "2022-04-28T12:00:00Z", "updated_at": "2022-04-28T12:00:00Z", - "user": { + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } + } + }, + "pull_request_with_nwo": { + "summary": "Response for adding a pull request using repository owner, name, and PR number", + "value": { + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -707471,34 +707705,13 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - } - }, - "content_type": "DraftIssue", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "archived_at": null, - "project_url": "https://api.github.com/users/octocat/projectsV2/1", - "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } } } } diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 5fe83bcff..9f58cb222 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -53678,70 +53678,62 @@ paths: requestBody: required: true description: Details of the item to add to the project. You can specify either - the database ID or the repository owner, name, and issue/PR number. + the unique ID or the repository owner, name, and issue/PR number. content: application/json: schema: + type: object + additionalProperties: false + properties: + type: + type: string + enum: + - Issue + - PullRequest + description: The type of item to add to the project. Must be either + Issue or PullRequest. + id: + type: integer + description: The unique identifier of the issue or pull request + to add to the project. + owner: + type: string + description: The repository owner login. + repo: + type: string + description: The repository name. + number: + type: integer + description: The issue or pull request number. + required: + - type oneOf: - - type: object - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - id: - type: integer - description: The unique ID of the issue or pull request to add - to the project. - required: - - type + - required: - id - - type: object - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - owner: - type: string - description: The repository owner login. - repo: - type: string - description: The repository name. - number: - type: integer - description: The issue or pull request number. - required: - - type + - required: - owner - repo - number examples: - issue-with-id: - summary: Add issue by database ID + issue_with_id: + summary: Add an issue using its unique ID value: type: Issue id: 3 - pull_request-with-id: - summary: Add pull request by database ID + pull_request_with_id: + summary: Add a pull request using its unique ID value: type: PullRequest id: 3 - issue-with-nwo: - summary: Add issue by repository and number + issue_with_nwo: + summary: Add an issue using repository owner, name, and issue number value: type: Issue owner: octocat repo: hello-world number: 42 - pull_request-with-nwo: - summary: Add pull request by repository and number + pull_request_with_nwo: + summary: Add a pull request using repository owner, name, and PR number value: type: PullRequest owner: octocat @@ -53754,8 +53746,20 @@ paths: application/json: schema: *411 examples: - issue: *412 - pull_request: *412 + issue_with_id: + summary: Response for adding an issue using its unique ID + value: *412 + pull_request_with_id: + summary: Response for adding a pull request using its unique ID + value: *412 + issue_with_nwo: + summary: Response for adding an issue using repository owner, name, + and issue number + value: *412 + pull_request_with_nwo: + summary: Response for adding a pull request using repository owner, + name, and PR number + value: *412 '304': *37 '403': *29 '401': *25 @@ -66691,37 +66695,8 @@ paths: - *460 - *497 responses: - '200': + '204': description: Response - content: - application/json: - schema: - title: Workflow Dispatch Response - description: Response containing the workflow run ID and URLs. - type: object - properties: - workflow_run_id: - title: Workflow Run ID - description: The ID of the workflow run. - type: integer - format: int64 - run_url: - type: string - format: uri - description: The URL to the workflow run. - html_url: - type: string - format: uri - required: - - workflow_run_id - - run_url - - html_url - examples: - default: - value: - workflow_run_id: 1 - run_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/1 - html_url: https://github.com/octo-org/octo-repo/actions/runs/1 requestBody: required: true content: @@ -93891,7 +93866,13 @@ paths: description: The comment ID to reply to. example: 8 type: integer - user: *4 + user: + title: Simple User + description: A GitHub user. + type: object + properties: *20 + required: *21 + nullable: true body: description: The text of the comment. example: We should probably include a check for null @@ -120786,70 +120767,62 @@ paths: requestBody: required: true description: Details of the item to add to the project. You can specify either - the database ID or the repository owner, name, and issue/PR number. + the unique ID or the repository owner, name, and issue/PR number. content: application/json: schema: + type: object + additionalProperties: false + properties: + type: + type: string + enum: + - Issue + - PullRequest + description: The type of item to add to the project. Must be either + Issue or PullRequest. + id: + type: integer + description: The unique identifier of the issue or pull request + to add to the project. + owner: + type: string + description: The repository owner login. + repo: + type: string + description: The repository name. + number: + type: integer + description: The issue or pull request number. + required: + - type oneOf: - - type: object - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - id: - type: integer - description: The unique ID of the issue or pull request to add - to the project. - required: - - type + - required: - id - - type: object - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - owner: - type: string - description: The repository owner login. - repo: - type: string - description: The repository name. - number: - type: integer - description: The issue or pull request number. - required: - - type + - required: - owner - repo - number examples: - issue-with-id: - summary: Add issue by database ID + issue_with_id: + summary: Add an issue using its unique ID value: type: Issue id: 3 - pull_request-with-id: - summary: Add pull request by database ID + pull_request_with_id: + summary: Add a pull request using its unique ID value: type: PullRequest id: 3 - issue-with-nwo: - summary: Add issue by repository and number + issue_with_nwo: + summary: Add an issue using repository owner, name, and issue number value: type: Issue owner: octocat repo: hello-world number: 42 - pull_request-with-nwo: - summary: Add pull request by repository and number + pull_request_with_nwo: + summary: Add a pull request using repository owner, name, and PR number value: type: PullRequest owner: octocat @@ -120862,8 +120835,20 @@ paths: application/json: schema: *411 examples: - issue: *412 - pull_request: *412 + issue_with_id: + summary: Response for adding an issue using its unique ID + value: *412 + pull_request_with_id: + summary: Response for adding a pull request using its unique ID + value: *412 + issue_with_nwo: + summary: Response for adding an issue using repository owner, name, + and issue number + value: *412 + pull_request_with_nwo: + summary: Response for adding a pull request using repository owner, + name, and PR number + value: *412 '304': *37 '403': *29 '401': *25 diff --git a/descriptions/ghec/dereferenced/ghec.deref.json b/descriptions/ghec/dereferenced/ghec.deref.json index fd6f9e06e..ec2b38b56 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.json +++ b/descriptions/ghec/dereferenced/ghec.deref.json @@ -210867,58 +210867,49 @@ ], "requestBody": { "required": true, - "description": "Details of the item to add to the project. You can specify either the database ID or the repository owner, name, and issue/PR number.", + "description": "Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number.", "content": { "application/json": { "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "enum": [ + "Issue", + "PullRequest" + ], + "description": "The type of item to add to the project. Must be either Issue or PullRequest." + }, + "id": { + "type": "integer", + "description": "The unique identifier of the issue or pull request to add to the project." + }, + "owner": { + "type": "string", + "description": "The repository owner login." + }, + "repo": { + "type": "string", + "description": "The repository name." + }, + "number": { + "type": "integer", + "description": "The issue or pull request number." + } + }, + "required": [ + "type" + ], "oneOf": [ { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "id": { - "type": "integer", - "description": "The unique ID of the issue or pull request to add to the project." - } - }, "required": [ - "type", "id" ] }, { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "owner": { - "type": "string", - "description": "The repository owner login." - }, - "repo": { - "type": "string", - "description": "The repository name." - }, - "number": { - "type": "integer", - "description": "The issue or pull request number." - } - }, "required": [ - "type", "owner", "repo", "number" @@ -210927,22 +210918,22 @@ ] }, "examples": { - "issue-with-id": { - "summary": "Add issue by database ID", + "issue_with_id": { + "summary": "Add an issue using its unique ID", "value": { "type": "Issue", "id": 3 } }, - "pull_request-with-id": { - "summary": "Add pull request by database ID", + "pull_request_with_id": { + "summary": "Add a pull request using its unique ID", "value": { "type": "PullRequest", "id": 3 } }, - "issue-with-nwo": { - "summary": "Add issue by repository and number", + "issue_with_nwo": { + "summary": "Add an issue using repository owner, name, and issue number", "value": { "type": "Issue", "owner": "octocat", @@ -210950,8 +210941,8 @@ "number": 42 } }, - "pull_request-with-nwo": { - "summary": "Add pull request by repository and number", + "pull_request_with_nwo": { + "summary": "Add a pull request using repository owner, name, and PR number", "value": { "type": "PullRequest", "owner": "octocat", @@ -216749,18 +216740,105 @@ ] }, "examples": { - "issue": { + "issue_with_id": { + "summary": "Response for adding an issue using its unique ID", "value": { - "id": 17, - "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", - "content": { - "id": 38, - "node_id": "I_kwDOANN5s85FtLts", - "title": "Example Draft Issue", - "body": "This is a draft issue in the project.", + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, "created_at": "2022-04-28T12:00:00Z", "updated_at": "2022-04-28T12:00:00Z", - "user": { + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } + } + }, + "pull_request_with_id": { + "summary": "Response for adding a pull request using its unique ID", + "value": { + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -216779,48 +216857,114 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - } - }, - "content_type": "DraftIssue", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "archived_at": null, - "project_url": "https://api.github.com/users/octocat/projectsV2/1", - "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } } }, - "pull_request": { + "issue_with_nwo": { + "summary": "Response for adding an issue using repository owner, name, and issue number", "value": { - "id": 17, - "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", - "content": { - "id": 38, - "node_id": "I_kwDOANN5s85FtLts", - "title": "Example Draft Issue", - "body": "This is a draft issue in the project.", + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, "created_at": "2022-04-28T12:00:00Z", "updated_at": "2022-04-28T12:00:00Z", - "user": { + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } + } + }, + "pull_request_with_nwo": { + "summary": "Response for adding a pull request using repository owner, name, and PR number", + "value": { + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -216839,34 +216983,13 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - } - }, - "content_type": "DraftIssue", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "archived_at": null, - "project_url": "https://api.github.com/users/octocat/projectsV2/1", - "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } } } } @@ -284918,48 +285041,8 @@ } ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Workflow Dispatch Response", - "description": "Response containing the workflow run ID and URLs.", - "type": "object", - "properties": { - "workflow_run_id": { - "title": "Workflow Run ID", - "description": "The ID of the workflow run.", - "type": "integer", - "format": "int64" - }, - "run_url": { - "type": "string", - "format": "uri", - "description": "The URL to the workflow run." - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "workflow_run_id", - "run_url", - "html_url" - ] - }, - "examples": { - "default": { - "value": { - "workflow_run_id": 1, - "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1", - "html_url": "https://github.com/octo-org/octo-repo/actions/runs/1" - } - } - } - } - } + "204": { + "description": "Response" } }, "requestBody": { @@ -481611,7 +481694,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -501476,7 +501560,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -502011,7 +502096,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -502585,7 +502671,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -515177,7 +515264,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -515798,7 +515886,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -516461,7 +516550,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -701499,58 +701589,49 @@ ], "requestBody": { "required": true, - "description": "Details of the item to add to the project. You can specify either the database ID or the repository owner, name, and issue/PR number.", + "description": "Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number.", "content": { "application/json": { "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "enum": [ + "Issue", + "PullRequest" + ], + "description": "The type of item to add to the project. Must be either Issue or PullRequest." + }, + "id": { + "type": "integer", + "description": "The unique identifier of the issue or pull request to add to the project." + }, + "owner": { + "type": "string", + "description": "The repository owner login." + }, + "repo": { + "type": "string", + "description": "The repository name." + }, + "number": { + "type": "integer", + "description": "The issue or pull request number." + } + }, + "required": [ + "type" + ], "oneOf": [ { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "id": { - "type": "integer", - "description": "The unique ID of the issue or pull request to add to the project." - } - }, "required": [ - "type", "id" ] }, { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "owner": { - "type": "string", - "description": "The repository owner login." - }, - "repo": { - "type": "string", - "description": "The repository name." - }, - "number": { - "type": "integer", - "description": "The issue or pull request number." - } - }, "required": [ - "type", "owner", "repo", "number" @@ -701559,22 +701640,22 @@ ] }, "examples": { - "issue-with-id": { - "summary": "Add issue by database ID", + "issue_with_id": { + "summary": "Add an issue using its unique ID", "value": { "type": "Issue", "id": 3 } }, - "pull_request-with-id": { - "summary": "Add pull request by database ID", + "pull_request_with_id": { + "summary": "Add a pull request using its unique ID", "value": { "type": "PullRequest", "id": 3 } }, - "issue-with-nwo": { - "summary": "Add issue by repository and number", + "issue_with_nwo": { + "summary": "Add an issue using repository owner, name, and issue number", "value": { "type": "Issue", "owner": "octocat", @@ -701582,8 +701663,8 @@ "number": 42 } }, - "pull_request-with-nwo": { - "summary": "Add pull request by repository and number", + "pull_request_with_nwo": { + "summary": "Add a pull request using repository owner, name, and PR number", "value": { "type": "PullRequest", "owner": "octocat", @@ -707381,18 +707462,105 @@ ] }, "examples": { - "issue": { + "issue_with_id": { + "summary": "Response for adding an issue using its unique ID", "value": { - "id": 17, - "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", - "content": { - "id": 38, - "node_id": "I_kwDOANN5s85FtLts", - "title": "Example Draft Issue", - "body": "This is a draft issue in the project.", + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, "created_at": "2022-04-28T12:00:00Z", "updated_at": "2022-04-28T12:00:00Z", - "user": { + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } + } + }, + "pull_request_with_id": { + "summary": "Response for adding a pull request using its unique ID", + "value": { + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -707411,48 +707579,114 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - } - }, - "content_type": "DraftIssue", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "archived_at": null, - "project_url": "https://api.github.com/users/octocat/projectsV2/1", - "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } } }, - "pull_request": { + "issue_with_nwo": { + "summary": "Response for adding an issue using repository owner, name, and issue number", "value": { - "id": 17, - "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", - "content": { - "id": 38, - "node_id": "I_kwDOANN5s85FtLts", - "title": "Example Draft Issue", - "body": "This is a draft issue in the project.", + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, "created_at": "2022-04-28T12:00:00Z", "updated_at": "2022-04-28T12:00:00Z", - "user": { + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } + } + }, + "pull_request_with_nwo": { + "summary": "Response for adding a pull request using repository owner, name, and PR number", + "value": { + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -707471,34 +707705,13 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - } - }, - "content_type": "DraftIssue", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z", - "archived_at": null, - "project_url": "https://api.github.com/users/octocat/projectsV2/1", - "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } } } } diff --git a/descriptions/ghec/dereferenced/ghec.deref.yaml b/descriptions/ghec/dereferenced/ghec.deref.yaml index 5fe83bcff..9f58cb222 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.deref.yaml @@ -53678,70 +53678,62 @@ paths: requestBody: required: true description: Details of the item to add to the project. You can specify either - the database ID or the repository owner, name, and issue/PR number. + the unique ID or the repository owner, name, and issue/PR number. content: application/json: schema: + type: object + additionalProperties: false + properties: + type: + type: string + enum: + - Issue + - PullRequest + description: The type of item to add to the project. Must be either + Issue or PullRequest. + id: + type: integer + description: The unique identifier of the issue or pull request + to add to the project. + owner: + type: string + description: The repository owner login. + repo: + type: string + description: The repository name. + number: + type: integer + description: The issue or pull request number. + required: + - type oneOf: - - type: object - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - id: - type: integer - description: The unique ID of the issue or pull request to add - to the project. - required: - - type + - required: - id - - type: object - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - owner: - type: string - description: The repository owner login. - repo: - type: string - description: The repository name. - number: - type: integer - description: The issue or pull request number. - required: - - type + - required: - owner - repo - number examples: - issue-with-id: - summary: Add issue by database ID + issue_with_id: + summary: Add an issue using its unique ID value: type: Issue id: 3 - pull_request-with-id: - summary: Add pull request by database ID + pull_request_with_id: + summary: Add a pull request using its unique ID value: type: PullRequest id: 3 - issue-with-nwo: - summary: Add issue by repository and number + issue_with_nwo: + summary: Add an issue using repository owner, name, and issue number value: type: Issue owner: octocat repo: hello-world number: 42 - pull_request-with-nwo: - summary: Add pull request by repository and number + pull_request_with_nwo: + summary: Add a pull request using repository owner, name, and PR number value: type: PullRequest owner: octocat @@ -53754,8 +53746,20 @@ paths: application/json: schema: *411 examples: - issue: *412 - pull_request: *412 + issue_with_id: + summary: Response for adding an issue using its unique ID + value: *412 + pull_request_with_id: + summary: Response for adding a pull request using its unique ID + value: *412 + issue_with_nwo: + summary: Response for adding an issue using repository owner, name, + and issue number + value: *412 + pull_request_with_nwo: + summary: Response for adding a pull request using repository owner, + name, and PR number + value: *412 '304': *37 '403': *29 '401': *25 @@ -66691,37 +66695,8 @@ paths: - *460 - *497 responses: - '200': + '204': description: Response - content: - application/json: - schema: - title: Workflow Dispatch Response - description: Response containing the workflow run ID and URLs. - type: object - properties: - workflow_run_id: - title: Workflow Run ID - description: The ID of the workflow run. - type: integer - format: int64 - run_url: - type: string - format: uri - description: The URL to the workflow run. - html_url: - type: string - format: uri - required: - - workflow_run_id - - run_url - - html_url - examples: - default: - value: - workflow_run_id: 1 - run_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/1 - html_url: https://github.com/octo-org/octo-repo/actions/runs/1 requestBody: required: true content: @@ -93891,7 +93866,13 @@ paths: description: The comment ID to reply to. example: 8 type: integer - user: *4 + user: + title: Simple User + description: A GitHub user. + type: object + properties: *20 + required: *21 + nullable: true body: description: The text of the comment. example: We should probably include a check for null @@ -120786,70 +120767,62 @@ paths: requestBody: required: true description: Details of the item to add to the project. You can specify either - the database ID or the repository owner, name, and issue/PR number. + the unique ID or the repository owner, name, and issue/PR number. content: application/json: schema: + type: object + additionalProperties: false + properties: + type: + type: string + enum: + - Issue + - PullRequest + description: The type of item to add to the project. Must be either + Issue or PullRequest. + id: + type: integer + description: The unique identifier of the issue or pull request + to add to the project. + owner: + type: string + description: The repository owner login. + repo: + type: string + description: The repository name. + number: + type: integer + description: The issue or pull request number. + required: + - type oneOf: - - type: object - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - id: - type: integer - description: The unique ID of the issue or pull request to add - to the project. - required: - - type + - required: - id - - type: object - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - owner: - type: string - description: The repository owner login. - repo: - type: string - description: The repository name. - number: - type: integer - description: The issue or pull request number. - required: - - type + - required: - owner - repo - number examples: - issue-with-id: - summary: Add issue by database ID + issue_with_id: + summary: Add an issue using its unique ID value: type: Issue id: 3 - pull_request-with-id: - summary: Add pull request by database ID + pull_request_with_id: + summary: Add a pull request using its unique ID value: type: PullRequest id: 3 - issue-with-nwo: - summary: Add issue by repository and number + issue_with_nwo: + summary: Add an issue using repository owner, name, and issue number value: type: Issue owner: octocat repo: hello-world number: 42 - pull_request-with-nwo: - summary: Add pull request by repository and number + pull_request_with_nwo: + summary: Add a pull request using repository owner, name, and PR number value: type: PullRequest owner: octocat @@ -120862,8 +120835,20 @@ paths: application/json: schema: *411 examples: - issue: *412 - pull_request: *412 + issue_with_id: + summary: Response for adding an issue using its unique ID + value: *412 + pull_request_with_id: + summary: Response for adding a pull request using its unique ID + value: *412 + issue_with_nwo: + summary: Response for adding an issue using repository owner, name, + and issue number + value: *412 + pull_request_with_nwo: + summary: Response for adding a pull request using repository owner, + name, and PR number + value: *412 '304': *37 '403': *29 '401': *25 diff --git a/descriptions/ghec/ghec.2022-11-28.json b/descriptions/ghec/ghec.2022-11-28.json index 76e23fbc5..ef7b21d72 100644 --- a/descriptions/ghec/ghec.2022-11-28.json +++ b/descriptions/ghec/ghec.2022-11-28.json @@ -36673,58 +36673,49 @@ ], "requestBody": { "required": true, - "description": "Details of the item to add to the project. You can specify either the database ID or the repository owner, name, and issue/PR number.", + "description": "Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number.", "content": { "application/json": { "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "enum": [ + "Issue", + "PullRequest" + ], + "description": "The type of item to add to the project. Must be either Issue or PullRequest." + }, + "id": { + "type": "integer", + "description": "The unique identifier of the issue or pull request to add to the project." + }, + "owner": { + "type": "string", + "description": "The repository owner login." + }, + "repo": { + "type": "string", + "description": "The repository name." + }, + "number": { + "type": "integer", + "description": "The issue or pull request number." + } + }, + "required": [ + "type" + ], "oneOf": [ { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "id": { - "type": "integer", - "description": "The unique ID of the issue or pull request to add to the project." - } - }, "required": [ - "type", "id" ] }, { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "owner": { - "type": "string", - "description": "The repository owner login." - }, - "repo": { - "type": "string", - "description": "The repository name." - }, - "number": { - "type": "integer", - "description": "The issue or pull request number." - } - }, "required": [ - "type", "owner", "repo", "number" @@ -36733,22 +36724,22 @@ ] }, "examples": { - "issue-with-id": { - "summary": "Add issue by database ID", + "issue_with_id": { + "summary": "Add an issue using its unique ID", "value": { "type": "Issue", "id": 3 } }, - "pull_request-with-id": { - "summary": "Add pull request by database ID", + "pull_request_with_id": { + "summary": "Add a pull request using its unique ID", "value": { "type": "PullRequest", "id": 3 } }, - "issue-with-nwo": { - "summary": "Add issue by repository and number", + "issue_with_nwo": { + "summary": "Add an issue using repository owner, name, and issue number", "value": { "type": "Issue", "owner": "octocat", @@ -36756,8 +36747,8 @@ "number": 42 } }, - "pull_request-with-nwo": { - "summary": "Add pull request by repository and number", + "pull_request_with_nwo": { + "summary": "Add a pull request using repository owner, name, and PR number", "value": { "type": "PullRequest", "owner": "octocat", @@ -36778,11 +36769,29 @@ "$ref": "#/components/schemas/projects-v2-item-simple" }, "examples": { - "issue": { - "$ref": "#/components/examples/projects-v2-item-simple" + "issue_with_id": { + "summary": "Response for adding an issue using its unique ID", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } }, - "pull_request": { - "$ref": "#/components/examples/projects-v2-item-simple" + "pull_request_with_id": { + "summary": "Response for adding a pull request using its unique ID", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } + }, + "issue_with_nwo": { + "summary": "Response for adding an issue using repository owner, name, and issue number", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } + }, + "pull_request_with_nwo": { + "summary": "Response for adding a pull request using repository owner, name, and PR number", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } } } } @@ -46772,20 +46781,8 @@ } ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/workflow-dispatch-response" - }, - "examples": { - "default": { - "$ref": "#/components/examples/workflow-dispatch-response" - } - } - } - } + "204": { + "description": "Response" } }, "requestBody": { @@ -89719,58 +89716,49 @@ ], "requestBody": { "required": true, - "description": "Details of the item to add to the project. You can specify either the database ID or the repository owner, name, and issue/PR number.", + "description": "Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number.", "content": { "application/json": { "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "enum": [ + "Issue", + "PullRequest" + ], + "description": "The type of item to add to the project. Must be either Issue or PullRequest." + }, + "id": { + "type": "integer", + "description": "The unique identifier of the issue or pull request to add to the project." + }, + "owner": { + "type": "string", + "description": "The repository owner login." + }, + "repo": { + "type": "string", + "description": "The repository name." + }, + "number": { + "type": "integer", + "description": "The issue or pull request number." + } + }, + "required": [ + "type" + ], "oneOf": [ { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "id": { - "type": "integer", - "description": "The unique ID of the issue or pull request to add to the project." - } - }, "required": [ - "type", "id" ] }, { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "owner": { - "type": "string", - "description": "The repository owner login." - }, - "repo": { - "type": "string", - "description": "The repository name." - }, - "number": { - "type": "integer", - "description": "The issue or pull request number." - } - }, "required": [ - "type", "owner", "repo", "number" @@ -89779,22 +89767,22 @@ ] }, "examples": { - "issue-with-id": { - "summary": "Add issue by database ID", + "issue_with_id": { + "summary": "Add an issue using its unique ID", "value": { "type": "Issue", "id": 3 } }, - "pull_request-with-id": { - "summary": "Add pull request by database ID", + "pull_request_with_id": { + "summary": "Add a pull request using its unique ID", "value": { "type": "PullRequest", "id": 3 } }, - "issue-with-nwo": { - "summary": "Add issue by repository and number", + "issue_with_nwo": { + "summary": "Add an issue using repository owner, name, and issue number", "value": { "type": "Issue", "owner": "octocat", @@ -89802,8 +89790,8 @@ "number": 42 } }, - "pull_request-with-nwo": { - "summary": "Add pull request by repository and number", + "pull_request_with_nwo": { + "summary": "Add a pull request using repository owner, name, and PR number", "value": { "type": "PullRequest", "owner": "octocat", @@ -89824,11 +89812,29 @@ "$ref": "#/components/schemas/projects-v2-item-simple" }, "examples": { - "issue": { - "$ref": "#/components/examples/projects-v2-item-simple" + "issue_with_id": { + "summary": "Response for adding an issue using its unique ID", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } }, - "pull_request": { - "$ref": "#/components/examples/projects-v2-item-simple" + "pull_request_with_id": { + "summary": "Response for adding a pull request using its unique ID", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } + }, + "issue_with_nwo": { + "summary": "Response for adding an issue using repository owner, name, and issue number", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } + }, + "pull_request_with_nwo": { + "summary": "Response for adding a pull request using repository owner, name, and PR number", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } } } } @@ -151796,7 +151802,7 @@ "type": "integer" }, "user": { - "$ref": "#/components/schemas/simple-user" + "$ref": "#/components/schemas/nullable-simple-user" }, "body": { "description": "The text of the comment.", diff --git a/descriptions/ghec/ghec.2022-11-28.yaml b/descriptions/ghec/ghec.2022-11-28.yaml index 971b2b7cd..dcdd8e3a4 100644 --- a/descriptions/ghec/ghec.2022-11-28.yaml +++ b/descriptions/ghec/ghec.2022-11-28.yaml @@ -26492,70 +26492,62 @@ paths: requestBody: required: true description: Details of the item to add to the project. You can specify either - the database ID or the repository owner, name, and issue/PR number. + the unique ID or the repository owner, name, and issue/PR number. content: application/json: schema: + type: object + additionalProperties: false + properties: + type: + type: string + enum: + - Issue + - PullRequest + description: The type of item to add to the project. Must be either + Issue or PullRequest. + id: + type: integer + description: The unique identifier of the issue or pull request + to add to the project. + owner: + type: string + description: The repository owner login. + repo: + type: string + description: The repository name. + number: + type: integer + description: The issue or pull request number. + required: + - type oneOf: - - type: object - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - id: - type: integer - description: The unique ID of the issue or pull request to add - to the project. - required: - - type + - required: - id - - type: object - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - owner: - type: string - description: The repository owner login. - repo: - type: string - description: The repository name. - number: - type: integer - description: The issue or pull request number. - required: - - type + - required: - owner - repo - number examples: - issue-with-id: - summary: Add issue by database ID + issue_with_id: + summary: Add an issue using its unique ID value: type: Issue id: 3 - pull_request-with-id: - summary: Add pull request by database ID + pull_request_with_id: + summary: Add a pull request using its unique ID value: type: PullRequest id: 3 - issue-with-nwo: - summary: Add issue by repository and number + issue_with_nwo: + summary: Add an issue using repository owner, name, and issue number value: type: Issue owner: octocat repo: hello-world number: 42 - pull_request-with-nwo: - summary: Add pull request by repository and number + pull_request_with_nwo: + summary: Add a pull request using repository owner, name, and PR number value: type: PullRequest owner: octocat @@ -26569,10 +26561,24 @@ paths: schema: "$ref": "#/components/schemas/projects-v2-item-simple" examples: - issue: - "$ref": "#/components/examples/projects-v2-item-simple" - pull_request: - "$ref": "#/components/examples/projects-v2-item-simple" + issue_with_id: + summary: Response for adding an issue using its unique ID + value: + "$ref": "#/components/examples/projects-v2-item-simple" + pull_request_with_id: + summary: Response for adding a pull request using its unique ID + value: + "$ref": "#/components/examples/projects-v2-item-simple" + issue_with_nwo: + summary: Response for adding an issue using repository owner, name, + and issue number + value: + "$ref": "#/components/examples/projects-v2-item-simple" + pull_request_with_nwo: + summary: Response for adding a pull request using repository owner, + name, and PR number + value: + "$ref": "#/components/examples/projects-v2-item-simple" '304': "$ref": "#/components/responses/not_modified" '403': @@ -33800,15 +33806,8 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/workflow-id" responses: - '200': + '204': description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/workflow-dispatch-response" - examples: - default: - "$ref": "#/components/examples/workflow-dispatch-response" requestBody: required: true content: @@ -64859,70 +64858,62 @@ paths: requestBody: required: true description: Details of the item to add to the project. You can specify either - the database ID or the repository owner, name, and issue/PR number. + the unique ID or the repository owner, name, and issue/PR number. content: application/json: schema: + type: object + additionalProperties: false + properties: + type: + type: string + enum: + - Issue + - PullRequest + description: The type of item to add to the project. Must be either + Issue or PullRequest. + id: + type: integer + description: The unique identifier of the issue or pull request + to add to the project. + owner: + type: string + description: The repository owner login. + repo: + type: string + description: The repository name. + number: + type: integer + description: The issue or pull request number. + required: + - type oneOf: - - type: object - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - id: - type: integer - description: The unique ID of the issue or pull request to add - to the project. - required: - - type + - required: - id - - type: object - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - owner: - type: string - description: The repository owner login. - repo: - type: string - description: The repository name. - number: - type: integer - description: The issue or pull request number. - required: - - type + - required: - owner - repo - number examples: - issue-with-id: - summary: Add issue by database ID + issue_with_id: + summary: Add an issue using its unique ID value: type: Issue id: 3 - pull_request-with-id: - summary: Add pull request by database ID + pull_request_with_id: + summary: Add a pull request using its unique ID value: type: PullRequest id: 3 - issue-with-nwo: - summary: Add issue by repository and number + issue_with_nwo: + summary: Add an issue using repository owner, name, and issue number value: type: Issue owner: octocat repo: hello-world number: 42 - pull_request-with-nwo: - summary: Add pull request by repository and number + pull_request_with_nwo: + summary: Add a pull request using repository owner, name, and PR number value: type: PullRequest owner: octocat @@ -64936,10 +64927,24 @@ paths: schema: "$ref": "#/components/schemas/projects-v2-item-simple" examples: - issue: - "$ref": "#/components/examples/projects-v2-item-simple" - pull_request: - "$ref": "#/components/examples/projects-v2-item-simple" + issue_with_id: + summary: Response for adding an issue using its unique ID + value: + "$ref": "#/components/examples/projects-v2-item-simple" + pull_request_with_id: + summary: Response for adding a pull request using its unique ID + value: + "$ref": "#/components/examples/projects-v2-item-simple" + issue_with_nwo: + summary: Response for adding an issue using repository owner, name, + and issue number + value: + "$ref": "#/components/examples/projects-v2-item-simple" + pull_request_with_nwo: + summary: Response for adding a pull request using repository owner, + name, and PR number + value: + "$ref": "#/components/examples/projects-v2-item-simple" '304': "$ref": "#/components/responses/not_modified" '403': @@ -111549,7 +111554,7 @@ components: example: 8 type: integer user: - "$ref": "#/components/schemas/simple-user" + "$ref": "#/components/schemas/nullable-simple-user" body: description: The text of the comment. example: We should probably include a check for null values here. diff --git a/descriptions/ghec/ghec.json b/descriptions/ghec/ghec.json index 76e23fbc5..ef7b21d72 100644 --- a/descriptions/ghec/ghec.json +++ b/descriptions/ghec/ghec.json @@ -36673,58 +36673,49 @@ ], "requestBody": { "required": true, - "description": "Details of the item to add to the project. You can specify either the database ID or the repository owner, name, and issue/PR number.", + "description": "Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number.", "content": { "application/json": { "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "enum": [ + "Issue", + "PullRequest" + ], + "description": "The type of item to add to the project. Must be either Issue or PullRequest." + }, + "id": { + "type": "integer", + "description": "The unique identifier of the issue or pull request to add to the project." + }, + "owner": { + "type": "string", + "description": "The repository owner login." + }, + "repo": { + "type": "string", + "description": "The repository name." + }, + "number": { + "type": "integer", + "description": "The issue or pull request number." + } + }, + "required": [ + "type" + ], "oneOf": [ { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "id": { - "type": "integer", - "description": "The unique ID of the issue or pull request to add to the project." - } - }, "required": [ - "type", "id" ] }, { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "owner": { - "type": "string", - "description": "The repository owner login." - }, - "repo": { - "type": "string", - "description": "The repository name." - }, - "number": { - "type": "integer", - "description": "The issue or pull request number." - } - }, "required": [ - "type", "owner", "repo", "number" @@ -36733,22 +36724,22 @@ ] }, "examples": { - "issue-with-id": { - "summary": "Add issue by database ID", + "issue_with_id": { + "summary": "Add an issue using its unique ID", "value": { "type": "Issue", "id": 3 } }, - "pull_request-with-id": { - "summary": "Add pull request by database ID", + "pull_request_with_id": { + "summary": "Add a pull request using its unique ID", "value": { "type": "PullRequest", "id": 3 } }, - "issue-with-nwo": { - "summary": "Add issue by repository and number", + "issue_with_nwo": { + "summary": "Add an issue using repository owner, name, and issue number", "value": { "type": "Issue", "owner": "octocat", @@ -36756,8 +36747,8 @@ "number": 42 } }, - "pull_request-with-nwo": { - "summary": "Add pull request by repository and number", + "pull_request_with_nwo": { + "summary": "Add a pull request using repository owner, name, and PR number", "value": { "type": "PullRequest", "owner": "octocat", @@ -36778,11 +36769,29 @@ "$ref": "#/components/schemas/projects-v2-item-simple" }, "examples": { - "issue": { - "$ref": "#/components/examples/projects-v2-item-simple" + "issue_with_id": { + "summary": "Response for adding an issue using its unique ID", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } }, - "pull_request": { - "$ref": "#/components/examples/projects-v2-item-simple" + "pull_request_with_id": { + "summary": "Response for adding a pull request using its unique ID", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } + }, + "issue_with_nwo": { + "summary": "Response for adding an issue using repository owner, name, and issue number", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } + }, + "pull_request_with_nwo": { + "summary": "Response for adding a pull request using repository owner, name, and PR number", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } } } } @@ -46772,20 +46781,8 @@ } ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/workflow-dispatch-response" - }, - "examples": { - "default": { - "$ref": "#/components/examples/workflow-dispatch-response" - } - } - } - } + "204": { + "description": "Response" } }, "requestBody": { @@ -89719,58 +89716,49 @@ ], "requestBody": { "required": true, - "description": "Details of the item to add to the project. You can specify either the database ID or the repository owner, name, and issue/PR number.", + "description": "Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number.", "content": { "application/json": { "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "enum": [ + "Issue", + "PullRequest" + ], + "description": "The type of item to add to the project. Must be either Issue or PullRequest." + }, + "id": { + "type": "integer", + "description": "The unique identifier of the issue or pull request to add to the project." + }, + "owner": { + "type": "string", + "description": "The repository owner login." + }, + "repo": { + "type": "string", + "description": "The repository name." + }, + "number": { + "type": "integer", + "description": "The issue or pull request number." + } + }, + "required": [ + "type" + ], "oneOf": [ { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "id": { - "type": "integer", - "description": "The unique ID of the issue or pull request to add to the project." - } - }, "required": [ - "type", "id" ] }, { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "owner": { - "type": "string", - "description": "The repository owner login." - }, - "repo": { - "type": "string", - "description": "The repository name." - }, - "number": { - "type": "integer", - "description": "The issue or pull request number." - } - }, "required": [ - "type", "owner", "repo", "number" @@ -89779,22 +89767,22 @@ ] }, "examples": { - "issue-with-id": { - "summary": "Add issue by database ID", + "issue_with_id": { + "summary": "Add an issue using its unique ID", "value": { "type": "Issue", "id": 3 } }, - "pull_request-with-id": { - "summary": "Add pull request by database ID", + "pull_request_with_id": { + "summary": "Add a pull request using its unique ID", "value": { "type": "PullRequest", "id": 3 } }, - "issue-with-nwo": { - "summary": "Add issue by repository and number", + "issue_with_nwo": { + "summary": "Add an issue using repository owner, name, and issue number", "value": { "type": "Issue", "owner": "octocat", @@ -89802,8 +89790,8 @@ "number": 42 } }, - "pull_request-with-nwo": { - "summary": "Add pull request by repository and number", + "pull_request_with_nwo": { + "summary": "Add a pull request using repository owner, name, and PR number", "value": { "type": "PullRequest", "owner": "octocat", @@ -89824,11 +89812,29 @@ "$ref": "#/components/schemas/projects-v2-item-simple" }, "examples": { - "issue": { - "$ref": "#/components/examples/projects-v2-item-simple" + "issue_with_id": { + "summary": "Response for adding an issue using its unique ID", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } }, - "pull_request": { - "$ref": "#/components/examples/projects-v2-item-simple" + "pull_request_with_id": { + "summary": "Response for adding a pull request using its unique ID", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } + }, + "issue_with_nwo": { + "summary": "Response for adding an issue using repository owner, name, and issue number", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } + }, + "pull_request_with_nwo": { + "summary": "Response for adding a pull request using repository owner, name, and PR number", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } } } } @@ -151796,7 +151802,7 @@ "type": "integer" }, "user": { - "$ref": "#/components/schemas/simple-user" + "$ref": "#/components/schemas/nullable-simple-user" }, "body": { "description": "The text of the comment.", diff --git a/descriptions/ghec/ghec.yaml b/descriptions/ghec/ghec.yaml index 971b2b7cd..dcdd8e3a4 100644 --- a/descriptions/ghec/ghec.yaml +++ b/descriptions/ghec/ghec.yaml @@ -26492,70 +26492,62 @@ paths: requestBody: required: true description: Details of the item to add to the project. You can specify either - the database ID or the repository owner, name, and issue/PR number. + the unique ID or the repository owner, name, and issue/PR number. content: application/json: schema: + type: object + additionalProperties: false + properties: + type: + type: string + enum: + - Issue + - PullRequest + description: The type of item to add to the project. Must be either + Issue or PullRequest. + id: + type: integer + description: The unique identifier of the issue or pull request + to add to the project. + owner: + type: string + description: The repository owner login. + repo: + type: string + description: The repository name. + number: + type: integer + description: The issue or pull request number. + required: + - type oneOf: - - type: object - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - id: - type: integer - description: The unique ID of the issue or pull request to add - to the project. - required: - - type + - required: - id - - type: object - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - owner: - type: string - description: The repository owner login. - repo: - type: string - description: The repository name. - number: - type: integer - description: The issue or pull request number. - required: - - type + - required: - owner - repo - number examples: - issue-with-id: - summary: Add issue by database ID + issue_with_id: + summary: Add an issue using its unique ID value: type: Issue id: 3 - pull_request-with-id: - summary: Add pull request by database ID + pull_request_with_id: + summary: Add a pull request using its unique ID value: type: PullRequest id: 3 - issue-with-nwo: - summary: Add issue by repository and number + issue_with_nwo: + summary: Add an issue using repository owner, name, and issue number value: type: Issue owner: octocat repo: hello-world number: 42 - pull_request-with-nwo: - summary: Add pull request by repository and number + pull_request_with_nwo: + summary: Add a pull request using repository owner, name, and PR number value: type: PullRequest owner: octocat @@ -26569,10 +26561,24 @@ paths: schema: "$ref": "#/components/schemas/projects-v2-item-simple" examples: - issue: - "$ref": "#/components/examples/projects-v2-item-simple" - pull_request: - "$ref": "#/components/examples/projects-v2-item-simple" + issue_with_id: + summary: Response for adding an issue using its unique ID + value: + "$ref": "#/components/examples/projects-v2-item-simple" + pull_request_with_id: + summary: Response for adding a pull request using its unique ID + value: + "$ref": "#/components/examples/projects-v2-item-simple" + issue_with_nwo: + summary: Response for adding an issue using repository owner, name, + and issue number + value: + "$ref": "#/components/examples/projects-v2-item-simple" + pull_request_with_nwo: + summary: Response for adding a pull request using repository owner, + name, and PR number + value: + "$ref": "#/components/examples/projects-v2-item-simple" '304': "$ref": "#/components/responses/not_modified" '403': @@ -33800,15 +33806,8 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/workflow-id" responses: - '200': + '204': description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/workflow-dispatch-response" - examples: - default: - "$ref": "#/components/examples/workflow-dispatch-response" requestBody: required: true content: @@ -64859,70 +64858,62 @@ paths: requestBody: required: true description: Details of the item to add to the project. You can specify either - the database ID or the repository owner, name, and issue/PR number. + the unique ID or the repository owner, name, and issue/PR number. content: application/json: schema: + type: object + additionalProperties: false + properties: + type: + type: string + enum: + - Issue + - PullRequest + description: The type of item to add to the project. Must be either + Issue or PullRequest. + id: + type: integer + description: The unique identifier of the issue or pull request + to add to the project. + owner: + type: string + description: The repository owner login. + repo: + type: string + description: The repository name. + number: + type: integer + description: The issue or pull request number. + required: + - type oneOf: - - type: object - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - id: - type: integer - description: The unique ID of the issue or pull request to add - to the project. - required: - - type + - required: - id - - type: object - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - owner: - type: string - description: The repository owner login. - repo: - type: string - description: The repository name. - number: - type: integer - description: The issue or pull request number. - required: - - type + - required: - owner - repo - number examples: - issue-with-id: - summary: Add issue by database ID + issue_with_id: + summary: Add an issue using its unique ID value: type: Issue id: 3 - pull_request-with-id: - summary: Add pull request by database ID + pull_request_with_id: + summary: Add a pull request using its unique ID value: type: PullRequest id: 3 - issue-with-nwo: - summary: Add issue by repository and number + issue_with_nwo: + summary: Add an issue using repository owner, name, and issue number value: type: Issue owner: octocat repo: hello-world number: 42 - pull_request-with-nwo: - summary: Add pull request by repository and number + pull_request_with_nwo: + summary: Add a pull request using repository owner, name, and PR number value: type: PullRequest owner: octocat @@ -64936,10 +64927,24 @@ paths: schema: "$ref": "#/components/schemas/projects-v2-item-simple" examples: - issue: - "$ref": "#/components/examples/projects-v2-item-simple" - pull_request: - "$ref": "#/components/examples/projects-v2-item-simple" + issue_with_id: + summary: Response for adding an issue using its unique ID + value: + "$ref": "#/components/examples/projects-v2-item-simple" + pull_request_with_id: + summary: Response for adding a pull request using its unique ID + value: + "$ref": "#/components/examples/projects-v2-item-simple" + issue_with_nwo: + summary: Response for adding an issue using repository owner, name, + and issue number + value: + "$ref": "#/components/examples/projects-v2-item-simple" + pull_request_with_nwo: + summary: Response for adding a pull request using repository owner, + name, and PR number + value: + "$ref": "#/components/examples/projects-v2-item-simple" '304': "$ref": "#/components/responses/not_modified" '403': @@ -111549,7 +111554,7 @@ components: example: 8 type: integer user: - "$ref": "#/components/schemas/simple-user" + "$ref": "#/components/schemas/nullable-simple-user" body: description: The text of the comment. example: We should probably include a check for null values here. diff --git a/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json b/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json index 614ab4185..9c63e085d 100644 --- a/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json +++ b/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json @@ -378165,7 +378165,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -398583,7 +398584,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -399118,7 +399120,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -399692,7 +399695,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -409273,7 +409277,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -409894,7 +409899,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -410557,7 +410563,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", diff --git a/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml b/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml index 28833ddcb..d82650cc6 100644 --- a/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml +++ b/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml @@ -68490,7 +68490,13 @@ paths: description: The comment ID to reply to. example: 8 type: integer - user: *19 + user: + title: Simple User + description: A GitHub user. + type: object + properties: *17 + required: *18 + nullable: true body: description: The text of the comment. example: We should probably include a check for null diff --git a/descriptions/ghes-3.14/dereferenced/ghes-3.14.deref.json b/descriptions/ghes-3.14/dereferenced/ghes-3.14.deref.json index 614ab4185..9c63e085d 100644 --- a/descriptions/ghes-3.14/dereferenced/ghes-3.14.deref.json +++ b/descriptions/ghes-3.14/dereferenced/ghes-3.14.deref.json @@ -378165,7 +378165,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -398583,7 +398584,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -399118,7 +399120,8 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, "body": { "description": "The text of the comment.", @@ -399692,{"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}