Skip to content

Update OpenAPI 3.1 Descriptions #1673

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

Merged
dinonuggies1 merged 1 commit into from
Oct 13, 2022
Merged

Update OpenAPI 3.1 Descriptions #1673

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
125 changes: 122 additions & 3 deletions descriptions-next/api.github.com/api.github.com.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19379,6 +19379,15 @@
},
{
"$ref": "#/components/parameters/page"
},
{
"name": "name",
"description": "Filters artifacts by exact match on their name field.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
Expand Down Expand Up @@ -58447,6 +58456,14 @@
"write"
]
},
"repository_announcement_banners": {
"type": "string",
"description": "The level of permission to grant the access token to view and manage announcement banners for a repository.",
"enum": [
"read",
"write"
]
},
"repository_hooks": {
"type": "string",
"description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.",
Expand Down Expand Up @@ -58543,6 +58560,14 @@
"write"
]
},
"organization_announcement_banners": {
"type": "string",
"description": "The level of permission to grant the access token to view and manage announcement banners for an organization.",
"enum": [
"read",
"write"
]
},
"organization_hooks": {
"type": "string",
"description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.",
Expand Down Expand Up @@ -86930,22 +86955,116 @@
"$ref": "#/components/schemas/simple-installation"
},
"merge_group": {
"title": "MergeGroup",
"type": "object",
"properties": {
"base_ref": {
"head_sha": {
"description": "The SHA of the merge group.",
"type": "string"
},
"head_ref": {
"description": "The full ref of the merge group.",
"type": "string"
},
"head_sha": {
"base_sha": {
"description": "The SHA of the merge group's parent commit.",
"type": "string"
},
"base_ref": {
"description": "The full ref of the branch the merge group will be merged into.",
"type": "string"
},
"head_commit": {
"title": "SimpleCommit",
"type": "object",
"properties": {
"author": {
"title": "Committer",
"description": "Metaproperties for Git author/committer information.",
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time"
},
"email": {
"type": [
"string",
"null"
],
"format": "email"
},
"name": {
"description": "The git author's name.",
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"email",
"name"
]
},
"committer": {
"title": "Committer",
"description": "Metaproperties for Git author/committer information.",
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time"
},
"email": {
"type": [
"string",
"null"
],
"format": "email"
},
"name": {
"description": "The git author's name.",
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"email",
"name"
]
},
"id": {
"type": "string"
},
"message": {
"type": "string"
},
"timestamp": {
"type": "string"
},
"tree_id": {
"type": "string"
}
},
"required": [
"id",
"tree_id",
"message",
"timestamp",
"author",
"committer"
]
}
},
"required": [
"head_sha",
"head_ref",
"base_ref"
"base_sha",
"base_ref",
"head_commit"
]
},
"organization": {
Expand Down
95 changes: 93 additions & 2 deletions descriptions-next/api.github.com/api.github.com.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13989,6 +13989,12 @@ paths:
- "$ref": "#/components/parameters/repo"
- "$ref": "#/components/parameters/per-page"
- "$ref": "#/components/parameters/page"
- name: name
description: Filters artifacts by exact match on their name field.
in: query
required: false
schema:
type: string
responses:
'200':
description: Response
Expand Down Expand Up @@ -42065,6 +42071,13 @@ components:
enum:
- read
- write
repository_announcement_banners:
type: string
description: The level of permission to grant the access token to view and
manage announcement banners for a repository.
enum:
- read
- write
repository_hooks:
type: string
description: The level of permission to grant the access token to manage
Expand Down Expand Up @@ -42149,6 +42162,13 @@ components:
enum:
- read
- write
organization_announcement_banners:
type: string
description: The level of permission to grant the access token to view and
manage announcement banners for an organization.
enum:
- read
- write
organization_hooks:
type: string
description: The level of permission to grant the access token to manage
Expand Down Expand Up @@ -62577,18 +62597,89 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
merge_group:
title: MergeGroup
type: object
properties:
base_ref:
head_sha:
description: The SHA of the merge group.
type: string
head_ref:
description: The full ref of the merge group.
type: string
head_sha:
base_sha:
description: The SHA of the merge group's parent commit.
type: string
base_ref:
description: The full ref of the branch the merge group will be merged
into.
type: string
head_commit:
title: SimpleCommit
type: object
properties:
author:
title: Committer
description: Metaproperties for Git author/committer information.
type: object
properties:
date:
type: string
format: date-time
email:
type:
- string
- 'null'
format: email
name:
description: The git author's name.
type: string
username:
type: string
required:
- email
- name
committer:
title: Committer
description: Metaproperties for Git author/committer information.
type: object
properties:
date:
type: string
format: date-time
email:
type:
- string
- 'null'
format: email
name:
description: The git author's name.
type: string
username:
type: string
required:
- email
- name
id:
type: string
message:
type: string
timestamp:
type: string
tree_id:
type: string
required:
- id
- tree_id
- message
- timestamp
- author
- committer
required:
- head_sha
- head_ref
- base_sha
- base_ref
- head_commit
organization:
"$ref": "#/components/schemas/organization-simple"
repository:
Expand Down
Loading