Skip to content

Commit 0fb9cbe

Browse files
nickfloydnickfloyd
authored
Merge pull request #5583 from github/openapi-update-885e7e3c51c20bf4859b235031a27dfb2fe0c196b9c797ae4215b486c31abe6a
Update OpenAPI 3.0 Descriptions
2 parents dd32938 + c9054b7 commit 0fb9cbe

16 files changed

Lines changed: 24872 additions & 0 deletions

‎descriptions/api.github.com/api.github.com.2022-11-28.json‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73228,6 +73228,99 @@
7322873228
}
7322973229
}
7323073230
},
73231+
"/user/{user_id}/projectsV2/{project_number}/drafts": {
73232+
"post": {
73233+
"summary": "Create draft item for user owned project",
73234+
"description": "Create draft issue item for the specified user owned project.",
73235+
"tags": [
73236+
"projects"
73237+
],
73238+
"operationId": "projects/create-draft-item-for-authenticated-user",
73239+
"externalDocs": {
73240+
"description": "API method documentation",
73241+
"url": "https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project"
73242+
},
73243+
"parameters": [
73244+
{
73245+
"$ref": "#/components/parameters/user-id"
73246+
},
73247+
{
73248+
"$ref": "#/components/parameters/project-number"
73249+
}
73250+
],
73251+
"requestBody": {
73252+
"required": true,
73253+
"description": "Details of the draft item to create in the project.",
73254+
"content": {
73255+
"application/json": {
73256+
"schema": {
73257+
"type": "object",
73258+
"properties": {
73259+
"title": {
73260+
"type": "string",
73261+
"description": "The title of the draft issue item to create in the project."
73262+
},
73263+
"body": {
73264+
"type": "string",
73265+
"description": "The body content of the draft issue item to create in the project."
73266+
}
73267+
},
73268+
"required": [
73269+
"title"
73270+
]
73271+
},
73272+
"examples": {
73273+
"title": {
73274+
"summary": "Example with Sample Draft Issue Title",
73275+
"value": {
73276+
"title": "Sample Draft Issue Title"
73277+
}
73278+
},
73279+
"body": {
73280+
"summary": "Example with Sample Draft Issue Title and Body",
73281+
"value": {
73282+
"title": "Sample Draft Issue Title",
73283+
"body": "This is the body content of the draft issue."
73284+
}
73285+
}
73286+
}
73287+
}
73288+
}
73289+
},
73290+
"responses": {
73291+
"201": {
73292+
"description": "Response",
73293+
"content": {
73294+
"application/json": {
73295+
"schema": {
73296+
"$ref": "#/components/schemas/projects-v2-item-simple"
73297+
},
73298+
"examples": {
73299+
"draft_issue": {
73300+
"$ref": "#/components/examples/projects-v2-item-simple"
73301+
}
73302+
}
73303+
}
73304+
}
73305+
},
73306+
"304": {
73307+
"$ref": "#/components/responses/not_modified"
73308+
},
73309+
"403": {
73310+
"$ref": "#/components/responses/forbidden"
73311+
},
73312+
"401": {
73313+
"$ref": "#/components/responses/requires_authentication"
73314+
}
73315+
},
73316+
"x-github": {
73317+
"githubCloudOnly": false,
73318+
"enabledForGitHubApps": true,
73319+
"category": "projects",
73320+
"subcategory": "drafts"
73321+
}
73322+
}
73323+
},
7323173324
"/users": {
7323273325
"get": {
7323373326
"summary": "List users",
@@ -310709,6 +310802,15 @@
310709310802
],
310710310803
"default": "created"
310711310804
}
310805+
},
310806+
"user-id": {
310807+
"name": "user_id",
310808+
"description": "The unique identifier of the user.",
310809+
"in": "path",
310810+
"required": true,
310811+
"schema": {
310812+
"type": "string"
310813+
}
310712310814
}
310713310815
},
310714310816
"responses": {

‎descriptions/api.github.com/api.github.com.2022-11-28.yaml‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53180,6 +53180,68 @@ paths:
5318053180
enabledForGitHubApps: true
5318153181
category: users
5318253182
subcategory: users
53183+
"/user/{user_id}/projectsV2/{project_number}/drafts":
53184+
post:
53185+
summary: Create draft item for user owned project
53186+
description: Create draft issue item for the specified user owned project.
53187+
tags:
53188+
- projects
53189+
operationId: projects/create-draft-item-for-authenticated-user
53190+
externalDocs:
53191+
description: API method documentation
53192+
url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project
53193+
parameters:
53194+
- "$ref": "#/components/parameters/user-id"
53195+
- "$ref": "#/components/parameters/project-number"
53196+
requestBody:
53197+
required: true
53198+
description: Details of the draft item to create in the project.
53199+
content:
53200+
application/json:
53201+
schema:
53202+
type: object
53203+
properties:
53204+
title:
53205+
type: string
53206+
description: The title of the draft issue item to create in the
53207+
project.
53208+
body:
53209+
type: string
53210+
description: The body content of the draft issue item to create
53211+
in the project.
53212+
required:
53213+
- title
53214+
examples:
53215+
title:
53216+
summary: Example with Sample Draft Issue Title
53217+
value:
53218+
title: Sample Draft Issue Title
53219+
body:
53220+
summary: Example with Sample Draft Issue Title and Body
53221+
value:
53222+
title: Sample Draft Issue Title
53223+
body: This is the body content of the draft issue.
53224+
responses:
53225+
'201':
53226+
description: Response
53227+
content:
53228+
application/json:
53229+
schema:
53230+
"$ref": "#/components/schemas/projects-v2-item-simple"
53231+
examples:
53232+
draft_issue:
53233+
"$ref": "#/components/examples/projects-v2-item-simple"
53234+
'304':
53235+
"$ref": "#/components/responses/not_modified"
53236+
'403':
53237+
"$ref": "#/components/responses/forbidden"
53238+
'401':
53239+
"$ref": "#/components/responses/requires_authentication"
53240+
x-github:
53241+
githubCloudOnly: false
53242+
enabledForGitHubApps: true
53243+
category: projects
53244+
subcategory: drafts
5318353245
"/users":
5318453246
get:
5318553247
summary: List users
@@ -235996,6 +236058,13 @@ components:
235996236058
- created
235997236059
- updated
235998236060
default: created
236061+
user-id:
236062+
name: user_id
236063+
description: The unique identifier of the user.
236064+
in: path
236065+
required: true
236066+
schema:
236067+
type: string
235999236068
responses:
236000236069
validation_failed_simple:
236001236070
description: Validation failed, or the endpoint has been spammed.

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

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73228,6 +73228,99 @@
7322873228
}
7322973229
}
7323073230
},
73231+
"/user/{user_id}/projectsV2/{project_number}/drafts": {
73232+
"post": {
73233+
"summary": "Create draft item for user owned project",
73234+
"description": "Create draft issue item for the specified user owned project.",
73235+
"tags": [
73236+
"projects"
73237+
],
73238+
"operationId": "projects/create-draft-item-for-authenticated-user",
73239+
"externalDocs": {
73240+
"description": "API method documentation",
73241+
"url": "https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project"
73242+
},
73243+
"parameters": [
73244+
{
73245+
"$ref": "#/components/parameters/user-id"
73246+
},
73247+
{
73248+
"$ref": "#/components/parameters/project-number"
73249+
}
73250+
],
73251+
"requestBody": {
73252+
"required": true,
73253+
"description": "Details of the draft item to create in the project.",
73254+
"content": {
73255+
"application/json": {
73256+
"schema": {
73257+
"type": "object",
73258+
"properties": {
73259+
"title": {
73260+
"type": "string",
73261+
"description": "The title of the draft issue item to create in the project."
73262+
},
73263+
"body": {
73264+
"type": "string",
73265+
"description": "The body content of the draft issue item to create in the project."
73266+
}
73267+
},
73268+
"required": [
73269+
"title"
73270+
]
73271+
},
73272+
"examples": {
73273+
"title": {
73274+
"summary": "Example with Sample Draft Issue Title",
73275+
"value": {
73276+
"title": "Sample Draft Issue Title"
73277+
}
73278+
},
73279+
"body": {
73280+
"summary": "Example with Sample Draft Issue Title and Body",
73281+
"value": {
73282+
"title": "Sample Draft Issue Title",
73283+
"body": "This is the body content of the draft issue."
73284+
}
73285+
}
73286+
}
73287+
}
73288+
}
73289+
},
73290+
"responses": {
73291+
"201": {
73292+
"description": "Response",
73293+
"content": {
73294+
"application/json": {
73295+
"schema": {
73296+
"$ref": "#/components/schemas/projects-v2-item-simple"
73297+
},
73298+
"examples": {
73299+
"draft_issue": {
73300+
"$ref": "#/components/examples/projects-v2-item-simple"
73301+
}
73302+
}
73303+
}
73304+
}
73305+
},
73306+
"304": {
73307+
"$ref": "#/components/responses/not_modified"
73308+
},
73309+
"403": {
73310+
"$ref": "#/components/responses/forbidden"
73311+
},
73312+
"401": {
73313+
"$ref": "#/components/responses/requires_authentication"
73314+
}
73315+
},
73316+
"x-github": {
73317+
"githubCloudOnly": false,
73318+
"enabledForGitHubApps": true,
73319+
"category": "projects",
73320+
"subcategory": "drafts"
73321+
}
73322+
}
73323+
},
7323173324
"/users": {
7323273325
"get": {
7323373326
"summary": "List users",
@@ -310709,6 +310802,15 @@
310709310802
],
310710310803
"default": "created"
310711310804
}
310805+
},
310806+
"user-id": {
310807+
"name": "user_id",
310808+
"description": "The unique identifier of the user.",
310809+
"in": "path",
310810+
"required": true,
310811+
"schema": {
310812+
"type": "string"
310813+
}
310712310814
}
310713310815
},
310714310816
"responses": {

0 commit comments

Comments
 (0)