Skip to content

Commit

Permalink
feat: add support for new request parameters in 3 APIs, plus descript…
Browse files Browse the repository at this point in the history
…ion tweaks (see #234)

WIP
  • Loading branch information
octokitbot committed Aug 30, 2022
1 parent bf99f8a commit 96862f5
Show file tree
Hide file tree
Showing 21 changed files with 5,240 additions and 357 deletions.
635 changes: 607 additions & 28 deletions cache/api.github.com.json

Large diffs are not rendered by default.

584 changes: 558 additions & 26 deletions cache/ghes-3.2.json

Large diffs are not rendered by default.

584 changes: 558 additions & 26 deletions cache/ghes-3.3.json

Large diffs are not rendered by default.

594 changes: 566 additions & 28 deletions cache/ghes-3.4.json

Large diffs are not rendered by default.

594 changes: 566 additions & 28 deletions cache/ghes-3.5.json

Large diffs are not rendered by default.

694 changes: 654 additions & 40 deletions cache/ghes-3.6.json

Large diffs are not rendered by default.

681 changes: 646 additions & 35 deletions cache/github.ae.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion packages/openapi-types-ghes-3.2/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@
"author": "Gregor Martynus (https://twitter.com/gr2m)",
"license": "MIT",
"octokit": {
"openapi-version": "7.5.0"
"openapi-version": "7.6.0"
}
}
162 changes: 145 additions & 17 deletions packages/openapi-types-ghes-3.2/types.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2719,10 +2719,11 @@ export interface paths {
* type](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent
* object format.
*
* **Note**:
* **Notes**:
* * To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.2/rest/reference/git#trees).
* * This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees
* API](https://docs.github.com/enterprise-server@3.2/rest/reference/git#get-a-tree).
* * Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.
* * This API supports files up to 1 megabyte in size.
*
* #### If the content is a directory
Expand Down Expand Up @@ -5208,11 +5209,6 @@ export interface components {
* @enum {string}
*/
contents?: "read" | "write";
/**
* @description The level of permission to grant the access token for custom roles management.
* @enum {string}
*/
organization_custom_roles?: "read" | "write";
/**
* @description The level of permission to grant the access token for deployments and deployment statuses.
* @enum {string}
Expand Down Expand Up @@ -8650,6 +8646,132 @@ export interface components {
repositories_url: string;
parent: components["schemas"]["nullable-team-simple"];
};
/**
* Team Organization
* @description Team Organization
*/
"team-organization": {
/** @example github */
login: string;
/** @example 1 */
id: number;
/** @example MDEyOk9yZ2FuaXphdGlvbjE= */
node_id: string;
/**
* Format: uri
* @example https://api.github.com/orgs/github
*/
url: string;
/**
* Format: uri
* @example https://api.github.com/orgs/github/repos
*/
repos_url: string;
/**
* Format: uri
* @example https://api.github.com/orgs/github/events
*/
events_url: string;
/** @example https://api.github.com/orgs/github/hooks */
hooks_url: string;
/** @example https://api.github.com/orgs/github/issues */
issues_url: string;
/** @example https://api.github.com/orgs/github/members{/member} */
members_url: string;
/** @example https://api.github.com/orgs/github/public_members{/member} */
public_members_url: string;
/** @example https://github.com/images/error/octocat_happy.gif */
avatar_url: string;
/** @example A great organization */
description: string | null;
/** @example github */
name?: string;
/** @example GitHub */
company?: string;
/**
* Format: uri
* @example https://github.com/blog
*/
blog?: string;
/** @example San Francisco */
location?: string;
/**
* Format: email
* @example octocat@github.com
*/
email?: string;
/** @example github */
twitter_username?: string | null;
/** @example true */
is_verified?: boolean;
/** @example true */
has_organization_projects: boolean;
/** @example true */
has_repository_projects: boolean;
/** @example 2 */
public_repos: number;
/** @example 1 */
public_gists: number;
/** @example 20 */
followers: number;
/** @example 0 */
following: number;
/**
* Format: uri
* @example https://github.com/octocat
*/
html_url: string;
/**
* Format: date-time
* @example 2008-01-14T04:33:35Z
*/
created_at: string;
/** @example Organization */
type: string;
/** @example 100 */
total_private_repos?: number;
/** @example 100 */
owned_private_repos?: number;
/** @example 81 */
private_gists?: number | null;
/** @example 10000 */
disk_usage?: number | null;
/** @example 8 */
collaborators?: number | null;
/**
* Format: email
* @example org@example.com
*/
billing_email?: string | null;
plan?: {
name: string;
space: number;
private_repos: number;
filled_seats?: number;
seats?: number;
};
default_repository_permission?: string | null;
/** @example true */
members_can_create_repositories?: boolean | null;
/** @example true */
two_factor_requirement_enabled?: boolean | null;
/** @example all */
members_allowed_repository_creation_type?: string;
/** @example true */
members_can_create_public_repositories?: boolean;
/** @example true */
members_can_create_private_repositories?: boolean;
/** @example true */
members_can_create_internal_repositories?: boolean;
/** @example true */
members_can_create_pages?: boolean;
/** @example true */
members_can_create_public_pages?: boolean;
/** @example true */
members_can_create_private_pages?: boolean;
/** Format: date-time */
updated_at: string;
};
/**
* Full Team
* @description Groups of organization members that gives permissions on specified repositories.
Expand Down Expand Up @@ -8715,7 +8837,7 @@ export interface components {
* @example 2017-08-17T12:37:15Z
*/
updated_at: string;
organization: components["schemas"]["organization-full"];
organization: components["schemas"]["team-organization"];
/**
* @description Distinguished Name (DN) that team maps to within LDAP environment
* @example uid=example,ou=users,dc=github,dc=com
Expand Down Expand Up @@ -25200,7 +25322,7 @@ export interface operations {
requestBody: {
content: {
"application/json": {
/** @description contexts parameter */
/** @description The name of the status checks */
contexts: string[];
};
};
Expand Down Expand Up @@ -25232,7 +25354,7 @@ export interface operations {
requestBody: {
content: {
"application/json": {
/** @description contexts parameter */
/** @description The name of the status checks */
contexts: string[];
};
};
Expand Down Expand Up @@ -25263,7 +25385,7 @@ export interface operations {
requestBody: {
content: {
"application/json": {
/** @description contexts parameter */
/** @description The name of the status checks */
contexts: string[];
};
};
Expand Down Expand Up @@ -25516,7 +25638,7 @@ export interface operations {
requestBody: {
content: {
"application/json": {
/** @description teams parameter */
/** @description The slug values for teams */
teams: string[];
};
};
Expand Down Expand Up @@ -25554,7 +25676,7 @@ export interface operations {
requestBody: {
content: {
"application/json": {
/** @description teams parameter */
/** @description The slug values for teams */
teams: string[];
};
};
Expand Down Expand Up @@ -25592,7 +25714,7 @@ export interface operations {
requestBody: {
content: {
"application/json": {
/** @description teams parameter */
/** @description The slug values for teams */
teams: string[];
};
};
Expand Down Expand Up @@ -25656,7 +25778,7 @@ export interface operations {
requestBody: {
content: {
"application/json": {
/** @description users parameter */
/** @description The username for users */
users: string[];
};
};
Expand Down Expand Up @@ -25694,7 +25816,7 @@ export interface operations {
requestBody: {
content: {
"application/json": {
/** @description users parameter */
/** @description The username for users */
users: string[];
};
};
Expand Down Expand Up @@ -25732,7 +25854,7 @@ export interface operations {
requestBody: {
content: {
"application/json": {
/** @description users parameter */
/** @description The username for users */
users: string[];
};
};
Expand Down Expand Up @@ -27607,10 +27729,11 @@ export interface operations {
* type](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent
* object format.
*
* **Note**:
* **Notes**:
* * To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.2/rest/reference/git#trees).
* * This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees
* API](https://docs.github.com/enterprise-server@3.2/rest/reference/git#get-a-tree).
* * Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.
* * This API supports files up to 1 megabyte in size.
*
* #### If the content is a directory
Expand Down Expand Up @@ -30044,6 +30167,11 @@ export interface operations {
* @enum {string}
*/
state?: "open" | "closed";
/**
* @description The reason for the current state
* @example not_planned
*/
state_reason?: string | null;
milestone?: (string | number) | null;
/** @description Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._ */
labels?: (
Expand Down
2 changes: 1 addition & 1 deletion packages/openapi-types-ghes-3.3/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@
"author": "Gregor Martynus (https://twitter.com/gr2m)",
"license": "MIT",
"octokit": {
"openapi-version": "7.5.0"
"openapi-version": "7.6.0"
}
}
Loading

0 comments on commit 96862f5

Please sign in to comment.