Skip to content

Update OpenAPI 3.0 Descriptions #6001

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Open
github-openapi-bot wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update OpenAPI 3.0 Descriptions #6001

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
232 changes: 0 additions & 232 deletions descriptions/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 @@ -63028,186 +63028,6 @@
}
}
},
"/repos/{owner}/{repo}/tags/protection": {
"get": {
"summary": "Closing down - List tag protection states for a repository",
"description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the \"[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)\" endpoint instead.\n\nThis returns the tag protection states of a repository.\n\nThis information is only available to repository administrators.",
"tags": [
"repos"
],
"operationId": "repos/list-tag-protection",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository"
},
"parameters": [
{
"$ref": "#/components/parameters/owner"
},
{
"$ref": "#/components/parameters/repo"
}
],
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tag-protection"
}
},
"examples": {
"default": {
"$ref": "#/components/examples/tag-protection-items"
}
}
}
}
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/not_found"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "repos",
"subcategory": "tags",
"deprecationDate": "2024-05-29",
"removalDate": "2024-08-30"
},
"deprecated": true
},
"post": {
"summary": "Closing down - Create a tag protection state for a repository",
"description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the \"[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)\" endpoint instead.\n\nThis creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.",
"tags": [
"repos"
],
"operationId": "repos/create-tag-protection",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository"
},
"parameters": [
{
"$ref": "#/components/parameters/owner"
},
{
"$ref": "#/components/parameters/repo"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"pattern": {
"type": "string",
"description": "An optional glob pattern to match against when enforcing tag protection."
}
},
"required": [
"pattern"
]
},
"examples": {
"default": {
"value": {
"pattern": "v1.*"
}
}
}
}
}
},
"responses": {
"201": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tag-protection"
},
"examples": {
"default": {
"$ref": "#/components/examples/tag-protection"
}
}
}
}
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/not_found"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "repos",
"subcategory": "tags",
"deprecationDate": "2024-05-29",
"removalDate": "2024-08-30"
},
"deprecated": true
}
},
"/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": {
"delete": {
"summary": "Closing down - Delete a tag protection state for a repository",
"description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the \"[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)\" endpoint instead.\n\nThis deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.",
"tags": [
"repos"
],
"operationId": "repos/delete-tag-protection",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository"
},
"parameters": [
{
"$ref": "#/components/parameters/owner"
},
{
"$ref": "#/components/parameters/repo"
},
{
"$ref": "#/components/parameters/tag-protection-id"
}
],
"responses": {
"204": {
"description": "Response"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/not_found"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "repos",
"subcategory": "tags",
"deprecationDate": "2024-05-29",
"removalDate": "2024-08-30"
},
"deprecated": true
}
},
"/repos/{owner}/{repo}/tarball/{ref}": {
"get": {
"summary": "Download a repository archive (tar)",
Expand Down Expand Up @@ -134256,36 +134076,6 @@
"tarball_url"
]
},
"tag-protection": {
"title": "Tag protection",
"description": "Tag protection",
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 2
},
"created_at": {
"type": "string",
"example": "2011-01-26T19:01:12Z"
},
"updated_at": {
"type": "string",
"example": "2011-01-26T19:01:12Z"
},
"enabled": {
"type": "boolean",
"example": true
},
"pattern": {
"type": "string",
"example": "v1.*"
}
},
"required": [
"pattern"
]
},
"topic": {
"title": "Topic",
"description": "A topic aggregates entities that are related to a subject.",
Expand Down Expand Up @@ -308633,19 +308423,6 @@
}
]
},
"tag-protection-items": {
"value": [
{
"id": 2,
"pattern": "v1.*"
}
]
},
"tag-protection": {
"value": {
"enabled": true
}
},
"topic": {
"value": {
"names": [
Expand Down Expand Up @@ -316099,15 +315876,6 @@
"type": "integer"
}
},
"tag-protection-id": {
"name": "tag_protection_id",
"description": "The unique identifier of the tag protection.",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
"per": {
"name": "per",
"description": "The time frame to display results for.",
Expand Down
Loading