Skip to content

Instantly share code, notes, and snippets.

@sleekweasel
Created March 17, 2025 14:45
Show Gist options
  • Save sleekweasel/bd91330c7c437d1641a52761d18d8d60 to your computer and use it in GitHub Desktop.
Save sleekweasel/bd91330c7c437d1641a52761d18d8d60 to your computer and use it in GitHub Desktop.
Section of the GitHub OpenAPI definition that produces empty data classes for Kotlin.
{
"openapi": "3.0.3",
"info": {
"version": "1.1.4",
"title": "GitHub v3 REST API",
"description": "GitHub's v3 REST API.",
"license": {
"name": "MIT",
"url": "https://spdx.org/licenses/MIT"
},
"termsOfService": "https://docs.github.com/articles/github-terms-of-service",
"contact": {
"name": "Support",
"url": "https://support.github.com/contact?tags=dotcom-rest-api"
},
"x-github-plan": "api.github.com"
},
"servers": [
{
"url": "https://api.github.com"
}
],
"externalDocs": {
"description": "GitHub v3 REST API",
"url": "https://docs.github.com/rest/"
},
"paths": {
"/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": {
"post": {
"summary": "Request reviewers for a pull request",
"description": "Requests reviews for a pull request from a given set of users and/or teams.\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"",
"tags": [
"pulls"
],
"operationId": "pulls/request-reviewers",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request"
},
"parameters": [
{
"name": "owner",
"description": "The account owner of the repository. The name is not case sensitive.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "repo",
"description": "The name of the repository without the `.git` extension. The name is not case sensitive.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "pull_number",
"description": "The number that identifies the pull request.",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"reviewers": {
"type": "array",
"description": "An array of user `login`s that will be requested.",
"items": {
"type": "string"
}
},
"team_reviewers": {
"type": "array",
"description": "An array of team `slug`s that will be requested.",
"items": {
"type": "string"
}
}
},
"anyOf": [
{
"required": [
"reviewers"
]
},
{
"required": [
"team_reviewers"
]
}
]
},
"examples": {
"default": {
"value": {
"reviewers": [
"octocat",
"hubot",
"other_user"
],
"team_reviewers": [
"justice-league"
]
}
}
}
}
}
},
"responses": {
"422": {
"description": "Unprocessable Entity if user is not a collaborator"
}
},
"x-github": {
"triggersNotification": true,
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "pulls",
"subcategory": "review-requests"
}
}
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment