Skip to content

Commit 555184c

Browse files
authored
fix: descriptions updates (#62)
1 parent 66130bf commit 555184c

File tree

3 files changed

+35
-31
lines changed

3 files changed

+35
-31
lines changed

cache/openapi-schema.json

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "2.13.1",
4+
"version": "2.13.2",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -9404,7 +9404,7 @@
94049404
{ "$ref": "#/components/parameters/org" },
94059405
{
94069406
"name": "type",
9407-
"description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.",
9407+
"description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.",
94089408
"in": "query",
94099409
"required": false,
94109410
"schema": {
@@ -9482,7 +9482,7 @@
94829482
},
94839483
"post": {
94849484
"summary": "Create an organization repository",
9485-
"description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
9485+
"description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository",
94869486
"tags": ["repos"],
94879487
"operationId": "repos/create-in-org",
94889488
"externalDocs": {
@@ -9510,12 +9510,12 @@
95109510
},
95119511
"private": {
95129512
"type": "boolean",
9513-
"description": "Either `true` to create a private repository or `false` to create a public one.",
9513+
"description": "Whether the repository is private.",
95149514
"default": false
95159515
},
95169516
"visibility": {
95179517
"type": "string",
9518-
"description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.",
9518+
"description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.",
95199519
"enum": ["public", "private", "visibility", "internal"]
95209520
},
95219521
"has_issues": {
@@ -30221,7 +30221,7 @@
3022130221
"/repos/{template_owner}/{template_repo}/generate": {
3022230222
"post": {
3022330223
"summary": "Create a repository using a template",
30224-
"description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
30224+
"description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository",
3022530225
"tags": ["repos"],
3022630226
"operationId": "repos/create-using-template",
3022730227
"externalDocs": {
@@ -30321,7 +30321,7 @@
3032130321
"/repositories": {
3032230322
"get": {
3032330323
"summary": "List public repositories",
30324-
"description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.",
30324+
"description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.",
3032530325
"tags": ["repos"],
3032630326
"operationId": "repos/list-public",
3032730327
"externalDocs": {
@@ -36692,7 +36692,7 @@
3669236692
"parameters": [
3669336693
{
3669436694
"name": "visibility",
36695-
"description": "Can be one of `all`, `public`, or `private`.",
36695+
"description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.",
3669636696
"in": "query",
3669736697
"required": false,
3669836698
"schema": {
@@ -36713,7 +36713,7 @@
3671336713
},
3671436714
{
3671536715
"name": "type",
36716-
"description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.",
36716+
"description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.",
3671736717
"in": "query",
3671836718
"required": false,
3671936719
"schema": {
@@ -36778,7 +36778,7 @@
3677836778
},
3677936779
"post": {
3678036780
"summary": "Create a repository for the authenticated user",
36781-
"description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
36781+
"description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.",
3678236782
"tags": ["repos"],
3678336783
"operationId": "repos/create-for-authenticated-user",
3678436784
"externalDocs": {
@@ -36805,7 +36805,7 @@
3680536805
"type": "string"
3680636806
},
3680736807
"private": {
36808-
"description": "Whether the repository is private or public.",
36808+
"description": "Whether the repository is private.",
3680936809
"default": false,
3681036810
"type": "boolean"
3681136811
},
@@ -38149,7 +38149,7 @@
3814938149
"/users/{username}/repos": {
3815038150
"get": {
3815138151
"summary": "List repositories for a user",
38152-
"description": "Lists public repositories for the specified user.",
38152+
"description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.",
3815338153
"tags": ["repos"],
3815438154
"operationId": "repos/list-for-user",
3815538155
"externalDocs": {

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
]
5454
},
5555
"octokit": {
56-
"openapi-version": "2.13.1"
56+
"openapi-version": "2.13.2"
5757
},
5858
"@pika/pack": {
5959
"pipeline": [

0 commit comments

Comments
 (0)