Skip to content

Commit

Permalink
Update OpenAPI Descriptions (github#25416)
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-openapi-bot
github-openapi-bot committed Feb 16, 2022
1 parent a11bb0d commit 0240435
Show file tree
Hide file tree
Showing 4 changed files with 871 additions and 0 deletions.
83 changes: 83 additions & 0 deletions lib/rest/static/decorated/api.github.com.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52977,6 +52977,89 @@
}
]
},
{
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/codeowners/errors",
"serverUrl": "https://api.github.com",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "ref",
"description": "A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository's default branch (e.g. `main`)",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"descriptionHTML": "<p>A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository's default branch (e.g. <code>main</code>)</p>"
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/codeowners/errors",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/codeowners/errors</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('GET /repos/{owner}/{repo}/codeowners/errors', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'GET /repos/{owner}/{repo}/codeowners/errors'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>\n})\n</code></pre>"
}
],
"summary": "List CODEOWNERS errors",
"description": "List any syntax errors that are detected in the CODEOWNERS\nfile.\n\nFor more information about the correct CODEOWNERS syntax,\nsee \"[About code owners](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).\"",
"tags": [
"repos"
],
"operationId": "repos/codeowners-errors",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/repos#list-codeowners-errors"
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"previews": [],
"category": "repos",
"subcategory": null
},
"slug": "list-codeowners-errors",
"category": "repos",
"categoryLabel": "Repos",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>List any syntax errors that are detected in the CODEOWNERS\nfile.</p>\n<p>For more information about the correct CODEOWNERS syntax,\nsee \"<a href=\"https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners\">About code owners</a>.\"</p>",
"responses": [
{
"httpStatusCode": "200",
"httpStatusMessage": "OK",
"description": "<p>Response</p>",
"payload": "<pre><code class=\"hljs language-json\"><span class=\"hljs-punctuation\">{</span>\n <span class=\"hljs-attr\">\"errors\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-punctuation\">[</span>\n <span class=\"hljs-punctuation\">{</span>\n <span class=\"hljs-attr\">\"line\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">3</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"column\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">1</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"kind\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"Invalid pattern\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"source\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"***/*.rb @monalisa\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"suggestion\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"Did you mean `**/*.rb`?\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"message\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"Invalid pattern on line 3: Did you mean `**/*.rb`?\\n\\n ***/*.rb @monalisa\\n ^\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"path\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\".github/CODEOWNERS\"</span>\n <span class=\"hljs-punctuation\">}</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-punctuation\">{</span>\n <span class=\"hljs-attr\">\"line\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">7</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"column\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">7</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"kind\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"Invalid owner\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"source\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"*.txt docs@\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"suggestion\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-keyword\">null</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"message\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"Invalid owner on line 7:\\n\\n *.txt docs@\\n ^\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"path\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\".github/CODEOWNERS\"</span>\n <span class=\"hljs-punctuation\">}</span>\n <span class=\"hljs-punctuation\">]</span>\n<span class=\"hljs-punctuation\">}</span>\n</code></pre>"
},
{
"httpStatusCode": "404",
"httpStatusMessage": "Not Found",
"description": "<p>Resource not found</p>"
}
]
},
{
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/codespaces",
Expand Down
Loading

0 comments on commit 0240435

Please sign in to comment.