UNPKG

@itentialopensource/adapter-github

Version:

This adapter integrates with system described as: github.

1,671 lines (1,638 loc) 631 kB
openapi: 3.0.0 info: title: GitHub description: > Powerful collaboration, code review, and code management for open source and private projects. contact: {} version: 'v3' servers: - url: https://api.github.com/ variables: {} - url: https://github.com/login/oauth variables: {} paths: /emojis: get: summary: Emojis_GET description: Lists all the emojis available to use on GitHub. operationId: Emojis_GET parameters: - name: Accept in: header description: Is used to set specified media type. style: simple schema: type: string responses: '200': description: OK headers: X-GitHub-Media-Type: description: > You can check the current version of media type in responses. content: text/plain: schema: type: string description: > You can check the current version of media type in responses. X-GitHub-Request-Id: content: text/plain: schema: type: string X-RateLimit-Limit: content: text/plain: schema: type: string X-RateLimit-Remaining: content: text/plain: schema: type: string X-RateLimit-Reset: content: text/plain: schema: type: string content: application/json: schema: type: object additionalProperties: type: string '403': description: >- API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details. headers: {} content: {} deprecated: false /events: get: summary: Events_GET description: List public events. operationId: Events_GET parameters: - name: Accept in: header description: Is used to set specified media type. style: simple schema: type: string responses: '200': description: OK headers: X-GitHub-Media-Type: description: > You can check the current version of media type in responses. content: text/plain: schema: type: string description: > You can check the current version of media type in responses. X-GitHub-Request-Id: content: text/plain: schema: type: string X-RateLimit-Limit: content: text/plain: schema: type: string X-RateLimit-Remaining: content: text/plain: schema: type: string X-RateLimit-Reset: content: text/plain: schema: type: string content: application/json: schema: type: array items: $ref: '#/components/schemas/event' description: OK '403': description: >- API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details. headers: {} content: {} deprecated: false /feeds: get: summary: Feeds_GET description: > List Feeds. GitHub provides several timeline resources in Atom format. The Feeds API lists all the feeds available to the authenticating user. operationId: Feeds_GET parameters: - name: Accept in: header description: Is used to set specified media type. style: simple schema: type: string responses: '200': description: OK headers: X-GitHub-Media-Type: description: > You can check the current version of media type in responses. content: text/plain: schema: type: string description: > You can check the current version of media type in responses. X-GitHub-Request-Id: content: text/plain: schema: type: string X-RateLimit-Limit: content: text/plain: schema: type: string X-RateLimit-Remaining: content: text/plain: schema: type: string X-RateLimit-Reset: content: text/plain: schema: type: string content: application/json: schema: $ref: '#/components/schemas/feeds' '403': description: >- API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details. headers: {} content: {} deprecated: false /gists: get: summary: Gists_GET description: > List the authenticated user's gists or if called anonymously, this will return all public gists. operationId: Gists_GET parameters: - name: since in: query description: >- Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned. style: form explode: true schema: type: string - name: Accept in: header description: Is used to set specified media type. style: simple schema: type: string responses: '200': description: OK headers: X-GitHub-Media-Type: description: > You can check the current version of media type in responses. content: text/plain: schema: type: string description: > You can check the current version of media type in responses. X-GitHub-Request-Id: content: text/plain: schema: type: string X-RateLimit-Limit: content: text/plain: schema: type: string X-RateLimit-Remaining: content: text/plain: schema: type: string X-RateLimit-Reset: content: text/plain: schema: type: string content: application/json: schema: type: array items: $ref: '#/components/schemas/gist1' description: OK '403': description: >- API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details. headers: {} content: {} deprecated: false post: summary: Gists_POST description: Create a gist. operationId: Gists_POST parameters: - name: Accept in: header description: Is used to set specified media type. style: simple schema: type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/postGist' required: true responses: '201': description: Created headers: X-GitHub-Media-Type: description: > You can check the current version of media type in responses. content: text/plain: schema: type: string description: > You can check the current version of media type in responses. X-GitHub-Request-Id: content: text/plain: schema: type: string X-RateLimit-Limit: content: text/plain: schema: type: string X-RateLimit-Remaining: content: text/plain: schema: type: string X-RateLimit-Reset: content: text/plain: schema: type: string content: application/json: schema: $ref: '#/components/schemas/gist' '403': description: >- API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details. headers: {} content: {} deprecated: false /gists/public: get: summary: GistsPublic_GET description: List all public gists. operationId: GistsPublic_GET parameters: - name: since in: query description: >- Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned. style: form explode: true schema: type: string - name: Accept in: header description: Is used to set specified media type. style: simple schema: type: string responses: '200': description: OK headers: X-GitHub-Media-Type: description: > You can check the current version of media type in responses. content: text/plain: schema: type: string description: > You can check the current version of media type in responses. X-GitHub-Request-Id: content: text/plain: schema: type: string X-RateLimit-Limit: content: text/plain: schema: type: string X-RateLimit-Remaining: content: text/plain: schema: type: string X-RateLimit-Reset: content: text/plain: schema: type: string content: application/json: schema: type: array items: $ref: '#/components/schemas/gist1' description: OK '403': description: >- API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details. headers: {} content: {} deprecated: false /gists/starred: get: summary: GistsStarred_GET description: List the authenticated user's starred gists. operationId: GistsStarred_GET parameters: - name: since in: query description: >- Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned. style: form explode: true schema: type: string - name: Accept in: header description: Is used to set specified media type. style: simple schema: type: string responses: '200': description: OK headers: X-GitHub-Media-Type: description: > You can check the current version of media type in responses. content: text/plain: schema: type: string description: > You can check the current version of media type in responses. X-GitHub-Request-Id: content: text/plain: schema: type: string X-RateLimit-Limit: content: text/plain: schema: type: string X-RateLimit-Remaining: content: text/plain: schema: type: string X-RateLimit-Reset: content: text/plain: schema: type: string content: application/json: schema: type: array items: $ref: '#/components/schemas/gist1' description: OK '403': description: >- API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details. headers: {} content: {} deprecated: false /gists/{id}: delete: summary: GistsById_DELETE description: Delete a gist. operationId: GistsById_DELETE parameters: - name: id in: path description: Id of gist. required: true style: simple schema: type: integer format: int32 - name: Accept in: header description: Is used to set specified media type. style: simple schema: type: string responses: '204': description: No content. headers: X-GitHub-Media-Type: description: > You can check the current version of media type in responses. content: text/plain: schema: type: string description: > You can check the current version of media type in responses. X-GitHub-Request-Id: content: text/plain: schema: type: string X-RateLimit-Limit: content: text/plain: schema: type: string X-RateLimit-Remaining: content: text/plain: schema: type: string X-RateLimit-Reset: content: text/plain: schema: type: string content: {} '403': description: >- API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details. headers: {} content: {} deprecated: false get: summary: GistsById_GET description: Get a single gist. operationId: GistsById_GET parameters: - name: id in: path description: Id of gist. required: true style: simple schema: type: integer format: int32 - name: Accept in: header description: Is used to set specified media type. style: simple schema: type: string responses: '200': description: OK headers: X-GitHub-Media-Type: description: > You can check the current version of media type in responses. content: text/plain: schema: type: string description: > You can check the current version of media type in responses. X-GitHub-Request-Id: content: text/plain: schema: type: string X-RateLimit-Limit: content: text/plain: schema: type: string X-RateLimit-Remaining: content: text/plain: schema: type: string X-RateLimit-Reset: content: text/plain: schema: type: string content: application/json: schema: $ref: '#/components/schemas/gist' '403': description: >- API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details. headers: {} content: {} deprecated: false patch: summary: GistsById_PATCH description: Edit a gist. operationId: GistsById_PATCH parameters: - name: id in: path description: Id of gist. required: true style: simple schema: type: integer format: int32 - name: Accept in: header description: Is used to set specified media type. style: simple schema: type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/patchGist' required: true responses: '200': description: OK headers: X-GitHub-Media-Type: description: > You can check the current version of media type in responses. content: text/plain: schema: type: string description: > You can check the current version of media type in responses. X-GitHub-Request-Id: content: text/plain: schema: type: string X-RateLimit-Limit: content: text/plain: schema: type: string X-RateLimit-Remaining: content: text/plain: schema: type: string X-RateLimit-Reset: content: text/plain: schema: type: string content: application/json: schema: $ref: '#/components/schemas/gist' '403': description: >- API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details. headers: {} content: {} deprecated: false /gists/{id}/comments: get: summary: GistsCommentsById_GET description: List comments on a gist. operationId: GistsCommentsById_GET parameters: - name: id in: path description: Id of gist. required: true style: simple schema: type: integer format: int32 - name: Accept in: header description: Is used to set specified media type. style: simple schema: type: string responses: '200': description: OK headers: X-GitHub-Media-Type: description: > You can check the current version of media type in responses. content: text/plain: schema: type: string description: > You can check the current version of media type in responses. X-GitHub-Request-Id: content: text/plain: schema: type: string X-RateLimit-Limit: content: text/plain: schema: type: string X-RateLimit-Remaining: content: text/plain: schema: type: string X-RateLimit-Reset: content: text/plain: schema: type: string content: application/json: schema: type: array items: $ref: '#/components/schemas/comments2' description: OK '403': description: >- API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details. headers: {} content: {} deprecated: false post: summary: GistsCommentsById_POST description: Create a commen operationId: GistsCommentsById_POST parameters: - name: id in: path description: Id of gist. required: true style: simple schema: type: integer format: int32 - name: Accept in: header description: Is used to set specified media type. style: simple schema: type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/commentBody' required: true responses: '201': description: Created headers: X-GitHub-Media-Type: description: > You can check the current version of media type in responses. content: text/plain: schema: type: string description: > You can check the current version of media type in responses. X-GitHub-Request-Id: content: text/plain: schema: type: string X-RateLimit-Limit: content: text/plain: schema: type: string X-RateLimit-Remaining: content: text/plain: schema: type: string X-RateLimit-Reset: content: text/plain: schema: type: string content: application/json: schema: $ref: '#/components/schemas/comment' '403': description: >- API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details. headers: {} content: {} deprecated: false /gists/{id}/comments/{commentId}: delete: summary: GistsCommentsByIdAndCommentId_DELETE description: Delete a comment. operationId: GistsCommentsByIdAndCommentId_DELETE parameters: - name: id in: path description: Id of gist. required: true style: simple schema: type: integer format: int32 - name: commentId in: path description: Id of comment. required: true style: simple schema: type: integer format: int32 - name: Accept in: header description: Is used to set specified media type. style: simple schema: type: string responses: '204': description: No content. headers: X-GitHub-Media-Type: description: > You can check the current version of media type in responses. content: text/plain: schema: type: string description: > You can check the current version of media type in responses. X-GitHub-Request-Id: content: text/plain: schema: type: string X-RateLimit-Limit: content: text/plain: schema: type: string X-RateLimit-Remaining: content: text/plain: schema: type: string X-RateLimit-Reset: content: text/plain: schema: type: string content: {} '403': description: >- API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details. headers: {} content: {} deprecated: false get: summary: GistsCommentsByIdAndCommentId_GET description: Get a single comment. operationId: GistsCommentsByIdAndCommentId_GET parameters: - name: id in: path description: Id of gist. required: true style: simple schema: type: integer format: int32 - name: commentId in: path description: Id of comment. required: true style: simple schema: type: integer format: int32 - name: Accept in: header description: Is used to set specified media type. style: simple schema: type: string responses: '200': description: OK headers: X-GitHub-Media-Type: description: > You can check the current version of media type in responses. content: text/plain: schema: type: string description: > You can check the current version of media type in responses. X-GitHub-Request-Id: content: text/plain: schema: type: string X-RateLimit-Limit: content: text/plain: schema: type: string X-RateLimit-Remaining: content: text/plain: schema: type: string X-RateLimit-Reset: content: text/plain: schema: type: string content: application/json: schema: $ref: '#/components/schemas/comment' '403': description: >- API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details. headers: {} content: {} deprecated: false patch: summary: GistsCommentsByIdAndCommentId_PATCH description: Edit a comment. operationId: GistsCommentsByIdAndCommentId_PATCH parameters: - name: id in: path description: Id of gist. required: true style: simple schema: type: integer format: int32 - name: commentId in: path description: Id of comment. required: true style: simple schema: type: integer format: int32 - name: Accept in: header description: Is used to set specified media type. style: simple schema: type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/comment' required: true responses: '200': description: OK headers: X-GitHub-Media-Type: description: > You can check the current version of media type in responses. content: text/plain: schema: type: string description: > You can check the current version of media type in responses. X-GitHub-Request-Id: content: text/plain: schema: type: string X-RateLimit-Limit: content: text/plain: schema: type: string X-RateLimit-Remaining: content: text/plain: schema: type: string X-RateLimit-Reset: content: text/plain: schema: type: string content: application/json: schema: $ref: '#/components/schemas/comment' '403': description: >- API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details. headers: {} content: {} deprecated: false /gists/{id}/forks: post: summary: GistsForksById_POST description: Fork a gist. operationId: GistsForksById_POST parameters: - name: id in: path description: Id of gist. required: true style: simple schema: type: integer format: int32 - name: Accept in: header description: Is used to set specified media type. style: simple schema: type: string responses: '204': description: Exists. headers: X-GitHub-Media-Type: description: > You can check the current version of media type in responses. content: text/plain: schema: type: string description: > You can check the current version of media type in responses. X-GitHub-Request-Id: content: text/plain: schema: type: string X-RateLimit-Limit: content: text/plain: schema: type: string X-RateLimit-Remaining: content: text/plain: schema: type: string X-RateLimit-Reset: content: text/plain: schema: type: string content: {} '403': description: >- API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details. headers: {} content: {} '404': description: Not exists. headers: {} content: {} deprecated: false /gists/{id}/star: delete: summary: GistsStarById_DELETE description: Unstar a gist. operationId: GistsStarById_DELETE parameters: - name: id in: path description: Id of gist. required: true style: simple schema: type: integer format: int32 - name: Accept in: header description: Is used to set specified media type. style: simple schema: type: string responses: '204': description: Item removed. headers: X-GitHub-Media-Type: description: > You can check the current version of media type in responses. content: text/plain: schema: type: string description: > You can check the current version of media type in responses. X-GitHub-Request-Id: content: text/plain: schema: type: string X-RateLimit-Limit: content: text/plain: schema: type: string X-RateLimit-Remaining: content: text/plain: schema: type: string X-RateLimit-Reset: content: text/plain: schema: type: string content: {} '403': description: >- API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details. headers: {} content: {} deprecated: false get: summary: GistsStarById_GET description: Check if a gist is starred. operationId: GistsStarById_GET parameters: - name: id in: path description: Id of gist. required: true style: simple schema: type: integer format: int32 - name: Accept in: header description: Is used to set specified media type. style: simple schema: type: string responses: '204': description: Exists. headers: X-GitHub-Media-Type: description: > You can check the current version of media type in responses. content: text/plain: schema: type: string description: > You can check the current version of media type in responses. X-GitHub-Request-Id: content: text/plain: schema: type: string X-RateLimit-Limit: content: text/plain: schema: type: string X-RateLimit-Remaining: content: text/plain: schema: type: string X-RateLimit-Reset: content: text/plain: schema: type: string content: {} '403': description: >- API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details. headers: {} content: {} '404': description: Not exists. headers: {} content: {} deprecated: false put: summary: GistsStarById_PUT description: Star a gist. operationId: GistsStarById_PUT parameters: - name: id in: path description: Id of gist. required: true style: simple schema: type: integer format: int32 - name: Accept in: header description: Is used to set specified media type. style: simple schema: type: string responses: '204': description: Starred. headers: X-GitHub-Media-Type: description: > You can check the current version of media type in responses. content: text/plain: schema: type: string description: > You can check the current version of media type in responses. X-GitHub-Request-Id: content: text/plain: schema: type: string X-RateLimit-Limit: content: text/plain: schema: type: string X-RateLimit-Remaining: content: text/plain: schema: type: string X-RateLimit-Reset: content: text/plain: schema: type: string content: {} '403': description: >- API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details. headers: {} content: {} deprecated: false /gitignore/templates: get: summary: GitignoreTemplates_GET description: > Listing available templates. List all templates available to pass as an option when creating a repository. operationId: GitignoreTemplates_GET parameters: - name: Accept in: header description: Is used to set specified media type. style: simple schema: type: string responses: '200': description: OK headers: X-GitHub-Media-Type: description: > You can check the current version of media type in responses. content: text/plain: schema: type: string description: > You can check the current version of media type in responses. X-GitHub-Request-Id: content: text/plain: schema: type: string X-RateLimit-Limit: content: text/plain: schema: type: string X-RateLimit-Remaining: content: text/plain: schema: type: string X-RateLimit-Reset: content: text/plain: schema: type: string content: text/plain: schema: type: object description: OK '403': description: >- API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details. headers: {} content: {} deprecated: false /gitignore/templates/{language}: get: summary: GitignoreTemplatesByLanguage_GET description: Get a single template. operationId: GitignoreTemplatesByLanguage_GET parameters: - name: language in: path description: '' required: true style: simple schema: type: string - name: Accept in: header description: Is used to set specified media type. style: simple schema: type: string responses: '200': description: OK headers: X-GitHub-Media-Type: description: > You can check the current version of media type in responses. content: text/plain: schema: type: string description: > You can check the current version of media type in responses. X-GitHub-Request-Id: content: text/plain: schema: type: string X-RateLimit-Limit: content: text/plain: schema: type: string X-RateLimit-Remaining: content: text/plain: schema: type: string X-RateLimit-Reset: content: text/plain: schema: type: string content: application/json: schema: $ref: '#/components/schemas/gitignore-lang' '403': description: >- API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details. headers: {} content: {} deprecated: false /issues: get: summary: Issues_GET description: > List issues. List all issues across all the authenticated user's visible repositories. operationId: Issues_GET parameters: - name: filter in: query description: >- Issues assigned to you / created by you / mentioning you / you're subscribed to updates for / All issues the authenticated user can see required: true style: form explode: true schema: allOf: - $ref: '#/components/schemas/filter' - description: >- Issues assigned to you / created by you / mentioning you / you're subscribed to updates for / All issues the authenticated user can see - name: state in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/State' - name: labels in: query description: String list of comma separated Label names. Example - bug,ui,@high. required: true style: form explode: true schema: type: string - name: sort in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/sort' - name: direction in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/direction' - name: since in: query description: >- Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only issues updated at or after this time are returned. style: form explode: true schema: type: string - name: Accept in: header description: Is used to set specified media type. style: simple schema: type: string responses: '200': description: OK headers: X-GitHub-Media-Type: description: > You can check the current version of media type in responses. content: text/plain: schema: type: string description: > You can check the current version of media type in responses. X-GitHub-Request-Id: content: text/plain: schema: type: string X-RateLimit-Limit: content: text/plain: schema: type: string X-RateLimit-Remaining: content: text/plain: schema: type: string X-RateLimit-Reset: content: text/plain: schema: type: string content: application/json: schema: type: array items: $ref: '#/components/schemas/Issue1' description: OK '403': description: >- API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details. headers: {} content: {} deprecated: false /legacy/issues/search/{owner}/{repository}/{state}/{keyword}: get: summary: LegacyIssuesSearchStateKeywordByOwner_GET description: Find issues by state and keyword. operationId: LegacyIssuesSearchStateKeywordByOwner_GET parameters: - name: keyword in: path description: The search term. required: true style: simple schema: type: string - name: state in: path description: Indicates the state of the issues to return. Can be either open or closed. required: true style: simple schema: allOf: - $ref: '#/components/schemas/State' - description: Indicates the state of the issues to return. Can be either open or closed. - name: owner in: path description: '' required: true style: simple schema: type: string - name: repository in: path description: '' required: true style: simple schema: type: string - name: Accept in: header description: Is used to set specified media type. style: simple schema: type: string responses: '200': description: OK headers: X-GitHub-Media-Type: description: > You can check the current version of media type in responses. content: text/plain: schema: type: string description: > You can check the current version of media type in responses. X-GitHub-Request-Id: content: text/plain: schema: type: string X-RateLimit-Limit: content: text/plain: schema: type: string X-RateLimit-Remaining: content: text/plain: schema: type: string X-RateLimit-Reset: content: text/plain: schema: type: string content: application/json: schema: $ref: '#/components/schemas/search-issues-by-keyword' '403': description: >- API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details. headers: {} content: {} deprecated: true /legacy/repos/search/{keyword}: get: summary: LegacyReposSearchByKeyword_GET description: Find repositories by keyword. Note, this legacy method does not follow the v3 pagination pattern. This method returns up to 100 results per page and pages can be fetched using the start_page parameter. operationId: LegacyReposSearchByKeyword_GET parameters: - name: keyword in: path description: The search term required: true style: simple schema: type: string - name: order in: query description: The sort field. if sort param is provided. Can be either asc or desc. style: form explode: true schema: allOf: - $ref: '#/components/schemas/order' - description: The sort field. if sort param is provided. Can be either asc or desc. - name: language in: query description: Filter results by language style: form explode: true schema: type: string - name: start_page in: query description: The page number to fetch style: form explode: true schema: type: string - name: sort in: query description: 'The sort field. One of stars, forks, or updated. Default: results are sorted by best match.' style: form explode: true schema: allOf: - $ref: '#/components/schemas/sort1' - description: 'The sort field. One of stars, forks, or updated. Default: results are sorted by best match.' - name: Accept in: header description: Is used to set specified media type. style: simple schema: type: string responses: '200': description: OK headers: X-GitHub-Media-Type: description: > You can check the current