Skip to content

Commit f3cbe95

Browse files
author
Marc-Andre Giroux
authored
Merge pull request #43 from github/def-import-2020-09-28
OpenAPI Updates
2 parents 97b36f1 + 80682c3 commit f3cbe95

24 files changed

+23757
-29960
lines changed

‎descriptions/api.github.com/api.github.com.json

+22-218
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "1.0.0-rc.1",
4+
"version": "1.0.0-rc.2",
55
"title": "GitHub v3 REST API",
66
"description": "GitHub's v3 REST API.",
77
"license": {
@@ -20364,11 +20364,7 @@
2036420364
"githubCloudOnly": false,
2036520365
"enabledForGitHubApps": true,
2036620366
"previews": [
20367-
{
20368-
"required": true,
20369-
"name": "antiope",
20370-
"note": "The Checks API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2018-05-07-new-checks-api-public-beta/) for full details. To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n```shell\napplication/vnd.github.antiope-preview+json\n```"
20371-
}
20367+
2037220368
],
2037320369
"category": "checks",
2037420370
"subcategory": "runs"
@@ -20419,11 +20415,7 @@
2041920415
"githubCloudOnly": false,
2042020416
"enabledForGitHubApps": true,
2042120417
"previews": [
20422-
{
20423-
"required": true,
20424-
"name": "antiope",
20425-
"note": "The Checks API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2018-05-07-new-checks-api-public-beta/) for full details. To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n```shell\napplication/vnd.github.antiope-preview+json\n```"
20426-
}
20418+
2042720419
],
2042820420
"category": "checks",
2042920421
"subcategory": "runs"
@@ -20692,11 +20684,7 @@
2069220684
"githubCloudOnly": false,
2069320685
"enabledForGitHubApps": true,
2069420686
"previews": [
20695-
{
20696-
"required": true,
20697-
"name": "antiope",
20698-
"note": "The Checks API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2018-05-07-new-checks-api-public-beta/) for full details. To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n```shell\napplication/vnd.github.antiope-preview+json\n```"
20699-
}
20687+
2070020688
],
2070120689
"category": "checks",
2070220690
"subcategory": "runs"
@@ -20761,11 +20749,7 @@
2076120749
"githubCloudOnly": false,
2076220750
"enabledForGitHubApps": true,
2076320751
"previews": [
20764-
{
20765-
"required": true,
20766-
"name": "antiope",
20767-
"note": "The Checks API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2018-05-07-new-checks-api-public-beta/) for full details. To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n```shell\napplication/vnd.github.antiope-preview+json\n```"
20768-
}
20752+
2076920753
],
2077020754
"category": "checks",
2077120755
"subcategory": "runs"
@@ -20834,11 +20818,7 @@
2083420818
"githubCloudOnly": false,
2083520819
"enabledForGitHubApps": true,
2083620820
"previews": [
20837-
{
20838-
"required": true,
20839-
"name": "antiope",
20840-
"note": "The Checks API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2018-05-07-new-checks-api-public-beta/) for full details. To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n```shell\napplication/vnd.github.antiope-preview+json\n```"
20841-
}
20821+
2084220822
],
2084320823
"category": "checks",
2084420824
"subcategory": "suites"
@@ -20927,11 +20907,7 @@
2092720907
"githubCloudOnly": false,
2092820908
"enabledForGitHubApps": true,
2092920909
"previews": [
20930-
{
20931-
"required": true,
20932-
"name": "antiope",
20933-
"note": "The Checks API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2018-05-07-new-checks-api-public-beta/) for full details. To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n```shell\napplication/vnd.github.antiope-preview+json\n```"
20934-
}
20910+
2093520911
],
2093620912
"category": "checks",
2093720913
"subcategory": "suites"
@@ -20982,11 +20958,7 @@
2098220958
"githubCloudOnly": false,
2098320959
"enabledForGitHubApps": true,
2098420960
"previews": [
20985-
{
20986-
"required": true,
20987-
"name": "antiope",
20988-
"note": "The Checks API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2018-05-07-new-checks-api-public-beta/) for full details. To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n```shell\napplication/vnd.github.antiope-preview+json\n```"
20989-
}
20961+
2099020962
],
2099120963
"category": "checks",
2099220964
"subcategory": "suites"
@@ -21079,11 +21051,7 @@
2107921051
"githubCloudOnly": false,
2108021052
"enabledForGitHubApps": true,
2108121053
"previews": [
21082-
{
21083-
"required": true,
21084-
"name": "antiope",
21085-
"note": "The Checks API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2018-05-07-new-checks-api-public-beta/) for full details. To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n```shell\napplication/vnd.github.antiope-preview+json\n```"
21086-
}
21054+
2108721055
],
2108821056
"category": "checks",
2108921057
"subcategory": "runs"
@@ -21122,11 +21090,7 @@
2112221090
"githubCloudOnly": false,
2112321091
"enabledForGitHubApps": true,
2112421092
"previews": [
21125-
{
21126-
"required": true,
21127-
"name": "antiope",
21128-
"note": "The Checks API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2018-05-07-new-checks-api-public-beta/) for full details. To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n```shell\napplication/vnd.github.antiope-preview+json\n```"
21129-
}
21093+
2113021094
],
2113121095
"category": "checks",
2113221096
"subcategory": "suites"
@@ -22854,11 +22818,7 @@
2285422818
"githubCloudOnly": false,
2285522819
"enabledForGitHubApps": true,
2285622820
"previews": [
22857-
{
22858-
"required": true,
22859-
"name": "antiope",
22860-
"note": "The Checks API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2018-05-07-new-checks-api-public-beta/) for full details. To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n```shell\napplication/vnd.github.antiope-preview+json\n```"
22861-
}
22821+
2286222822
],
2286322823
"category": "checks",
2286422824
"subcategory": "runs"
@@ -22950,11 +22910,7 @@
2295022910
"githubCloudOnly": false,
2295122911
"enabledForGitHubApps": true,
2295222912
"previews": [
22953-
{
22954-
"required": true,
22955-
"name": "antiope",
22956-
"note": "The Checks API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2018-05-07-new-checks-api-public-beta/) for full details. To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n```shell\napplication/vnd.github.antiope-preview+json\n```"
22957-
}
22913+
2295822914
],
2295922915
"category": "checks",
2296022916
"subcategory": "suites"
@@ -52086,166 +52042,6 @@
5208652042
}
5208752043
}
5208852044
},
52089-
"organization": {
52090-
"title": "Organization",
52091-
"description": "GitHub account for managing multiple users, teams, and repositories",
52092-
"type": "object",
52093-
"properties": {
52094-
"login": {
52095-
"description": "Unique login name of the organization",
52096-
"example": "new-org",
52097-
"type": "string"
52098-
},
52099-
"url": {
52100-
"description": "URL for the organization",
52101-
"example": "https://api.github.com/orgs/github",
52102-
"type": "string",
52103-
"format": "uri"
52104-
},
52105-
"id": {
52106-
"type": "integer"
52107-
},
52108-
"node_id": {
52109-
"type": "string"
52110-
},
52111-
"repos_url": {
52112-
"type": "string",
52113-
"format": "uri"
52114-
},
52115-
"events_url": {
52116-
"type": "string",
52117-
"format": "uri"
52118-
},
52119-
"hooks_url": {
52120-
"type": "string"
52121-
},
52122-
"issues_url": {
52123-
"type": "string"
52124-
},
52125-
"members_url": {
52126-
"type": "string"
52127-
},
52128-
"public_members_url": {
52129-
"type": "string"
52130-
},
52131-
"avatar_url": {
52132-
"type": "string"
52133-
},
52134-
"description": {
52135-
"type": "string",
52136-
"nullable": true
52137-
},
52138-
"blog": {
52139-
"description": "Display blog url for the organization",
52140-
"example": "blog.example-org.com",
52141-
"type": "string",
52142-
"format": "uri"
52143-
},
52144-
"html_url": {
52145-
"type": "string",
52146-
"format": "uri"
52147-
},
52148-
"name": {
52149-
"description": "Display name for the organization",
52150-
"example": "New Org",
52151-
"type": "string"
52152-
},
52153-
"company": {
52154-
"description": "Display company name for the organization",
52155-
"example": "Acme corporation",
52156-
"type": "string"
52157-
},
52158-
"location": {
52159-
"description": "Display location for the organization",
52160-
"example": "Berlin, Germany",
52161-
"type": "string"
52162-
},
52163-
"email": {
52164-
"description": "Display email for the organization",
52165-
"example": "[email protected]",
52166-
"type": "string",
52167-
"format": "email"
52168-
},
52169-
"has_organization_projects": {
52170-
"description": "Specifies if organization projects are enabled for this org",
52171-
"type": "boolean"
52172-
},
52173-
"has_repository_projects": {
52174-
"description": "Specifies if repository projects are enabled for repositories that belong to this org",
52175-
"type": "boolean"
52176-
},
52177-
"is_verified": {
52178-
"type": "boolean"
52179-
},
52180-
"public_repos": {
52181-
"type": "integer"
52182-
},
52183-
"public_gists": {
52184-
"type": "integer"
52185-
},
52186-
"followers": {
52187-
"type": "integer"
52188-
},
52189-
"following": {
52190-
"type": "integer"
52191-
},
52192-
"type": {
52193-
"type": "string"
52194-
},
52195-
"created_at": {
52196-
"type": "string",
52197-
"format": "date-time"
52198-
},
52199-
"updated_at": {
52200-
"type": "string",
52201-
"format": "date-time"
52202-
},
52203-
"plan": {
52204-
"type": "object",
52205-
"properties": {
52206-
"name": {
52207-
"type": "string"
52208-
},
52209-
"space": {
52210-
"type": "integer"
52211-
},
52212-
"private_repos": {
52213-
"type": "integer"
52214-
},
52215-
"filled_seats": {
52216-
"type": "integer"
52217-
},
52218-
"seats": {
52219-
"type": "integer"
52220-
}
52221-
}
52222-
}
52223-
},
52224-
"required": [
52225-
"login",
52226-
"url",
52227-
"id",
52228-
"node_id",
52229-
"repos_url",
52230-
"events_url",
52231-
"hooks_url",
52232-
"issues_url",
52233-
"members_url",
52234-
"public_members_url",
52235-
"avatar_url",
52236-
"description",
52237-
"html_url",
52238-
"has_organization_projects",
52239-
"has_repository_projects",
52240-
"public_repos",
52241-
"public_gists",
52242-
"followers",
52243-
"following",
52244-
"type",
52245-
"created_at",
52246-
"updated_at"
52247-
]
52248-
},
5224952045
"team-full": {
5225052046
"title": "Full Team",
5225152047
"description": "Groups of organization members that gives permissions on specified repositories.",
@@ -52335,7 +52131,7 @@
5233552131
"example": "2017-08-17T12:37:15Z"
5233652132
},
5233752133
"organization": {
52338-
"$ref": "#/components/schemas/organization"
52134+
"$ref": "#/components/schemas/organization-full"
5233952135
},
5234052136
"ldap_dn": {
5234152137
"description": "Distinguished Name (DN) that team maps to within LDAP environment",
@@ -83020,9 +82816,17 @@
8302082816
"workflow-id": {
8302182817
"name": "workflow_id",
8302282818
"in": "path",
82819+
"description": "The ID of the workflow. You can also pass the workflow file name as a string.",
8302382820
"required": true,
8302482821
"schema": {
83025-
"type": "integer"
82822+
"oneOf": [
82823+
{
82824+
"type": "integer"
82825+
},
82826+
{
82827+
"type": "string"
82828+
}
82829+
]
8302682830
}
8302782831
},
8302882832
"branch": {

0 commit comments

Comments
 (0)