Skip to content

Update OpenAPI 3.1 Descriptions #5773

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
dinonuggies1 merged 1 commit into from
Dec 17, 2025
Merged

Update OpenAPI 3.1 Descriptions #5773

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

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
208 changes: 170 additions & 38 deletions descriptions-next/api.github.com/api.github.com.2022-11-28.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25374,42 +25374,97 @@
],
"requestBody": {
"required": true,
"description": "Details of the item to add to the project.",
"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.",
"content": {
"application/json": {
"schema": {
"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."
"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"
]
},
"id": {
"type": "integer",
"description": "The numeric ID of the issue or pull request to add to the project."
{
"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"
]
}
},
"required": [
"type",
"id"
]
},
"examples": {
"issue": {
"issue-with-id": {
"summary": "Add issue by database ID",
"value": {
"type": "Issue",
"id": 3
}
},
"pull_request": {
"pull_request-with-id": {
"summary": "Add pull request by database ID",
"value": {
"type": "PullRequest",
"id": 3
}
},
"issue-with-nwo": {
"summary": "Add issue by repository and number",
"value": {
"type": "Issue",
"owner": "octocat",
"repo": "hello-world",
"number": 42
}
},
"pull_request-with-nwo": {
"summary": "Add pull request by repository and number",
"value": {
"type": "PullRequest",
"owner": "octocat",
"repo": "hello-world",
"number": 123
}
}
}
}
Expand Down Expand Up @@ -76126,42 +76181,97 @@
],
"requestBody": {
"required": true,
"description": "Details of the item to add to the project.",
"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.",
"content": {
"application/json": {
"schema": {
"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."
"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"
]
},
"id": {
"type": "integer",
"description": "The numeric ID of the issue or pull request to add to the project."
{
"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"
]
}
},
"required": [
"type",
"id"
]
},
"examples": {
"issue": {
"issue-with-id": {
"summary": "Add issue by database ID",
"value": {
"type": "Issue",
"id": 3
}
},
"pull_request": {
"pull_request-with-id": {
"summary": "Add pull request by database ID",
"value": {
"type": "PullRequest",
"id": 3
}
},
"issue-with-nwo": {
"summary": "Add issue by repository and number",
"value": {
"type": "Issue",
"owner": "octocat",
"repo": "hello-world",
"number": 42
}
},
"pull_request-with-nwo": {
"summary": "Add pull request by repository and number",
"value": {
"type": "PullRequest",
"owner": "octocat",
"repo": "hello-world",
"number": 123
}
}
}
}
Expand Down Expand Up @@ -296146,6 +296256,11 @@
"state": "active",
"role": "admin",
"organization_url": "https://api.github.com/orgs/octocat",
"direct_membership": true,
"enterprise_teams_providing_indirect_membership": [
"ent:justice-league",
"ent:security-managers"
],
"organization": {
"login": "github",
"id": 1,
Expand Down Expand Up @@ -316780,6 +316895,8 @@
"state": "active",
"role": "admin",
"organization_url": "https://api.github.com/orgs/octocat",
"direct_membership": true,
"enterprise_teams_providing_indirect_membership": [],
"organization": {
"login": "github",
"id": 1,
Expand Down Expand Up @@ -316820,6 +316937,11 @@
"state": "pending",
"role": "admin",
"organization_url": "https://api.github.com/orgs/invitocat",
"direct_membership": false,
"enterprise_teams_providing_indirect_membership": [
"ent:justice-league",
"ent:security-managers"
],
"organization": {
"login": "github",
"id": 1,
Expand Down Expand Up @@ -316863,6 +316985,11 @@
"state": "pending",
"role": "admin",
"organization_url": "https://api.github.com/orgs/invitocat",
"direct_membership": true,
"enterprise_teams_providing_indirect_membership": [
"ent:justice-league",
"ent:security-managers"
],
"organization": {
"login": "github",
"id": 1,
Expand Down Expand Up @@ -316905,6 +317032,11 @@
"state": "active",
"role": "admin",
"organization_url": "https://api.github.com/orgs/octocat",
"direct_membership": true,
"enterprise_teams_providing_indirect_membership": [
"ent:justice-league",
"ent:security-managers"
],
"organization": {
"login": "github",
"id": 1,
Expand Down
Loading