openapi: 3.0.3 info: description: This documentation describes the Gitea API. title: Gitea API license: name: MIT url: http://opensource.org/licenses/MIT version: 1.27.0+dev-89-gf52b6f3315 x-converted-from: Swagger 2.0 x-source-url: https://demo.gitea.com/swagger.v1.json servers: - url: https://gitea.com/api/v1 - url: http://gitea.com/api/v1 paths: /admin/actions/jobs: get: tags: - admin summary: Lists All Jobs operationId: listAdminWorkflowJobs parameters: - name: status in: query description: workflow status (pending, queued, in_progress, failure, success, skipped) schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '400': description: '' '404': description: '' /admin/actions/runners: get: tags: - admin summary: Get All Runners operationId: getAdminRunners parameters: - name: disabled in: query description: filter by disabled status (true or false) schema: type: boolean responses: '200': description: '' '400': description: '' '404': description: '' /admin/actions/runners/registration-token: post: tags: - admin summary: Get a Global Actions Runner Registration Token operationId: adminCreateRunnerRegistrationToken responses: '200': description: '' /admin/actions/runners/{runner_id}: get: tags: - admin summary: Get a Global Runner operationId: getAdminRunner parameters: - name: runner_id in: path description: id of the runner required: true schema: type: string responses: '200': description: '' '400': description: '' '404': description: '' delete: tags: - admin summary: Delete a Global Runner operationId: deleteAdminRunner parameters: - name: runner_id in: path description: id of the runner required: true schema: type: string responses: '204': description: runner has been deleted '400': description: '' '404': description: '' patch: tags: - admin summary: Update a Global Runner operationId: updateAdminRunner parameters: - name: runner_id in: path description: id of the runner required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/EditActionRunnerOption' responses: '200': description: '' '400': description: '' '404': description: '' '422': description: '' /admin/actions/runs: get: tags: - admin summary: Lists All Runs operationId: listAdminWorkflowRuns parameters: - name: event in: query description: workflow event name schema: type: string - name: branch in: query description: workflow branch schema: type: string - name: status in: query description: workflow status (pending, queued, in_progress, failure, success, skipped) schema: type: string - name: actor in: query description: triggered by user schema: type: string - name: head_sha in: query description: triggering sha of the workflow run schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '400': description: '' '404': description: '' /admin/cron: get: tags: - admin summary: List Cron Tasks operationId: adminCronList parameters: - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '403': description: '' /admin/cron/{task}: post: tags: - admin summary: Run Cron Task operationId: adminCronRun parameters: - name: task in: path description: task to run required: true schema: type: string responses: '204': description: '' '404': description: '' /admin/emails: get: tags: - admin summary: List All Emails operationId: adminGetAllEmails parameters: - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '403': description: '' /admin/emails/search: get: tags: - admin summary: Search All Emails operationId: adminSearchEmails parameters: - name: q in: query description: keyword schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '403': description: '' /admin/hooks: get: tags: - admin summary: List System's Webhooks operationId: adminListHooks parameters: - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer - name: type in: query description: system, default or both kinds of webhooks schema: enum: - system - default - all type: string default: system responses: '200': description: '' post: tags: - admin summary: Create a Hook operationId: adminCreateHook requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateHookOption' responses: '201': description: '' /admin/hooks/{id}: get: tags: - admin summary: Get a Hook operationId: adminGetHook parameters: - name: id in: path description: id of the hook to get required: true schema: type: integer format: int64 responses: '200': description: '' delete: tags: - admin summary: Delete a Hook operationId: adminDeleteHook parameters: - name: id in: path description: id of the hook to delete required: true schema: type: integer format: int64 responses: '204': description: '' patch: tags: - admin summary: Update a Hook operationId: adminEditHook parameters: - name: id in: path description: id of the hook to update required: true schema: type: integer format: int64 requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/EditHookOption' responses: '200': description: '' /admin/orgs: get: tags: - admin summary: List All Organizations operationId: adminGetAllOrgs parameters: - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '403': description: '' /admin/unadopted: get: tags: - admin summary: List Unadopted Repositories operationId: adminUnadoptedList parameters: - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer - name: pattern in: query description: pattern of repositories to search for schema: type: string responses: '200': description: '' '403': description: '' /admin/unadopted/{owner}/{repo}: post: tags: - admin summary: Adopt Unadopted Files as a Repository operationId: adminAdoptRepository parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string responses: '204': description: '' '403': description: '' '404': description: '' delete: tags: - admin summary: Delete Unadopted Files operationId: adminDeleteUnadoptedRepository parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string responses: '204': description: '' '403': description: '' /admin/users: get: tags: - admin summary: Search Users According Filter Conditions operationId: adminSearchUsers parameters: - name: source_id in: query description: ID of the user's login source to search for schema: type: integer format: int64 - name: login_name in: query description: identifier of the user, provided by the external authenticator schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer - name: sort in: query description: sort users by attribute. Supported values are "name", "created", "updated" and "id". Default is "name" schema: type: string - name: order in: query description: sort order, either "asc" (ascending) or "desc" (descending). Default is "asc", ignored if "sort" is not specified. schema: type: string - name: q in: query description: search term (username, full name, email) schema: type: string - name: visibility in: query description: visibility filter. Supported values are "public", "limited" and "private". schema: type: string - name: is_active in: query description: filter active users schema: type: boolean - name: is_admin in: query description: filter admin users schema: type: boolean - name: is_restricted in: query description: filter restricted users schema: type: boolean - name: is_2fa_enabled in: query description: filter 2FA enabled users schema: type: boolean - name: is_prohibit_login in: query description: filter login prohibited users schema: type: boolean responses: '200': description: '' '403': description: '' '422': description: '' post: tags: - admin summary: Create a User operationId: adminCreateUser requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreateUserOption' responses: '201': description: '' '400': description: '' '403': description: '' '422': description: '' /admin/users/{username}: delete: tags: - admin summary: Delete a User operationId: adminDeleteUser parameters: - name: username in: path description: username of the user to delete required: true schema: type: string - name: purge in: query description: purge the user from the system completely schema: type: boolean responses: '204': description: '' '403': description: '' '404': description: '' '422': description: '' patch: tags: - admin summary: Edit an Existing User operationId: adminEditUser parameters: - name: username in: path description: username of the user whose data is to be edited required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/EditUserOption' responses: '200': description: '' '400': description: '' '403': description: '' '422': description: '' /admin/users/{username}/badges: get: tags: - admin summary: List a User's Badges operationId: adminListUserBadges parameters: - name: username in: path description: username of the user whose badges are to be listed required: true schema: type: string responses: '200': description: '' '404': description: '' post: tags: - admin summary: Add a Badge to a User operationId: adminAddUserBadges parameters: - name: username in: path description: username of the user to whom a badge is to be added required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/UserBadgeOption' responses: '204': description: '' '403': description: '' delete: tags: - admin summary: Remove a Badge from a User operationId: adminDeleteUserBadges parameters: - name: username in: path description: username of the user whose badge is to be deleted required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/UserBadgeOption' responses: '204': description: '' '403': description: '' '422': description: '' /admin/users/{username}/keys: post: tags: - admin summary: Add a Public Key on Behalf of a User operationId: adminCreatePublicKey parameters: - name: username in: path description: username of the user who is to receive a public key required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreateKeyOption' responses: '201': description: '' '403': description: '' '422': description: '' /admin/users/{username}/keys/{id}: delete: tags: - admin summary: Delete a User's Public Key operationId: adminDeleteUserPublicKey parameters: - name: username in: path description: username of the user whose public key is to be deleted required: true schema: type: string - name: id in: path description: id of the key to delete required: true schema: type: integer format: int64 responses: '204': description: '' '403': description: '' '404': description: '' /admin/users/{username}/orgs: post: tags: - admin summary: Create an Organization operationId: adminCreateOrg parameters: - name: username in: path description: username of the user who will own the created organization required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateOrgOption' responses: '201': description: '' '403': description: '' '422': description: '' /admin/users/{username}/rename: post: tags: - admin summary: Rename a User operationId: adminRenameUser parameters: - name: username in: path description: current username of the user required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RenameUserOption' responses: '204': description: '' '403': description: '' '422': description: '' /admin/users/{username}/repos: post: tags: - admin summary: Create a Repository on Behalf of a User operationId: adminCreateRepo parameters: - name: username in: path description: username of the user who will own the created repository required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateRepoOption' responses: '201': description: '' '400': description: '' '403': description: '' '404': description: '' '409': description: '' '422': description: '' /gitignore/templates: get: tags: - miscellaneous summary: Returns a List of All Gitignore Templates operationId: listGitignoresTemplates responses: '200': description: '' /gitignore/templates/{name}: get: tags: - miscellaneous summary: Returns Information About a Gitignore Template operationId: getGitignoreTemplateInfo parameters: - name: name in: path description: name of the template required: true schema: type: string responses: '200': description: '' '404': description: '' /label/templates: get: tags: - miscellaneous summary: Returns a List of All Label Templates operationId: listLabelTemplates responses: '200': description: '' /label/templates/{name}: get: tags: - miscellaneous summary: Returns All Labels in a Template operationId: getLabelTemplateInfo parameters: - name: name in: path description: name of the template required: true schema: type: string responses: '200': description: '' '404': description: '' /licenses: get: tags: - miscellaneous summary: Returns a List of All License Templates operationId: listLicenseTemplates responses: '200': description: '' /licenses/{name}: get: tags: - miscellaneous summary: Returns Information About a License Template operationId: getLicenseTemplateInfo parameters: - name: name in: path description: name of the license required: true schema: type: string responses: '200': description: '' '404': description: '' /markdown: post: tags: - miscellaneous summary: Render a Markdown Document as HTML operationId: renderMarkdown requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/MarkdownOption' responses: '200': description: '' '422': description: '' /markdown/raw: post: tags: - miscellaneous summary: Render Raw Markdown as HTML operationId: renderMarkdownRaw requestBody: required: true content: application/json: schema: type: string description: Request body to render responses: '200': description: '' '422': description: '' /markup: post: tags: - miscellaneous summary: Render a Markup Document as HTML operationId: renderMarkup requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/MarkupOption' responses: '200': description: '' '422': description: '' /notifications: get: tags: - notification summary: List Users's Notification Threads operationId: notifyGetList parameters: - name: all in: query description: If true, show notifications marked as read. Default value is false schema: type: boolean - name: status-types in: query description: 'Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned.' schema: type: array items: type: string - name: subject-type in: query description: filter notifications by subject type schema: type: array items: enum: - issue - pull - commit - repository type: string - name: since in: query description: Only show notifications updated after the given time. This is a timestamp in RFC 3339 format schema: type: string format: date-time - name: before in: query description: Only show notifications updated before the given time. This is a timestamp in RFC 3339 format schema: type: string format: date-time - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' put: tags: - notification summary: Mark Notification Threads as Read, Pinned or Unread operationId: notifyReadList parameters: - name: last_read_at in: query description: Describes the last point that notifications were checked. Anything updated since this time will not be updated. schema: type: string format: date-time - name: all in: query description: If true, mark all notifications on this repo. Default value is false schema: type: string - name: status-types in: query description: 'Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.' schema: type: array items: type: string - name: to-status in: query description: Status to mark notifications as, Defaults to read. schema: type: string responses: '205': description: '' /notifications/new: get: tags: - notification summary: Check if Unread Notifications Exist operationId: notifyNewAvailable responses: '200': description: '' /notifications/threads/{id}: get: tags: - notification summary: Get Notification Thread by ID operationId: notifyGetThread parameters: - name: id in: path description: id of notification thread required: true schema: type: string responses: '200': description: '' '403': description: '' '404': description: '' patch: tags: - notification summary: Mark Notification Thread as Read by ID operationId: notifyReadThread parameters: - name: id in: path description: id of notification thread required: true schema: type: string - name: to-status in: query description: Status to mark notifications as schema: type: string default: read responses: '205': description: '' '403': description: '' '404': description: '' /org/{org}/repos: post: tags: - organization summary: Create a Repository in an Organization operationId: createOrgRepoDeprecated parameters: - name: org in: path description: name of organization required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreateRepoOption' responses: '201': description: '' '403': description: '' '404': description: '' '422': description: '' /orgs: get: tags: - organization summary: Get List of Organizations operationId: orgGetAll parameters: - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' post: tags: - organization summary: Create an Organization operationId: orgCreate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateOrgOption' responses: '201': description: '' '403': description: '' '422': description: '' /orgs/{org}: get: tags: - organization summary: Get an Organization operationId: orgGet parameters: - name: org in: path description: name of the organization to get required: true schema: type: string responses: '200': description: '' '404': description: '' delete: tags: - organization summary: Delete an Organization operationId: orgDelete parameters: - name: org in: path description: organization that is to be deleted required: true schema: type: string responses: '204': description: '' '404': description: '' patch: tags: - organization summary: Edit an Organization operationId: orgEdit parameters: - name: org in: path description: name of the organization to edit required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/EditOrgOption' responses: '200': description: '' '404': description: '' /orgs/{org}/actions/jobs: get: tags: - organization summary: Get Org-Level Workflow Jobs operationId: getOrgWorkflowJobs parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: status in: query description: workflow status (pending, queued, in_progress, failure, success, skipped) schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '400': description: '' '404': description: '' /orgs/{org}/actions/runners: get: tags: - organization summary: Get Org-Level Runners operationId: getOrgRunners parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: disabled in: query description: filter by disabled status (true or false) schema: type: boolean responses: '200': description: '' '400': description: '' '404': description: '' /orgs/{org}/actions/runners/registration-token: post: tags: - organization summary: Get an Organization's Actions Runner Registration Token operationId: orgCreateRunnerRegistrationToken parameters: - name: org in: path description: name of the organization required: true schema: type: string responses: '200': description: '' /orgs/{org}/actions/runners/{runner_id}: get: tags: - organization summary: Get an Org-Level Runner operationId: getOrgRunner parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: runner_id in: path description: id of the runner required: true schema: type: string responses: '200': description: '' '400': description: '' '404': description: '' delete: tags: - organization summary: Delete an Org-Level Runner operationId: deleteOrgRunner parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: runner_id in: path description: id of the runner required: true schema: type: string responses: '204': description: runner has been deleted '400': description: '' '404': description: '' patch: tags: - organization summary: Update an Org-Level Runner operationId: updateOrgRunner parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: runner_id in: path description: id of the runner required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/EditActionRunnerOption' responses: '200': description: '' '400': description: '' '404': description: '' '422': description: '' /orgs/{org}/actions/runs: get: tags: - organization summary: Get Org-Level Workflow Runs operationId: getOrgWorkflowRuns parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: event in: query description: workflow event name schema: type: string - name: branch in: query description: workflow branch schema: type: string - name: status in: query description: workflow status (pending, queued, in_progress, failure, success, skipped) schema: type: string - name: actor in: query description: triggered by user schema: type: string - name: head_sha in: query description: triggering sha of the workflow run schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '400': description: '' '404': description: '' /orgs/{org}/actions/secrets: get: tags: - organization summary: List an Organization's Actions Secrets operationId: orgListActionsSecrets parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' /orgs/{org}/actions/secrets/{secretname}: put: tags: - organization summary: Create or Update a Secret Value in an Organization operationId: updateOrgSecret parameters: - name: org in: path description: name of organization required: true schema: type: string - name: secretname in: path description: name of the secret required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreateOrUpdateSecretOption' responses: '201': description: response when creating a secret '204': description: response when updating a secret '400': description: '' '404': description: '' delete: tags: - organization summary: Delete a Secret in an Organization operationId: deleteOrgSecret parameters: - name: org in: path description: name of organization required: true schema: type: string - name: secretname in: path description: name of the secret required: true schema: type: string responses: '204': description: delete one secret of the organization '400': description: '' '404': description: '' /orgs/{org}/actions/variables: get: tags: - organization summary: Get an Org-Level Variables List operationId: getOrgVariablesList parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '400': description: '' '404': description: '' /orgs/{org}/actions/variables/{variablename}: get: tags: - organization summary: Get an Org-Level Variable operationId: getOrgVariable parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: variablename in: path description: name of the variable required: true schema: type: string responses: '200': description: '' '400': description: '' '404': description: '' put: tags: - organization summary: Update an Org-Level Variable operationId: updateOrgVariable parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: variablename in: path description: name of the variable required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/UpdateVariableOption' responses: '201': description: response when updating an org-level variable '204': description: response when updating an org-level variable '400': description: '' '404': description: '' post: tags: - organization summary: Create an Org-Level Variable operationId: createOrgVariable parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: variablename in: path description: name of the variable required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreateVariableOption' responses: '201': description: successfully created the org-level variable '400': description: '' '409': description: variable name already exists. '500': description: '' delete: tags: - organization summary: Delete an Org-Level Variable operationId: deleteOrgVariable parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: variablename in: path description: name of the variable required: true schema: type: string responses: '200': description: '' '201': description: response when deleting a variable '204': description: response when deleting a variable '400': description: '' '404': description: '' /orgs/{org}/activities/feeds: get: tags: - organization summary: List an Organization's Activity Feeds operationId: orgListActivityFeeds parameters: - name: org in: path description: name of the org required: true schema: type: string - name: date in: query description: the date of the activities to be found schema: type: string format: date - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' /orgs/{org}/avatar: post: tags: - organization summary: Update Avatar operationId: orgUpdateAvatar parameters: - name: org in: path description: name of the organization required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/UpdateUserAvatarOption' responses: '204': description: '' '404': description: '' delete: tags: - organization summary: Delete Avatar operationId: orgDeleteAvatar parameters: - name: org in: path description: name of the organization required: true schema: type: string responses: '204': description: '' '404': description: '' /orgs/{org}/blocks: get: tags: - organization summary: List Users Blocked by the Organization operationId: organizationListBlocks parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' /orgs/{org}/blocks/{username}: get: tags: - organization summary: Check if a User Is Blocked by the Organization operationId: organizationCheckUserBlock parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: username in: path description: username of the user to check required: true schema: type: string responses: '204': description: '' '404': description: '' put: tags: - organization summary: Block a User operationId: organizationBlockUser parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: username in: path description: username of the user to block required: true schema: type: string - name: note in: query description: optional note for the block schema: type: string responses: '204': description: '' '404': description: '' '422': description: '' delete: tags: - organization summary: Unblock a User operationId: organizationUnblockUser parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: username in: path description: username of the user to unblock required: true schema: type: string responses: '204': description: '' '404': description: '' '422': description: '' /orgs/{org}/hooks: get: tags: - organization summary: List an Organization's Webhooks operationId: orgListHooks parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' post: tags: - organization summary: Create a Hook operationId: orgCreateHook parameters: - name: org in: path description: name of the organization required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateHookOption' responses: '201': description: '' '404': description: '' /orgs/{org}/hooks/{id}: get: tags: - organization summary: Get a Hook operationId: orgGetHook parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: id in: path description: id of the hook to get required: true schema: type: integer format: int64 responses: '200': description: '' '404': description: '' delete: tags: - organization summary: Delete a Hook operationId: orgDeleteHook parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: id in: path description: id of the hook to delete required: true schema: type: integer format: int64 responses: '204': description: '' '404': description: '' patch: tags: - organization summary: Update a Hook operationId: orgEditHook parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: id in: path description: id of the hook to update required: true schema: type: integer format: int64 requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/EditHookOption' responses: '200': description: '' '404': description: '' /orgs/{org}/labels: get: tags: - organization summary: List an Organization's Labels operationId: orgListLabels parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' post: tags: - organization summary: Create a Label for an Organization operationId: orgCreateLabel parameters: - name: org in: path description: name of the organization required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreateLabelOption' responses: '201': description: '' '404': description: '' '422': description: '' /orgs/{org}/labels/{id}: get: tags: - organization summary: Get a Single Label operationId: orgGetLabel parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: id in: path description: id of the label to get required: true schema: type: integer format: int64 responses: '200': description: '' '404': description: '' delete: tags: - organization summary: Delete a Label operationId: orgDeleteLabel parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: id in: path description: id of the label to delete required: true schema: type: integer format: int64 responses: '204': description: '' '404': description: '' patch: tags: - organization summary: Update a Label operationId: orgEditLabel parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: id in: path description: id of the label to edit required: true schema: type: integer format: int64 requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/EditLabelOption' responses: '200': description: '' '404': description: '' '422': description: '' /orgs/{org}/members: get: tags: - organization summary: List an Organization's Members operationId: orgListMembers parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' /orgs/{org}/members/{username}: get: tags: - organization summary: Check if a User Is a Member of an Organization operationId: orgIsMember parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: username in: path description: username of the user to check for an organization membership required: true schema: type: string responses: '204': description: user is a member '303': description: redirection to /orgs/{org}/public_members/{username} '404': description: user is not a member delete: tags: - organization summary: Remove a Member from an Organization operationId: orgDeleteMember parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: username in: path description: username of the user to remove from the organization required: true schema: type: string responses: '204': description: member removed '404': description: '' /orgs/{org}/public_members: get: tags: - organization summary: List an Organization's Public Members operationId: orgListPublicMembers parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' /orgs/{org}/public_members/{username}: get: tags: - organization summary: Check if a User Is a Public Member of an Organization operationId: orgIsPublicMember parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: username in: path description: username of the user to check for a public organization membership required: true schema: type: string responses: '204': description: user is a public member '404': description: user is not a public member put: tags: - organization summary: Publicize a User's Membership operationId: orgPublicizeMember parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: username in: path description: username of the user whose membership is to be publicized required: true schema: type: string responses: '204': description: membership publicized '403': description: '' '404': description: '' delete: tags: - organization summary: Conceal a User's Membership operationId: orgConcealMember parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: username in: path description: username of the user whose membership is to be concealed required: true schema: type: string responses: '204': description: '' '403': description: '' '404': description: '' /orgs/{org}/rename: post: tags: - organization summary: Rename an Organization operationId: renameOrg parameters: - name: org in: path description: existing org name required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RenameOrgOption' responses: '204': description: '' '403': description: '' '422': description: '' /orgs/{org}/repos: get: tags: - organization summary: List an Organization's Repos operationId: orgListRepos parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' post: tags: - organization summary: Create a Repository in an Organization operationId: createOrgRepo parameters: - name: org in: path description: name of organization required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreateRepoOption' responses: '201': description: '' '400': description: '' '403': description: '' '404': description: '' delete: tags: - organization summary: Delete All Repositories in an Organization operationId: orgDeleteRepos parameters: - name: org in: path description: name of the organization required: true schema: type: string responses: '202': description: '' '204': description: '' '403': description: '' '404': description: '' /orgs/{org}/teams: get: tags: - organization summary: List an Organization's Teams operationId: orgListTeams parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' post: tags: - organization summary: Create a Team operationId: orgCreateTeam parameters: - name: org in: path description: name of the organization required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreateTeamOption' responses: '201': description: '' '404': description: '' '422': description: '' /orgs/{org}/teams/search: get: tags: - organization summary: Search for Teams Within an Organization operationId: teamSearch parameters: - name: org in: path description: name of the organization required: true schema: type: string - name: q in: query description: keywords to search schema: type: string - name: include_desc in: query description: include search within team description (defaults to true) schema: type: boolean - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: SearchResults of a successful search content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/Team' ok: type: boolean '404': description: '' /packages/{owner}: get: tags: - package summary: Gets All Packages of an Owner operationId: listPackages parameters: - name: owner in: path description: owner of the packages required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer - name: type in: query description: package type filter schema: enum: - alpine - cargo - chef - composer - conan - conda - container - cran - debian - generic - go - helm - maven - npm - nuget - pub - pypi - rpm - rubygems - swift - terraform - vagrant type: string - name: q in: query description: name filter schema: type: string responses: '200': description: '' '404': description: '' /packages/{owner}/{type}/{name}: get: tags: - package summary: Gets All Versions of a Package operationId: listPackageVersions parameters: - name: owner in: path description: owner of the package required: true schema: type: string - name: type in: path description: type of the package required: true schema: type: string - name: name in: path description: name of the package required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' delete: tags: - package summary: Delete a Package operationId: deletePackage parameters: - name: owner in: path description: owner of the package required: true schema: type: string - name: type in: path description: type of the package required: true schema: type: string - name: name in: path description: name of the package required: true schema: type: string responses: '204': description: '' '404': description: '' /packages/{owner}/{type}/{name}/-/latest: get: tags: - package summary: Gets the Latest Version of a Package operationId: getLatestPackageVersion parameters: - name: owner in: path description: owner of the package required: true schema: type: string - name: type in: path description: type of the package required: true schema: type: string - name: name in: path description: name of the package required: true schema: type: string responses: '200': description: '' '404': description: '' /packages/{owner}/{type}/{name}/-/link/{repo_name}: post: tags: - package summary: Link a Package to a Repository operationId: linkPackage parameters: - name: owner in: path description: owner of the package required: true schema: type: string - name: type in: path description: type of the package required: true schema: type: string - name: name in: path description: name of the package required: true schema: type: string - name: repo_name in: path description: name of the repository to link. required: true schema: type: string responses: '201': description: '' '404': description: '' /packages/{owner}/{type}/{name}/-/unlink: post: tags: - package summary: Unlink a Package from a Repository operationId: unlinkPackage parameters: - name: owner in: path description: owner of the package required: true schema: type: string - name: type in: path description: type of the package required: true schema: type: string - name: name in: path description: name of the package required: true schema: type: string responses: '201': description: '' '404': description: '' /packages/{owner}/{type}/{name}/{version}: get: tags: - package summary: Gets a Package operationId: getPackage parameters: - name: owner in: path description: owner of the package required: true schema: type: string - name: type in: path description: type of the package required: true schema: type: string - name: name in: path description: name of the package required: true schema: type: string - name: version in: path description: version of the package required: true schema: type: string responses: '200': description: '' '404': description: '' delete: tags: - package summary: Delete a Package Version operationId: deletePackageVersion parameters: - name: owner in: path description: owner of the package required: true schema: type: string - name: type in: path description: type of the package required: true schema: type: string - name: name in: path description: name of the package required: true schema: type: string - name: version in: path description: version of the package required: true schema: type: string responses: '204': description: '' '404': description: '' /packages/{owner}/{type}/{name}/{version}/files: get: tags: - package summary: Gets All Files of a Package operationId: listPackageFiles parameters: - name: owner in: path description: owner of the package required: true schema: type: string - name: type in: path description: type of the package required: true schema: type: string - name: name in: path description: name of the package required: true schema: type: string - name: version in: path description: version of the package required: true schema: type: string responses: '200': description: '' '404': description: '' /repos/issues/search: get: tags: - issue summary: Search for Issues Across the Repositories That the User Has Access To operationId: issueSearchIssues parameters: - name: state in: query description: State of the issue schema: enum: - open - closed - all type: string default: open - name: labels in: query description: Comma-separated list of label names. Fetch only issues that have any of these labels. Non existent labels are discarded. schema: type: string - name: milestones in: query description: Comma-separated list of milestone names. Fetch only issues that have any of these milestones. Non existent milestones are discarded. schema: type: string - name: q in: query description: Search string schema: type: string - name: type in: query description: Filter by issue type schema: enum: - issues - pulls type: string - name: since in: query description: Only show issues updated after the given time (RFC 3339 format) schema: type: string format: date-time - name: before in: query description: Only show issues updated before the given time (RFC 3339 format) schema: type: string format: date-time - name: assigned in: query description: Filter issues or pulls assigned to the authenticated user schema: type: boolean default: false - name: created in: query description: Filter issues or pulls created by the authenticated user schema: type: boolean default: false - name: mentioned in: query description: Filter issues or pulls mentioning the authenticated user schema: type: boolean default: false - name: review_requested in: query description: Filter pull requests where the authenticated user's review was requested schema: type: boolean default: false - name: reviewed in: query description: Filter pull requests reviewed by the authenticated user schema: type: boolean default: false - name: owner in: query description: Filter by repository owner schema: type: string - name: created_by in: query description: Only show items which were created by the given user schema: type: string - name: team in: query description: Filter by team (requires organization owner parameter) schema: type: string - name: page in: query description: Page number of results to return (1-based) schema: minimum: 1 type: integer default: 1 - name: limit in: query description: Number of items per page schema: minimum: 0 type: integer responses: '200': description: '' '400': description: '' '422': description: '' /repos/migrate: post: tags: - repository summary: Migrate a Remote Git Repository operationId: repoMigrate requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/MigrateRepoOptions' responses: '201': description: '' '403': description: '' '409': description: The repository with the same name already exists. '422': description: '' /repos/search: get: tags: - repository summary: Search for Repositories operationId: repoSearch parameters: - name: q in: query description: keyword schema: type: string - name: topic in: query description: Limit search to repositories with keyword as topic schema: type: boolean - name: includeDesc in: query description: include search of keyword within repository description schema: type: boolean - name: uid in: query description: search only for repos that the user with the given id owns or contributes to schema: type: integer format: int64 - name: priority_owner_id in: query description: repo owner to prioritize in the results schema: type: integer format: int64 - name: team_id in: query description: search only for repos that belong to the given team id schema: type: integer format: int64 - name: starredBy in: query description: search only for repos that the user with the given id has starred schema: type: integer format: int64 - name: private in: query description: include private repositories this user has access to (defaults to true) schema: type: boolean - name: is_private in: query description: show only pubic, private or all repositories (defaults to all) schema: type: boolean - name: template in: query description: include template repositories this user has access to (defaults to true) schema: type: boolean - name: archived in: query description: show only archived, non-archived or all repositories (defaults to all) schema: type: boolean - name: mode in: query description: type of repository to search for. Supported values are "fork", "source", "mirror" and "collaborative" schema: type: string - name: exclusive in: query description: if `uid` is given, search only for repos that the user owns schema: type: boolean - name: sort in: query description: sort repos by attribute. Supported values are "alpha", "created", "updated", "size", "git_size", "lfs_size", "stars", "forks" and "id". Default is "alpha" schema: type: string - name: order in: query description: sort order, either "asc" (ascending) or "desc" (descending). Default is "asc", ignored if "sort" is not specified. schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '422': description: '' /repos/{owner}/{repo}: get: tags: - repository summary: Get a Repository operationId: repoGet parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string responses: '200': description: '' '404': description: '' delete: tags: - repository summary: Delete a Repository operationId: repoDelete parameters: - name: owner in: path description: owner of the repo to delete required: true schema: type: string - name: repo in: path description: name of the repo to delete required: true schema: type: string responses: '204': description: '' '403': description: '' '404': description: '' patch: tags: - repository summary: Edit a Repository's Properties. Only Fields That Are Set Will Be Changed. operationId: repoEdit parameters: - name: owner in: path description: owner of the repo to edit required: true schema: type: string - name: repo in: path description: name of the repo to edit required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/EditRepoOption' description: Properties of a repo that you can edit responses: '200': description: '' '403': description: '' '404': description: '' '422': description: '' /repos/{owner}/{repo}/actions/artifacts: get: tags: - repository summary: Lists All Artifacts for a Repository operationId: getArtifacts parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repository required: true schema: type: string - name: name in: query description: name of the artifact schema: type: string responses: '200': description: '' '400': description: '' '404': description: '' /repos/{owner}/{repo}/actions/artifacts/{artifact_id}: get: tags: - repository summary: Gets a Specific Artifact for a Workflow Run operationId: getArtifact parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repository required: true schema: type: string - name: artifact_id in: path description: id of the artifact required: true schema: type: string responses: '200': description: '' '400': description: '' '404': description: '' delete: tags: - repository summary: Deletes a Specific Artifact for a Workflow Run operationId: deleteArtifact parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repository required: true schema: type: string - name: artifact_id in: path description: id of the artifact required: true schema: type: string responses: '204': description: No Content '400': description: '' '404': description: '' /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/zip: get: tags: - repository summary: Downloads a Specific Artifact for a Workflow Run Redirects to Blob URL operationId: downloadArtifact parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repository required: true schema: type: string - name: artifact_id in: path description: id of the artifact required: true schema: type: string responses: '302': description: redirect to the blob download '400': description: '' '404': description: '' /repos/{owner}/{repo}/actions/jobs: get: tags: - repository summary: Lists All Jobs for a Repository operationId: listWorkflowJobs parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repository required: true schema: type: string - name: status in: query description: workflow status (pending, queued, in_progress, failure, success, skipped) schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '400': description: '' '404': description: '' /repos/{owner}/{repo}/actions/jobs/{job_id}: get: tags: - repository summary: Gets a Specific Workflow Job for a Workflow Run operationId: getWorkflowJob parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repository required: true schema: type: string - name: job_id in: path description: id of the job required: true schema: type: string responses: '200': description: '' '400': description: '' '404': description: '' /repos/{owner}/{repo}/actions/jobs/{job_id}/logs: get: tags: - repository summary: Downloads the Job Logs for a Workflow Run operationId: downloadActionsRunJobLogs parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repository required: true schema: type: string - name: job_id in: path description: id of the job required: true schema: type: integer responses: '200': description: output blob content '400': description: '' '404': description: '' /repos/{owner}/{repo}/actions/runners: get: tags: - repository summary: Get Repo-Level Runners operationId: getRepoRunners parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: disabled in: query description: filter by disabled status (true or false) schema: type: boolean responses: '200': description: '' '400': description: '' '404': description: '' /repos/{owner}/{repo}/actions/runners/registration-token: post: tags: - repository summary: Get a Repository's Actions Runner Registration Token operationId: repoCreateRunnerRegistrationToken parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string responses: '200': description: '' /repos/{owner}/{repo}/actions/runners/{runner_id}: get: tags: - repository summary: Get a Repo-Level Runner operationId: getRepoRunner parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: runner_id in: path description: id of the runner required: true schema: type: string responses: '200': description: '' '400': description: '' '404': description: '' delete: tags: - repository summary: Delete a Repo-Level Runner operationId: deleteRepoRunner parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: runner_id in: path description: id of the runner required: true schema: type: string responses: '204': description: runner has been deleted '400': description: '' '404': description: '' patch: tags: - repository summary: Update a Repo-Level Runner operationId: updateRepoRunner parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: runner_id in: path description: id of the runner required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/EditActionRunnerOption' responses: '200': description: '' '400': description: '' '404': description: '' '422': description: '' /repos/{owner}/{repo}/actions/runs: get: tags: - repository summary: Lists All Runs for a Repository Run operationId: getWorkflowRuns parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repository required: true schema: type: string - name: event in: query description: workflow event name schema: type: string - name: branch in: query description: workflow branch schema: type: string - name: status in: query description: workflow status (pending, queued, in_progress, failure, success, skipped) schema: type: string - name: actor in: query description: triggered by user schema: type: string - name: head_sha in: query description: triggering sha of the workflow run schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '400': description: '' '404': description: '' /repos/{owner}/{repo}/actions/runs/{run}: get: tags: - repository summary: Gets a Specific Workflow Run operationId: GetWorkflowRun parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repository required: true schema: type: string - name: run in: path description: id of the run required: true schema: type: integer responses: '200': description: '' '400': description: '' '404': description: '' delete: tags: - repository summary: Delete a Workflow Run operationId: deleteActionRun parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repository required: true schema: type: string - name: run in: path description: runid of the workflow run required: true schema: type: integer responses: '204': description: No Content '400': description: '' '404': description: '' /repos/{owner}/{repo}/actions/runs/{run}/artifacts: get: tags: - repository summary: Lists All Artifacts for a Repository Run operationId: getArtifactsOfRun parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repository required: true schema: type: string - name: run in: path description: runid of the workflow run required: true schema: type: integer - name: name in: query description: name of the artifact schema: type: string responses: '200': description: '' '400': description: '' '404': description: '' /repos/{owner}/{repo}/actions/runs/{run}/jobs: get: tags: - repository summary: Lists All Jobs for a Workflow Run operationId: listWorkflowRunJobs parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repository required: true schema: type: string - name: run in: path description: runid of the workflow run required: true schema: type: integer - name: status in: query description: workflow status (pending, queued, in_progress, failure, success, skipped) schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '400': description: '' '404': description: '' /repos/{owner}/{repo}/actions/runs/{run}/jobs/{job_id}/rerun: post: tags: - repository summary: Reruns a Specific Workflow Job in a Run operationId: rerunWorkflowJob parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repository required: true schema: type: string - name: run in: path description: id of the run required: true schema: type: integer - name: job_id in: path description: id of the job required: true schema: type: integer responses: '201': description: '' '400': description: '' '403': description: '' '404': description: '' '422': description: '' /repos/{owner}/{repo}/actions/runs/{run}/rerun: post: tags: - repository summary: Reruns an Entire Workflow Run operationId: rerunWorkflowRun parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repository required: true schema: type: string - name: run in: path description: id of the run required: true schema: type: integer responses: '201': description: '' '400': description: '' '403': description: '' '404': description: '' '422': description: '' /repos/{owner}/{repo}/actions/runs/{run}/rerun-failed-jobs: post: tags: - repository summary: Reruns All Failed Jobs in a Workflow Run operationId: rerunFailedWorkflowRun parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repository required: true schema: type: string - name: run in: path description: id of the run required: true schema: type: integer responses: '201': description: '' '400': description: '' '403': description: '' '404': description: '' '422': description: '' /repos/{owner}/{repo}/actions/secrets: get: tags: - repository summary: List an Repo's Actions Secrets operationId: repoListActionsSecrets parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repository required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/actions/secrets/{secretname}: put: tags: - repository summary: Create or Update a Secret Value in a Repository operationId: updateRepoSecret parameters: - name: owner in: path description: owner of the repository required: true schema: type: string - name: repo in: path description: name of the repository required: true schema: type: string - name: secretname in: path description: name of the secret required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreateOrUpdateSecretOption' responses: '201': description: response when creating a secret '204': description: response when updating a secret '400': description: '' '404': description: '' delete: tags: - repository summary: Delete a Secret in a Repository operationId: deleteRepoSecret parameters: - name: owner in: path description: owner of the repository required: true schema: type: string - name: repo in: path description: name of the repository required: true schema: type: string - name: secretname in: path description: name of the secret required: true schema: type: string responses: '204': description: delete one secret of the repository '400': description: '' '404': description: '' /repos/{owner}/{repo}/actions/tasks: get: tags: - repository summary: List a Repository's Action Tasks operationId: ListActionTasks parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results, default maximum page size is 50 schema: type: integer responses: '200': description: '' '400': description: '' '403': description: '' '404': description: '' '409': description: '' '422': description: '' /repos/{owner}/{repo}/actions/variables: get: tags: - repository summary: Get Repo-Level Variables List operationId: getRepoVariablesList parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repository required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '400': description: '' '404': description: '' /repos/{owner}/{repo}/actions/variables/{variablename}: get: tags: - repository summary: Get a Repo-Level Variable operationId: getRepoVariable parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repository required: true schema: type: string - name: variablename in: path description: name of the variable required: true schema: type: string responses: '200': description: '' '400': description: '' '404': description: '' put: tags: - repository summary: Update a Repo-Level Variable operationId: updateRepoVariable parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repository required: true schema: type: string - name: variablename in: path description: name of the variable required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/UpdateVariableOption' responses: '201': description: response when updating a repo-level variable '204': description: response when updating a repo-level variable '400': description: '' '404': description: '' post: tags: - repository summary: Create a Repo-Level Variable operationId: createRepoVariable parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repository required: true schema: type: string - name: variablename in: path description: name of the variable required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreateVariableOption' responses: '201': description: response when creating a repo-level variable '400': description: '' '409': description: variable name already exists. '500': description: '' delete: tags: - repository summary: Delete a Repo-Level Variable operationId: deleteRepoVariable parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repository required: true schema: type: string - name: variablename in: path description: name of the variable required: true schema: type: string responses: '200': description: '' '201': description: response when deleting a variable '204': description: response when deleting a variable '400': description: '' '404': description: '' /repos/{owner}/{repo}/actions/workflows: get: tags: - repository summary: List Repository Workflows operationId: ActionsListRepositoryWorkflows parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string responses: '200': description: '' '400': description: '' '403': description: '' '404': description: '' '422': description: '' '500': description: '' /repos/{owner}/{repo}/actions/workflows/{workflow_id}: get: tags: - repository summary: Get a Workflow operationId: ActionsGetWorkflow parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: workflow_id in: path description: id of the workflow required: true schema: type: string responses: '200': description: '' '400': description: '' '403': description: '' '404': description: '' '422': description: '' '500': description: '' /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable: put: tags: - repository summary: Disable a Workflow operationId: ActionsDisableWorkflow parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: workflow_id in: path description: id of the workflow required: true schema: type: string responses: '204': description: No Content '400': description: '' '403': description: '' '404': description: '' '422': description: '' /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches: post: tags: - repository summary: Create a Workflow Dispatch Event operationId: ActionsDispatchWorkflow parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: workflow_id in: path description: id of the workflow required: true schema: type: string - name: return_run_details in: query description: Whether the response should include the workflow run ID and URLs. schema: type: boolean requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreateActionWorkflowDispatch' responses: '200': description: '' '204': description: No Content, if return_run_details is missing or false '400': description: '' '403': description: '' '404': description: '' '422': description: '' /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable: put: tags: - repository summary: Enable a Workflow operationId: ActionsEnableWorkflow parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: workflow_id in: path description: id of the workflow required: true schema: type: string responses: '204': description: No Content '400': description: '' '403': description: '' '404': description: '' '409': description: '' '422': description: '' /repos/{owner}/{repo}/activities/feeds: get: tags: - repository summary: List a Repository's Activity Feeds operationId: repoListActivityFeeds parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: date in: query description: the date of the activities to be found schema: type: string format: date - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/archive/{archive}: get: tags: - repository summary: Get an Archive of a Repository operationId: repoGetArchive parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: archive in: path description: the git reference for download with attached archive format (e.g. master.zip) required: true schema: type: string - name: path in: query description: subpath of the repository to download schema: type: array items: type: string responses: '200': description: success '404': description: '' /repos/{owner}/{repo}/assignees: get: tags: - repository summary: Return All Users That Have Write Access and Can Be Assigned to Issues operationId: repoGetAssignees parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/avatar: post: tags: - repository summary: Update Avatar operationId: repoUpdateAvatar parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/UpdateRepoAvatarOption' responses: '204': description: '' '404': description: '' delete: tags: - repository summary: Delete Avatar operationId: repoDeleteAvatar parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string responses: '204': description: '' '404': description: '' /repos/{owner}/{repo}/branch_protections: get: tags: - repository summary: List Branch Protections for a Repository operationId: repoListBranchProtection parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string responses: '200': description: '' post: tags: - repository summary: Create a Branch Protections for a Repository operationId: repoCreateBranchProtection parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreateBranchProtectionOption' responses: '201': description: '' '403': description: '' '404': description: '' '422': description: '' '423': description: '' /repos/{owner}/{repo}/branch_protections/priority: post: tags: - repository summary: Update the Priorities of Branch Protections for a Repository. operationId: repoUpdateBranchProtectionPriories parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/UpdateBranchProtectionPriories' responses: '204': description: '' '404': description: '' '422': description: '' '423': description: '' /repos/{owner}/{repo}/branch_protections/{name}: get: tags: - repository summary: Get a Specific Branch Protection for the Repository operationId: repoGetBranchProtection parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: name in: path description: name of protected branch required: true schema: type: string responses: '200': description: '' '404': description: '' delete: tags: - repository summary: Delete a Specific Branch Protection for the Repository operationId: repoDeleteBranchProtection parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: name in: path description: name of protected branch required: true schema: type: string responses: '204': description: '' '404': description: '' patch: tags: - repository summary: Edit a Branch Protections for a Repository. Only Fields That Are Set Will Be Changed operationId: repoEditBranchProtection parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: name in: path description: name of protected branch required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/EditBranchProtectionOption' responses: '200': description: '' '404': description: '' '422': description: '' '423': description: '' /repos/{owner}/{repo}/branches: get: tags: - repository summary: List a Repository's Branches operationId: repoListBranches parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' post: tags: - repository summary: Create a Branch operationId: repoCreateBranch parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreateBranchRepoOption' responses: '201': description: '' '403': description: The branch is archived or a mirror. '404': description: The old branch does not exist. '409': description: The branch with the same name already exists. '423': description: '' /repos/{owner}/{repo}/branches/{branch}: get: tags: - repository summary: Retrieve a Specific Branch from a Repository, Including Its Effective Branch Protection operationId: repoGetBranch parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: branch in: path description: branch to get required: true schema: type: string responses: '200': description: '' '404': description: '' put: tags: - repository summary: Update a Branch Reference to a New Commit operationId: repoUpdateBranch parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: branch in: path description: name of the branch required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/UpdateBranchRepoOption' responses: '204': description: '' '403': description: '' '404': description: '' '409': description: '' '422': description: '' delete: tags: - repository summary: Delete a Specific Branch from a Repository operationId: repoDeleteBranch parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: branch in: path description: branch to delete required: true schema: type: string responses: '204': description: '' '403': description: '' '404': description: '' '423': description: '' patch: tags: - repository summary: Rename a Branch operationId: repoRenameBranch parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: branch in: path description: name of the branch required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/RenameBranchRepoOption' responses: '204': description: '' '403': description: '' '404': description: '' '422': description: '' /repos/{owner}/{repo}/collaborators: get: tags: - repository summary: List a Repository's Collaborators operationId: repoListCollaborators parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/collaborators/{collaborator}: get: tags: - repository summary: Check if a User Is a Collaborator of a Repository operationId: repoCheckCollaborator parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: collaborator in: path description: username of the user to check for being a collaborator required: true schema: type: string responses: '204': description: '' '404': description: '' '422': description: '' put: tags: - repository summary: Add or Update a Collaborator to a Repository operationId: repoAddCollaborator parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: collaborator in: path description: username of the user to add or update as a collaborator required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/AddCollaboratorOption' responses: '204': description: '' '403': description: '' '404': description: '' '422': description: '' delete: tags: - repository summary: Delete a Collaborator from a Repository operationId: repoDeleteCollaborator parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: collaborator in: path description: username of the collaborator to delete required: true schema: type: string responses: '204': description: '' '404': description: '' '422': description: '' /repos/{owner}/{repo}/collaborators/{collaborator}/permission: get: tags: - repository summary: Get Repository Permissions for a User operationId: repoGetRepoPermissions parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: collaborator in: path description: username of the collaborator whose permissions are to be obtained required: true schema: type: string responses: '200': description: '' '403': description: '' '404': description: '' /repos/{owner}/{repo}/commits: get: tags: - repository summary: Get a List of All Commits from a Repository operationId: repoGetAllCommits parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: sha in: query description: SHA or branch to start listing commits from (usually 'master') schema: type: string - name: path in: query description: filepath of a file/dir schema: type: string - name: since in: query description: Only commits after this date will be returned (ISO 8601 format) schema: type: string format: date-time - name: until in: query description: Only commits before this date will be returned (ISO 8601 format) schema: type: string format: date-time - name: stat in: query description: include diff stats for every commit (disable for speedup, default 'true') schema: type: boolean - name: verification in: query description: include verification for every commit (disable for speedup, default 'true') schema: type: boolean - name: files in: query description: include a list of affected files for every commit (disable for speedup, default 'true') schema: type: boolean - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results (ignored if used with 'path') schema: type: integer - name: not in: query description: commits that match the given specifier will not be listed. schema: type: string responses: '200': description: '' '404': description: '' '409': description: '' /repos/{owner}/{repo}/commits/{ref}/status: get: tags: - repository summary: Get a Commit's Combined Status, by Branch/Tag/Commit Reference operationId: repoGetCombinedStatusByRef parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: ref in: path description: name of branch/tag/commit required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '400': description: '' '404': description: '' /repos/{owner}/{repo}/commits/{ref}/statuses: get: tags: - repository summary: Get a Commit's Statuses, by Branch/Tag/Commit Reference operationId: repoListStatusesByRef parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: ref in: path description: name of branch/tag/commit required: true schema: type: string - name: sort in: query description: type of sort schema: enum: - oldest - recentupdate - leastupdate - leastindex - highestindex type: string - name: state in: query description: type of state schema: enum: - pending - success - error - failure - warning type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '400': description: '' '404': description: '' /repos/{owner}/{repo}/commits/{sha}/pull: get: tags: - repository summary: Get the Merged Pull Request of the Commit operationId: repoGetCommitPullRequest parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: sha in: path description: SHA of the commit to get required: true schema: type: string responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/compare/{basehead}: get: tags: - repository summary: Get Commit Comparison Information operationId: repoCompareDiff parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: basehead in: path description: compare two branches or commits required: true schema: type: string responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/contents: get: tags: - repository summary: Gets the Metadata of All the Entries of the Root Dir. operationId: repoGetContentsList description: This API follows GitHub's design, and it is not easy to use. Recommend users to use our "contents-ext" API instead. parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: ref in: query description: The name of the commit/branch/tag. Default to the repository’s default branch. schema: type: string responses: '200': description: '' '404': description: '' post: tags: - repository summary: Modify Multiple Files in a Repository operationId: repoChangeFiles parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ChangeFilesOptions' responses: '201': description: '' '403': description: '' '404': description: '' '422': description: '' '423': description: '' /repos/{owner}/{repo}/contents-ext/{filepath}: get: tags: - repository summary: The Extended "contents" API, to Get File Metadata and/or Content, or List a Directory. operationId: repoGetContentsExt description: It guarantees that only one of the response fields is set if the request succeeds. Users can pass "includes=file_content" or "includes=lfs_metadata" to retrieve more fields. "includes=file_content" only works for single file, if you need to retrieve file contents in batch, use "file-contents" API after listing the directory. parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: filepath in: path description: path of the dir, file, symlink or submodule in the repo. Swagger requires path parameter to be "required", you can leave it empty or pass a single dot (".") to get the root directory. required: true schema: type: string - name: ref in: query description: the name of the commit/branch/tag, default to the repository’s default branch. schema: type: string - name: includes in: query description: By default this API's response only contains file's metadata. Use comma-separated "includes" options to retrieve more fields. Option "file_content" will try to retrieve the file content, "lfs_metadata" will try to retrieve LFS metadata, "commit_metadata" will try to retrieve commit metadata, and "commit_message" will try to retrieve commit message. schema: type: string responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/contents/{filepath}: get: tags: - repository summary: Gets the Metadata and Contents (if a File) of an Entry in a Repository, or a List of Entries if a Dir. operationId: repoGetContents description: This API follows GitHub's design, and it is not easy to use. Recommend users to use the "contents-ext" API instead. parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: filepath in: path description: path of the dir, file, symlink or submodule in the repo required: true schema: type: string - name: ref in: query description: The name of the commit/branch/tag. Default to the repository’s default branch. schema: type: string responses: '200': description: '' '404': description: '' put: tags: - repository summary: Update a File in a Repository if SHA Is Set, or Create the File if SHA Is Not Set operationId: repoUpdateFile parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: filepath in: path description: path of the file to update required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateFileOptions' responses: '200': description: '' '201': description: '' '403': description: '' '404': description: '' '422': description: '' '423': description: '' post: tags: - repository summary: Create a File in a Repository operationId: repoCreateFile parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: filepath in: path description: path of the file to create required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateFileOptions' responses: '201': description: '' '403': description: '' '404': description: '' '422': description: '' '423': description: '' delete: tags: - repository summary: Delete a File in a Repository operationId: repoDeleteFile parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: filepath in: path description: path of the file to delete required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteFileOptions' responses: '200': description: '' '400': description: '' '403': description: '' '404': description: '' '422': description: '' '423': description: '' /repos/{owner}/{repo}/diffpatch: post: tags: - repository summary: Apply Diff Patch to Repository operationId: repoApplyDiffPatch parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ApplyDiffPatchFileOptions' responses: '200': description: '' '404': description: '' '423': description: '' /repos/{owner}/{repo}/editorconfig/{filepath}: get: tags: - repository summary: Get the EditorConfig Definitions of a File in a Repository operationId: repoGetEditorConfig parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: filepath in: path description: filepath of file to get required: true schema: type: string - name: ref in: query description: The name of the commit/branch/tag. Default to the repository’s default branch. schema: type: string responses: '200': description: success '404': description: '' /repos/{owner}/{repo}/file-contents: get: tags: - repository summary: Get the Metadata and Contents of Requested Files operationId: repoGetFileContents description: See the POST method. This GET method supports using JSON encoded request body in query parameter. parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: ref in: query description: The name of the commit/branch/tag. Default to the repository’s default branch. schema: type: string - name: body in: query description: 'The JSON encoded body (see the POST request): {"files": ["filename1", "filename2"]}' required: true schema: type: string responses: '200': description: '' '404': description: '' post: tags: - repository summary: Get the Metadata and Contents of Requested Files operationId: repoGetFileContentsPost description: Uses automatic pagination based on default page size and max response size and returns the maximum allowed number of files. Files which could not be retrieved are null. Files which are too large are being returned with `encoding == null`, `content == null` and `size > 0`, they can be requested separately by using the `download_url`. parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: ref in: query description: The name of the commit/branch/tag. Default to the repository’s default branch. schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetFilesOptions' responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/forks: get: tags: - repository summary: List a Repository's Forks operationId: listForks parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' post: tags: - repository summary: Fork a Repository operationId: createFork parameters: - name: owner in: path description: owner of the repo to fork required: true schema: type: string - name: repo in: path description: name of the repo to fork required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreateForkOption' responses: '202': description: '' '403': description: '' '404': description: '' '409': description: The repository with the same name already exists. '422': description: '' /repos/{owner}/{repo}/git/blobs/{sha}: get: tags: - repository summary: Gets the Blob of a Repository. operationId: GetBlob parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: sha in: path description: sha of the commit required: true schema: type: string responses: '200': description: '' '400': description: '' '404': description: '' /repos/{owner}/{repo}/git/commits/{sha}: get: tags: - repository summary: Get a Single Commit from a Repository operationId: repoGetSingleCommit parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: sha in: path description: a git ref or commit sha required: true schema: type: string - name: stat in: query description: include diff stats for every commit (disable for speedup, default 'true') schema: type: boolean - name: verification in: query description: include verification for every commit (disable for speedup, default 'true') schema: type: boolean - name: files in: query description: include a list of affected files for every commit (disable for speedup, default 'true') schema: type: boolean responses: '200': description: '' '404': description: '' '422': description: '' /repos/{owner}/{repo}/git/commits/{sha}.{diffType}: get: tags: - repository summary: Get a Commit's Diff or Patch operationId: repoDownloadCommitDiffOrPatch parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: sha in: path description: SHA of the commit to get required: true schema: type: string - name: diffType in: path description: whether the output is diff or patch required: true schema: enum: - diff - patch type: string responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/git/notes/{sha}: get: tags: - repository summary: Get a Note Corresponding to a Single Commit from a Repository operationId: repoGetNote parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: sha in: path description: a git ref or commit sha required: true schema: type: string - name: verification in: query description: include verification for every commit (disable for speedup, default 'true') schema: type: boolean - name: files in: query description: include a list of affected files for every commit (disable for speedup, default 'true') schema: type: boolean responses: '200': description: '' '404': description: '' '422': description: '' /repos/{owner}/{repo}/git/refs: get: tags: - repository summary: Get Specified Ref or Filtered Repository's Refs operationId: repoListAllGitRefs parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/git/refs/{ref}: get: tags: - repository summary: Get Specified Ref or Filtered Repository's Refs operationId: repoListGitRefs parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: ref in: path description: part or full name of the ref required: true schema: type: string responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/git/tags/{sha}: get: tags: - repository summary: Gets the Tag Object of an Annotated Tag (not Lightweight Tags) operationId: GetAnnotatedTag parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: sha in: path description: sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags. required: true schema: type: string responses: '200': description: '' '400': description: '' '404': description: '' /repos/{owner}/{repo}/git/trees/{sha}: get: tags: - repository summary: Gets the Tree of a Repository. operationId: GetTree parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: sha in: path description: sha of the commit required: true schema: type: string - name: recursive in: query description: show all directories and files schema: type: boolean - name: page in: query description: page number; the 'truncated' field in the response will be true if there are still more items after this page, false if the last page schema: type: integer - name: per_page in: query description: number of items per page schema: type: integer responses: '200': description: '' '400': description: '' '404': description: '' /repos/{owner}/{repo}/hooks: get: tags: - repository summary: List the Hooks in a Repository operationId: repoListHooks parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' post: tags: - repository summary: Create a Hook operationId: repoCreateHook parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreateHookOption' responses: '201': description: '' '404': description: '' /repos/{owner}/{repo}/hooks/git: get: tags: - repository summary: List the Git Hooks in a Repository operationId: repoListGitHooks parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/hooks/git/{id}: get: tags: - repository summary: Get a Git Hook operationId: repoGetGitHook parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of the hook to get required: true schema: type: string responses: '200': description: '' '404': description: '' delete: tags: - repository summary: Delete a Git Hook in a Repository operationId: repoDeleteGitHook parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of the hook to get required: true schema: type: string responses: '204': description: '' '404': description: '' patch: tags: - repository summary: Edit a Git Hook in a Repository operationId: repoEditGitHook parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of the hook to get required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/EditGitHookOption' responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/hooks/{id}: get: tags: - repository summary: Get a Hook operationId: repoGetHook parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of the hook to get required: true schema: type: integer format: int64 responses: '200': description: '' '404': description: '' delete: tags: - repository summary: Delete a Hook in a Repository operationId: repoDeleteHook parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of the hook to delete required: true schema: type: integer format: int64 responses: '204': description: '' '404': description: '' patch: tags: - repository summary: Edit a Hook in a Repository operationId: repoEditHook parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: index of the hook required: true schema: type: integer format: int64 requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/EditHookOption' responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/hooks/{id}/tests: post: tags: - repository summary: Test a Push Webhook operationId: repoTestHook parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of the hook to test required: true schema: type: integer format: int64 - name: ref in: query description: The name of the commit/branch/tag, indicates which commit will be loaded to the webhook payload. schema: type: string responses: '204': description: '' '404': description: '' /repos/{owner}/{repo}/issue_config: get: tags: - repository summary: Returns the Issue Config for a Repo operationId: repoGetIssueConfig parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/issue_config/validate: get: tags: - repository summary: Returns the Validation Information for a Issue Config operationId: repoValidateIssueConfig parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/issue_templates: get: tags: - repository summary: Get Available Issue Templates for a Repository operationId: repoGetIssueTemplates parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/issues: get: tags: - issue summary: List a Repository's Issues operationId: issueListIssues parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: state in: query description: whether issue is open or closed schema: enum: - closed - open - all type: string - name: labels in: query description: comma separated list of label names. Fetch only issues that have any of this label names. Non existent labels are discarded. schema: type: string - name: q in: query description: search string schema: type: string - name: type in: query description: filter by type (issues / pulls) if set schema: enum: - issues - pulls type: string - name: milestones in: query description: comma separated list of milestone names or ids. It uses names and fall back to ids. Fetch only issues that have any of this milestones. Non existent milestones are discarded schema: type: string - name: since in: query description: Only show items updated after the given time. This is a timestamp in RFC 3339 format schema: type: string format: date-time - name: before in: query description: Only show items updated before the given time. This is a timestamp in RFC 3339 format schema: type: string format: date-time - name: created_by in: query description: Only show items which were created by the given user schema: type: string - name: assigned_by in: query description: Only show items for which the given user is assigned schema: type: string - name: mentioned_by in: query description: Only show items in which the given user was mentioned schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' post: tags: - issue summary: Create an Issue. if Using Deadline Only the Date Will Be Taken Into Account, and Time of Day Ignored. operationId: issueCreateIssue parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreateIssueOption' responses: '201': description: '' '403': description: '' '404': description: '' '412': description: '' '422': description: '' '423': description: '' /repos/{owner}/{repo}/issues/comments: get: tags: - issue summary: List All Comments in a Repository operationId: issueGetRepoComments parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: since in: query description: if provided, only comments updated since the provided time are returned. schema: type: string format: date-time - name: before in: query description: if provided, only comments updated before the provided time are returned. schema: type: string format: date-time - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/issues/comments/{id}: get: tags: - issue summary: Get a Comment operationId: issueGetComment parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of the comment required: true schema: type: integer format: int64 responses: '200': description: '' '204': description: '' '403': description: '' '404': description: '' delete: tags: - issue summary: Delete a Comment operationId: issueDeleteComment parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of comment to delete required: true schema: type: integer format: int64 responses: '204': description: '' '403': description: '' '404': description: '' patch: tags: - issue summary: Edit a Comment operationId: issueEditComment parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of the comment to edit required: true schema: type: integer format: int64 requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/EditIssueCommentOption' responses: '200': description: '' '204': description: '' '403': description: '' '404': description: '' '423': description: '' /repos/{owner}/{repo}/issues/comments/{id}/assets: get: tags: - issue summary: List Comment's Attachments operationId: issueListIssueCommentAttachments parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of the comment required: true schema: type: integer format: int64 responses: '200': description: '' '404': description: '' post: tags: - issue summary: Create a Comment Attachment operationId: issueCreateIssueCommentAttachment parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of the comment required: true schema: type: integer format: int64 - name: name in: query description: name of the attachment schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: attachment: type: file description: attachment to upload required: - attachment responses: '201': description: '' '400': description: '' '403': description: '' '404': description: '' '413': description: '' '422': description: '' '423': description: '' /repos/{owner}/{repo}/issues/comments/{id}/assets/{attachment_id}: get: tags: - issue summary: Get a Comment Attachment operationId: issueGetIssueCommentAttachment parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of the comment required: true schema: type: integer format: int64 - name: attachment_id in: path description: id of the attachment to get required: true schema: type: integer format: int64 responses: '200': description: '' '404': description: '' delete: tags: - issue summary: Delete a Comment Attachment operationId: issueDeleteIssueCommentAttachment parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of the comment required: true schema: type: integer format: int64 - name: attachment_id in: path description: id of the attachment to delete required: true schema: type: integer format: int64 responses: '204': description: '' '404': description: '' '423': description: '' patch: tags: - issue summary: Edit a Comment Attachment operationId: issueEditIssueCommentAttachment parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of the comment required: true schema: type: integer format: int64 - name: attachment_id in: path description: id of the attachment to edit required: true schema: type: integer format: int64 requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/EditAttachmentOptions' responses: '201': description: '' '404': description: '' '422': description: '' '423': description: '' /repos/{owner}/{repo}/issues/comments/{id}/reactions: get: tags: - issue summary: Get a List of Reactions from a Comment of an Issue operationId: issueGetCommentReactions parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of the comment to edit required: true schema: type: integer format: int64 responses: '200': description: '' '403': description: '' '404': description: '' post: tags: - issue summary: Add a Reaction to a Comment of an Issue operationId: issuePostCommentReaction parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of the comment to edit required: true schema: type: integer format: int64 requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/EditReactionOption' responses: '200': description: '' '201': description: '' '403': description: '' '404': description: '' delete: tags: - issue summary: Remove a Reaction from a Comment of an Issue operationId: issueDeleteCommentReaction parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of the comment to edit required: true schema: type: integer format: int64 requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/EditReactionOption' responses: '204': description: '' '403': description: '' '404': description: '' /repos/{owner}/{repo}/issues/pinned: get: tags: - repository summary: List a Repo's Pinned Issues operationId: repoListPinnedIssues parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/issues/{index}: get: tags: - issue summary: Get an Issue operationId: issueGetIssue parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue to get required: true schema: type: integer format: int64 responses: '200': description: '' '404': description: '' delete: tags: - issue summary: Delete an Issue operationId: issueDelete parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of issue to delete required: true schema: type: integer format: int64 responses: '204': description: '' '403': description: '' '404': description: '' patch: tags: - issue summary: Edit an Issue. if Using Deadline Only the Date Will Be Taken Into Account, and Time of Day Ignored. operationId: issueEditIssue description: 'Pass `content_version` to enable optimistic locking on body edits. If the version doesn''t match the current value, the request fails with 409 Conflict. ' parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue to edit required: true schema: type: integer format: int64 requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/EditIssueOption' responses: '201': description: '' '403': description: '' '404': description: '' '412': description: '' /repos/{owner}/{repo}/issues/{index}/assets: get: tags: - issue summary: List Issue's Attachments operationId: issueListIssueAttachments parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue required: true schema: type: integer format: int64 responses: '200': description: '' '404': description: '' post: tags: - issue summary: Create an Issue Attachment operationId: issueCreateIssueAttachment parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue required: true schema: type: integer format: int64 - name: name in: query description: name of the attachment schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: attachment: type: file description: attachment to upload required: - attachment responses: '201': description: '' '400': description: '' '404': description: '' '413': description: '' '422': description: '' '423': description: '' /repos/{owner}/{repo}/issues/{index}/assets/{attachment_id}: get: tags: - issue summary: Get an Issue Attachment operationId: issueGetIssueAttachment parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue required: true schema: type: integer format: int64 - name: attachment_id in: path description: id of the attachment to get required: true schema: type: integer format: int64 responses: '200': description: '' '404': description: '' delete: tags: - issue summary: Delete an Issue Attachment operationId: issueDeleteIssueAttachment parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue required: true schema: type: integer format: int64 - name: attachment_id in: path description: id of the attachment to delete required: true schema: type: integer format: int64 responses: '204': description: '' '404': description: '' '423': description: '' patch: tags: - issue summary: Edit an Issue Attachment operationId: issueEditIssueAttachment parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue required: true schema: type: integer format: int64 - name: attachment_id in: path description: id of the attachment to edit required: true schema: type: integer format: int64 requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/EditAttachmentOptions' responses: '201': description: '' '404': description: '' '422': description: '' '423': description: '' /repos/{owner}/{repo}/issues/{index}/blocks: get: tags: - issue summary: List Issues That Are Blocked by This Issue operationId: issueListBlocks parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' post: tags: - issue summary: Block the Issue Given in the Body by the Issue in Path operationId: issueCreateIssueBlocking parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/IssueMeta' responses: '201': description: '' '404': description: the issue does not exist delete: tags: - issue summary: Unblock the Issue Given in the Body by the Issue in Path operationId: issueRemoveIssueBlocking parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/IssueMeta' responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/issues/{index}/comments: get: tags: - issue summary: List All Comments on an Issue operationId: issueGetComments parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue required: true schema: type: integer format: int64 - name: since in: query description: if provided, only comments updated since the specified time are returned. schema: type: string format: date-time - name: before in: query description: if provided, only comments updated before the provided time are returned. schema: type: string format: date-time responses: '200': description: '' '404': description: '' post: tags: - issue summary: Add a Comment to an Issue operationId: issueCreateComment parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue required: true schema: type: integer format: int64 requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreateIssueCommentOption' responses: '201': description: '' '403': description: '' '404': description: '' '423': description: '' /repos/{owner}/{repo}/issues/{index}/comments/{id}: delete: tags: - issue summary: Delete a Comment operationId: issueDeleteCommentDeprecated parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: this parameter is ignored required: true schema: type: integer - name: id in: path description: id of comment to delete required: true schema: type: integer format: int64 responses: '204': description: '' '403': description: '' '404': description: '' patch: tags: - issue summary: Edit a Comment operationId: issueEditCommentDeprecated parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: this parameter is ignored required: true schema: type: integer - name: id in: path description: id of the comment to edit required: true schema: type: integer format: int64 requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/EditIssueCommentOption' responses: '200': description: '' '204': description: '' '403': description: '' '404': description: '' /repos/{owner}/{repo}/issues/{index}/deadline: post: tags: - issue summary: Set an Issue Deadline. if Set to Null, the Deadline Is Deleted. if Using Deadline Only the Date Will Be Taken Into Account, and Time of Day Ignored. operationId: issueEditIssueDeadline parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue to create or update a deadline on required: true schema: type: integer format: int64 requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/EditDeadlineOption' responses: '201': description: '' '403': description: '' '404': description: '' /repos/{owner}/{repo}/issues/{index}/dependencies: get: tags: - issue summary: List an Issue's Dependencies, I.e All Issues That Block This Issue. operationId: issueListIssueDependencies parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' post: tags: - issue summary: Make the Issue in the URL Depend on the Issue in the Form. operationId: issueCreateIssueDependencies parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/IssueMeta' responses: '201': description: '' '404': description: the issue does not exist '423': description: '' delete: tags: - issue summary: Remove an Issue Dependency operationId: issueRemoveIssueDependencies parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/IssueMeta' responses: '200': description: '' '404': description: '' '423': description: '' /repos/{owner}/{repo}/issues/{index}/labels: get: tags: - issue summary: Get an Issue's Labels operationId: issueGetLabels parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue required: true schema: type: integer format: int64 responses: '200': description: '' '404': description: '' put: tags: - issue summary: Replace an Issue's Labels operationId: issueReplaceLabels parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue required: true schema: type: integer format: int64 requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/IssueLabelsOption' responses: '200': description: '' '403': description: '' '404': description: '' post: tags: - issue summary: Add a Label to an Issue operationId: issueAddLabel parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue required: true schema: type: integer format: int64 requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/IssueLabelsOption' responses: '200': description: '' '403': description: '' '404': description: '' delete: tags: - issue summary: Remove All Labels from an Issue operationId: issueClearLabels parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue required: true schema: type: integer format: int64 responses: '204': description: '' '403': description: '' '404': description: '' /repos/{owner}/{repo}/issues/{index}/labels/{id}: delete: tags: - issue summary: Remove a Label from an Issue operationId: issueRemoveLabel parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue required: true schema: type: integer format: int64 - name: id in: path description: id of the label to remove required: true schema: type: integer format: int64 responses: '204': description: '' '403': description: '' '404': description: '' '422': description: '' /repos/{owner}/{repo}/issues/{index}/lock: put: tags: - issue summary: Lock an Issue operationId: issueLockIssue parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue required: true schema: type: integer format: int64 requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/LockIssueOption' responses: '204': description: '' '403': description: '' '404': description: '' delete: tags: - issue summary: Unlock an Issue operationId: issueUnlockIssue parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue required: true schema: type: integer format: int64 responses: '204': description: '' '403': description: '' '404': description: '' /repos/{owner}/{repo}/issues/{index}/pin: post: tags: - issue summary: Pin an Issue operationId: pinIssue parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of issue to pin required: true schema: type: integer format: int64 responses: '204': description: '' '403': description: '' '404': description: '' delete: tags: - issue summary: Unpin an Issue operationId: unpinIssue parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of issue to unpin required: true schema: type: integer format: int64 responses: '204': description: '' '403': description: '' '404': description: '' /repos/{owner}/{repo}/issues/{index}/pin/{position}: patch: tags: - issue summary: Moves the Pin to the Given Position operationId: moveIssuePin parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of issue required: true schema: type: integer format: int64 - name: position in: path description: the new position required: true schema: type: integer format: int64 responses: '204': description: '' '403': description: '' '404': description: '' /repos/{owner}/{repo}/issues/{index}/reactions: get: tags: - issue summary: Get a List Reactions of an Issue operationId: issueGetIssueReactions parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue required: true schema: type: integer format: int64 - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '403': description: '' '404': description: '' post: tags: - issue summary: Add a Reaction to an Issue operationId: issuePostIssueReaction parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue required: true schema: type: integer format: int64 requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/EditReactionOption' responses: '200': description: '' '201': description: '' '403': description: '' '404': description: '' delete: tags: - issue summary: Remove a Reaction from an Issue operationId: issueDeleteIssueReaction parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue required: true schema: type: integer format: int64 requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/EditReactionOption' responses: '204': description: '' '403': description: '' '404': description: '' /repos/{owner}/{repo}/issues/{index}/stopwatch/delete: delete: tags: - issue summary: Delete an Issue's Existing Stopwatch. operationId: issueDeleteStopWatch parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue to stop the stopwatch on required: true schema: type: integer format: int64 responses: '204': description: '' '403': description: Not repo writer, user does not have rights to toggle stopwatch '404': description: '' '409': description: Cannot cancel a non-existent stopwatch /repos/{owner}/{repo}/issues/{index}/stopwatch/start: post: tags: - issue summary: Start Stopwatch on an Issue. operationId: issueStartStopWatch parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue to create the stopwatch on required: true schema: type: integer format: int64 responses: '201': description: '' '403': description: Not repo writer, user does not have rights to toggle stopwatch '404': description: '' '409': description: Cannot start a stopwatch again if it already exists /repos/{owner}/{repo}/issues/{index}/stopwatch/stop: post: tags: - issue summary: Stop an Issue's Existing Stopwatch. operationId: issueStopStopWatch parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue to stop the stopwatch on required: true schema: type: integer format: int64 responses: '201': description: '' '403': description: Not repo writer, user does not have rights to toggle stopwatch '404': description: '' '409': description: Cannot stop a non-existent stopwatch /repos/{owner}/{repo}/issues/{index}/subscriptions: get: tags: - issue summary: Get Users Who Subscribed on an Issue. operationId: issueSubscriptions parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue required: true schema: type: integer format: int64 - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/issues/{index}/subscriptions/check: get: tags: - issue summary: Check if User Is Subscribed to an Issue operationId: issueCheckSubscription parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue required: true schema: type: integer format: int64 responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/issues/{index}/subscriptions/{user}: put: tags: - issue summary: Subscribe User to Issue operationId: issueAddSubscription parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue required: true schema: type: integer format: int64 - name: user in: path description: username of the user to subscribe the issue to required: true schema: type: string responses: '200': description: Already subscribed '201': description: Successfully Subscribed '304': description: User can only subscribe itself if he is no admin '404': description: '' delete: tags: - issue summary: Unsubscribe User from Issue operationId: issueDeleteSubscription parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue required: true schema: type: integer format: int64 - name: user in: path description: username of the user to unsubscribe from an issue required: true schema: type: string responses: '200': description: Already unsubscribed '201': description: Successfully Unsubscribed '304': description: User can only subscribe itself if he is no admin '404': description: '' /repos/{owner}/{repo}/issues/{index}/timeline: get: tags: - issue summary: List All Comments and Events on an Issue operationId: issueGetCommentsAndTimeline parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue required: true schema: type: integer format: int64 - name: since in: query description: if provided, only comments updated since the specified time are returned. schema: type: string format: date-time - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer - name: before in: query description: if provided, only comments updated before the provided time are returned. schema: type: string format: date-time responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/issues/{index}/times: get: tags: - issue summary: List an Issue's Tracked Times operationId: issueTrackedTimes parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue required: true schema: type: integer format: int64 - name: user in: query description: optional filter by user (available for issue managers) schema: type: string - name: since in: query description: Only show times updated after the given time. This is a timestamp in RFC 3339 format schema: type: string format: date-time - name: before in: query description: Only show times updated before the given time. This is a timestamp in RFC 3339 format schema: type: string format: date-time - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' post: tags: - issue summary: Add Tracked Time to a Issue operationId: issueAddTime parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue required: true schema: type: integer format: int64 requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/AddTimeOption' responses: '200': description: '' '400': description: '' '403': description: '' '404': description: '' delete: tags: - issue summary: Reset a Tracked Time of an Issue operationId: issueResetTime parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue to add tracked time to required: true schema: type: integer format: int64 responses: '204': description: '' '400': description: '' '403': description: '' '404': description: '' /repos/{owner}/{repo}/issues/{index}/times/{id}: delete: tags: - issue summary: Delete Specific Tracked Time operationId: issueDeleteTime parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the issue required: true schema: type: integer format: int64 - name: id in: path description: id of time to delete required: true schema: type: integer format: int64 responses: '204': description: '' '400': description: '' '403': description: '' '404': description: '' /repos/{owner}/{repo}/keys: get: tags: - repository summary: List a Repository's Keys operationId: repoListKeys parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: key_id in: query description: the key_id to search for schema: type: integer - name: fingerprint in: query description: fingerprint of the key schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' post: tags: - repository summary: Add a Key to a Repository operationId: repoCreateKey parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreateKeyOption' responses: '201': description: '' '404': description: '' '422': description: '' /repos/{owner}/{repo}/keys/{id}: get: tags: - repository summary: Get a Repository's Key by ID operationId: repoGetKey parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of the key to get required: true schema: type: integer format: int64 responses: '200': description: '' '404': description: '' delete: tags: - repository summary: Delete a Key from a Repository operationId: repoDeleteKey parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of the key to delete required: true schema: type: integer format: int64 responses: '204': description: '' '403': description: '' '404': description: '' /repos/{owner}/{repo}/labels: get: tags: - issue summary: Get All of a Repository's Labels operationId: issueListLabels parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' post: tags: - issue summary: Create a Label operationId: issueCreateLabel parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreateLabelOption' responses: '201': description: '' '404': description: '' '422': description: '' /repos/{owner}/{repo}/labels/{id}: get: tags: - issue summary: Get a Single Label operationId: issueGetLabel parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of the label to get required: true schema: type: integer format: int64 responses: '200': description: '' '404': description: '' delete: tags: - issue summary: Delete a Label operationId: issueDeleteLabel parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of the label to delete required: true schema: type: integer format: int64 responses: '204': description: '' '404': description: '' patch: tags: - issue summary: Update a Label operationId: issueEditLabel parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of the label to edit required: true schema: type: integer format: int64 requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/EditLabelOption' responses: '200': description: '' '404': description: '' '422': description: '' /repos/{owner}/{repo}/languages: get: tags: - repository summary: Get Languages and Number of Bytes of Code Written operationId: repoGetLanguages parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/licenses: get: tags: - repository summary: Get Repo Licenses operationId: repoGetLicenses parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/media/{filepath}: get: tags: - repository summary: Get a File or It's LFS Object from a Repository operationId: repoGetRawFileOrLFS parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: filepath in: path description: path of the file to get, it should be "{ref}/{filepath}". If there is no ref could be inferred, it will be treated as the default branch required: true schema: type: string - name: ref in: query description: The name of the commit/branch/tag. Default to the repository’s default branch schema: type: string responses: '200': description: Returns raw file content. content: application/json: schema: type: file '404': description: '' /repos/{owner}/{repo}/merge-upstream: post: tags: - repository summary: Merge a Branch from Upstream operationId: repoMergeUpstream parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/MergeUpstreamRequest' responses: '200': description: '' '400': description: '' '404': description: '' /repos/{owner}/{repo}/milestones: get: tags: - issue summary: Get All of a Repository's Opened Milestones operationId: issueGetMilestonesList parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: state in: query description: Milestone state, Recognized values are open, closed and all. Defaults to "open" schema: type: string - name: name in: query description: filter by milestone name schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' post: tags: - issue summary: Create a Milestone operationId: issueCreateMilestone parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreateMilestoneOption' responses: '201': description: '' '404': description: '' /repos/{owner}/{repo}/milestones/{id}: get: tags: - issue summary: Get a Milestone operationId: issueGetMilestone parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: the milestone to get, identified by ID and if not available by name required: true schema: type: string responses: '200': description: '' '404': description: '' delete: tags: - issue summary: Delete a Milestone operationId: issueDeleteMilestone parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: the milestone to delete, identified by ID and if not available by name required: true schema: type: string responses: '204': description: '' '404': description: '' patch: tags: - issue summary: Update a Milestone operationId: issueEditMilestone parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: the milestone to edit, identified by ID and if not available by name required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/EditMilestoneOption' responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/mirror-sync: post: tags: - repository summary: Sync a Mirrored Repository operationId: repoMirrorSync parameters: - name: owner in: path description: owner of the repo to sync required: true schema: type: string - name: repo in: path description: name of the repo to sync required: true schema: type: string responses: '200': description: '' '403': description: '' '404': description: '' /repos/{owner}/{repo}/new_pin_allowed: get: tags: - repository summary: Returns if New Issue Pins Are Allowed operationId: repoNewPinAllowed parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/notifications: get: tags: - notification summary: List Users's Notification Threads on a Specific Repo operationId: notifyGetRepoList parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: all in: query description: If true, show notifications marked as read. Default value is false schema: type: boolean - name: status-types in: query description: 'Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned' schema: type: array items: type: string - name: subject-type in: query description: filter notifications by subject type schema: type: array items: enum: - issue - pull - commit - repository type: string - name: since in: query description: Only show notifications updated after the given time. This is a timestamp in RFC 3339 format schema: type: string format: date-time - name: before in: query description: Only show notifications updated before the given time. This is a timestamp in RFC 3339 format schema: type: string format: date-time - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' put: tags: - notification summary: Mark Notification Threads as Read, Pinned or Unread on a Specific Repo operationId: notifyReadRepoList parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: all in: query description: If true, mark all notifications on this repo. Default value is false schema: type: string - name: status-types in: query description: 'Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.' schema: type: array items: type: string - name: to-status in: query description: Status to mark notifications as. Defaults to read. schema: type: string - name: last_read_at in: query description: Describes the last point that notifications were checked. Anything updated since this time will not be updated. schema: type: string format: date-time responses: '205': description: '' /repos/{owner}/{repo}/pulls: get: tags: - repository summary: List a Repo's Pull Requests operationId: repoListPullRequests parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: Name of the repo required: true schema: type: string - name: base_branch in: query description: Filter by target base branch of the pull request schema: type: string - name: state in: query description: State of pull request schema: enum: - open - closed - all type: string default: open - name: sort in: query description: Type of sort schema: enum: - oldest - recentupdate - recentclose - leastupdate - mostcomment - leastcomment - priority type: string - name: milestone in: query description: ID of the milestone schema: type: integer format: int64 - name: labels in: query description: Label IDs schema: type: array items: type: integer format: int64 - name: poster in: query description: Filter by pull request author schema: type: string - name: page in: query description: Page number of results to return (1-based) schema: minimum: 1 type: integer default: 1 - name: limit in: query description: Page size of results schema: minimum: 0 type: integer responses: '200': description: '' '404': description: '' '500': description: '' post: tags: - repository summary: Create a Pull Request operationId: repoCreatePullRequest parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreatePullRequestOption' responses: '201': description: '' '403': description: '' '404': description: '' '409': description: '' '422': description: '' '423': description: '' /repos/{owner}/{repo}/pulls/comments/{id}/resolve: post: tags: - repository summary: Resolve a Pull Request Review Comment operationId: repoResolvePullReviewComment parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of the review comment required: true schema: type: integer format: int64 responses: '204': description: '' '400': description: '' '403': description: '' '404': description: '' /repos/{owner}/{repo}/pulls/comments/{id}/unresolve: post: tags: - repository summary: Unresolve a Pull Request Review Comment operationId: repoUnresolvePullReviewComment parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of the review comment required: true schema: type: integer format: int64 responses: '204': description: '' '400': description: '' '403': description: '' '404': description: '' /repos/{owner}/{repo}/pulls/pinned: get: tags: - repository summary: List a Repo's Pinned Pull Requests operationId: repoListPinnedPullRequests parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/pulls/{base}/{head}: get: tags: - repository summary: Get a Pull Request by Base and Head operationId: repoGetPullRequestByBaseHead parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: base in: path description: base of the pull request to get required: true schema: type: string - name: head in: path description: head of the pull request to get required: true schema: type: string responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/pulls/{index}: get: tags: - repository summary: Get a Pull Request operationId: repoGetPullRequest parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the pull request to get required: true schema: type: integer format: int64 responses: '200': description: '' '404': description: '' patch: tags: - repository summary: Update a Pull Request. if Using Deadline Only the Date Will Be Taken Into Account, and Time of Day Ignored. operationId: repoEditPullRequest parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the pull request to edit required: true schema: type: integer format: int64 requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/EditPullRequestOption' responses: '201': description: '' '403': description: '' '404': description: '' '409': description: '' '412': description: '' '422': description: '' /repos/{owner}/{repo}/pulls/{index}.{diffType}: get: tags: - repository summary: Get a Pull Request Diff or Patch operationId: repoDownloadPullDiffOrPatch parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the pull request to get required: true schema: type: integer format: int64 - name: diffType in: path description: whether the output is diff or patch required: true schema: enum: - diff - patch type: string - name: binary in: query description: whether to include binary file changes. if true, the diff is applicable with `git apply` schema: type: boolean responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/pulls/{index}/commits: get: tags: - repository summary: Get Commits for a Pull Request operationId: repoGetPullRequestCommits parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the pull request to get required: true schema: type: integer format: int64 - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer - name: verification in: query description: include verification for every commit (disable for speedup, default 'true') schema: type: boolean - name: files in: query description: include a list of affected files for every commit (disable for speedup, default 'true') schema: type: boolean responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/pulls/{index}/files: get: tags: - repository summary: Get Changed Files for a Pull Request operationId: repoGetPullRequestFiles parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the pull request to get required: true schema: type: integer format: int64 - name: skip-to in: query description: skip to given file schema: type: string - name: whitespace in: query description: whitespace behavior schema: enum: - ignore-all - ignore-change - ignore-eol - show-all type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/pulls/{index}/merge: get: tags: - repository summary: Check if a Pull Request Has Been Merged operationId: repoPullRequestIsMerged parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the pull request required: true schema: type: integer format: int64 responses: '204': description: pull request has been merged '404': description: pull request has not been merged post: tags: - repository summary: Merge a Pull Request operationId: repoMergePullRequest parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the pull request to merge required: true schema: type: integer format: int64 requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/MergePullRequestOption' responses: '200': description: '' '403': description: '' '404': description: '' '405': description: '' '409': description: '' '423': description: '' delete: tags: - repository summary: Cancel the Scheduled Auto Merge for the Given Pull Request operationId: repoCancelScheduledAutoMerge parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the pull request to merge required: true schema: type: integer format: int64 responses: '204': description: '' '403': description: '' '404': description: '' '423': description: '' /repos/{owner}/{repo}/pulls/{index}/requested_reviewers: post: tags: - repository summary: Create Review Requests for a Pull Request operationId: repoCreatePullReviewRequests parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the pull request required: true schema: type: integer format: int64 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PullReviewRequestOptions' responses: '201': description: '' '404': description: '' '422': description: '' delete: tags: - repository summary: Cancel Review Requests for a Pull Request operationId: repoDeletePullReviewRequests parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the pull request required: true schema: type: integer format: int64 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PullReviewRequestOptions' responses: '204': description: '' '403': description: '' '404': description: '' '422': description: '' /repos/{owner}/{repo}/pulls/{index}/reviews: get: tags: - repository summary: List All Reviews for a Pull Request operationId: repoListPullReviews parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the pull request required: true schema: type: integer format: int64 - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' post: tags: - repository summary: Create a Review to a Pull Request operationId: repoCreatePullReview parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the pull request required: true schema: type: integer format: int64 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreatePullReviewOptions' responses: '200': description: '' '404': description: '' '422': description: '' /repos/{owner}/{repo}/pulls/{index}/reviews/{id}: get: tags: - repository summary: Get a Specific Review for a Pull Request operationId: repoGetPullReview parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the pull request required: true schema: type: integer format: int64 - name: id in: path description: id of the review required: true schema: type: integer format: int64 responses: '200': description: '' '404': description: '' post: tags: - repository summary: Submit a Pending Review to a Pull Request operationId: repoSubmitPullReview parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the pull request required: true schema: type: integer format: int64 - name: id in: path description: id of the review required: true schema: type: integer format: int64 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SubmitPullReviewOptions' responses: '200': description: '' '404': description: '' '422': description: '' delete: tags: - repository summary: Delete a Specific Review from a Pull Request operationId: repoDeletePullReview parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the pull request required: true schema: type: integer format: int64 - name: id in: path description: id of the review required: true schema: type: integer format: int64 responses: '204': description: '' '403': description: '' '404': description: '' /repos/{owner}/{repo}/pulls/{index}/reviews/{id}/comments: get: tags: - repository summary: Get a Specific Review for a Pull Request operationId: repoGetPullReviewComments parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the pull request required: true schema: type: integer format: int64 - name: id in: path description: id of the review required: true schema: type: integer format: int64 responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/pulls/{index}/reviews/{id}/dismissals: post: tags: - repository summary: Dismiss a Review for a Pull Request operationId: repoDismissPullReview parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the pull request required: true schema: type: integer format: int64 - name: id in: path description: id of the review required: true schema: type: integer format: int64 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DismissPullReviewOptions' responses: '200': description: '' '403': description: '' '404': description: '' '422': description: '' /repos/{owner}/{repo}/pulls/{index}/reviews/{id}/undismissals: post: tags: - repository summary: Cancel to Dismiss a Review for a Pull Request operationId: repoUnDismissPullReview parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the pull request required: true schema: type: integer format: int64 - name: id in: path description: id of the review required: true schema: type: integer format: int64 responses: '200': description: '' '403': description: '' '404': description: '' '422': description: '' /repos/{owner}/{repo}/pulls/{index}/update: post: tags: - repository summary: Merge PR's BaseBranch Into HeadBranch operationId: repoUpdatePullRequest parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: index in: path description: index of the pull request to get required: true schema: type: integer format: int64 - name: style in: query description: how to update pull request schema: enum: - merge - rebase type: string responses: '200': description: '' '403': description: '' '404': description: '' '409': description: '' '422': description: '' /repos/{owner}/{repo}/push_mirrors: get: tags: - repository summary: Get All Push Mirrors of the Repository operationId: repoListPushMirrors parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '400': description: '' '403': description: '' '404': description: '' post: tags: - repository summary: Add a Push Mirror to the Repository operationId: repoAddPushMirror parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreatePushMirrorOption' responses: '200': description: '' '400': description: '' '403': description: '' '404': description: '' /repos/{owner}/{repo}/push_mirrors-sync: post: tags: - repository summary: Sync All Push Mirrored Repository operationId: repoPushMirrorSync parameters: - name: owner in: path description: owner of the repo to sync required: true schema: type: string - name: repo in: path description: name of the repo to sync required: true schema: type: string responses: '200': description: '' '400': description: '' '403': description: '' '404': description: '' /repos/{owner}/{repo}/push_mirrors/{name}: get: tags: - repository summary: Get Push Mirror of the Repository by RemoteName operationId: repoGetPushMirrorByRemoteName parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: name in: path description: remote name of push mirror required: true schema: type: string responses: '200': description: '' '400': description: '' '403': description: '' '404': description: '' delete: tags: - repository summary: Deletes a Push Mirror from a Repository by RemoteName operationId: repoDeletePushMirror parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: name in: path description: remote name of the pushMirror required: true schema: type: string responses: '204': description: '' '400': description: '' '404': description: '' /repos/{owner}/{repo}/raw/{filepath}: get: tags: - repository summary: Get a File from a Repository operationId: repoGetRawFile parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: filepath in: path description: path of the file to get, it should be "{ref}/{filepath}". If there is no ref could be inferred, it will be treated as the default branch required: true schema: type: string - name: ref in: query description: The name of the commit/branch/tag. Default to the repository’s default branch schema: type: string responses: '200': description: Returns raw file content. content: application/json: schema: type: file '404': description: '' /repos/{owner}/{repo}/releases: get: tags: - repository summary: List a Repo's Releases operationId: repoListReleases parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: draft in: query description: filter (exclude / include) drafts, if you don't have repo write access none will show schema: type: boolean - name: pre-release in: query description: filter (exclude / include) pre-releases schema: type: boolean - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' post: tags: - repository summary: Create a Release operationId: repoCreateRelease parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreateReleaseOption' responses: '201': description: '' '404': description: '' '409': description: '' '422': description: '' /repos/{owner}/{repo}/releases/latest: get: tags: - repository summary: Gets the Most Recent Non-Prerelease, Non-Draft Release of a Repository, Sorted by Created_at operationId: repoGetLatestRelease parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/releases/tags/{tag}: get: tags: - repository summary: Get a Release by Tag Name operationId: repoGetReleaseByTag parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: tag in: path description: tag name of the release to get required: true schema: type: string responses: '200': description: '' '404': description: '' delete: tags: - repository summary: Delete a Release by Tag Name operationId: repoDeleteReleaseByTag parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: tag in: path description: tag name of the release to delete required: true schema: type: string responses: '204': description: '' '404': description: '' '422': description: '' /repos/{owner}/{repo}/releases/{id}: get: tags: - repository summary: Get a Release operationId: repoGetRelease parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of the release to get required: true schema: type: integer format: int64 responses: '200': description: '' '404': description: '' delete: tags: - repository summary: Delete a Release operationId: repoDeleteRelease parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of the release to delete required: true schema: type: integer format: int64 responses: '204': description: '' '404': description: '' '422': description: '' patch: tags: - repository summary: Update a Release operationId: repoEditRelease parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of the release to edit required: true schema: type: integer format: int64 requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/EditReleaseOption' responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/releases/{id}/assets: get: tags: - repository summary: List Release's Attachments operationId: repoListReleaseAttachments parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of the release required: true schema: type: integer format: int64 responses: '200': description: '' '404': description: '' post: tags: - repository summary: Create a Release Attachment operationId: repoCreateReleaseAttachment parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of the release required: true schema: type: integer format: int64 - name: name in: query description: name of the attachment schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: attachment: type: file description: attachment to upload required: [] responses: '201': description: '' '400': description: '' '404': description: '' '413': description: '' /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}: get: tags: - repository summary: Get a Release Attachment operationId: repoGetReleaseAttachment parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of the release required: true schema: type: integer format: int64 - name: attachment_id in: path description: id of the attachment to get required: true schema: type: integer format: int64 responses: '200': description: '' '404': description: '' delete: tags: - repository summary: Delete a Release Attachment operationId: repoDeleteReleaseAttachment parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of the release required: true schema: type: integer format: int64 - name: attachment_id in: path description: id of the attachment to delete required: true schema: type: integer format: int64 responses: '204': description: '' '404': description: '' patch: tags: - repository summary: Edit a Release Attachment operationId: repoEditReleaseAttachment parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of the release required: true schema: type: integer format: int64 - name: attachment_id in: path description: id of the attachment to edit required: true schema: type: integer format: int64 requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/EditAttachmentOptions' responses: '201': description: '' '404': description: '' '422': description: '' /repos/{owner}/{repo}/reviewers: get: tags: - repository summary: Return All Users That Can Be Requested to Review in This Repo operationId: repoGetReviewers parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/signing-key.gpg: get: tags: - repository summary: Get Signing-Key.gpg for Given Repository operationId: repoSigningKey parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string responses: '200': description: GPG armored public key content: application/json: schema: type: string /repos/{owner}/{repo}/signing-key.pub: get: tags: - repository summary: Get Signing-Key.pub for Given Repository operationId: repoSigningKeySSH parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string responses: '200': description: ssh public key content: application/json: schema: type: string /repos/{owner}/{repo}/stargazers: get: tags: - repository summary: List a Repo's Stargazers operationId: repoListStargazers parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '403': description: '' '404': description: '' /repos/{owner}/{repo}/statuses/{sha}: get: tags: - repository summary: Get a Commit's Statuses operationId: repoListStatuses parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: sha in: path description: sha of the commit required: true schema: type: string - name: sort in: query description: type of sort schema: enum: - oldest - recentupdate - leastupdate - leastindex - highestindex type: string - name: state in: query description: type of state schema: enum: - pending - success - error - failure - warning type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '400': description: '' '404': description: '' post: tags: - repository summary: Create a Commit Status operationId: repoCreateStatus parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: sha in: path description: sha of the commit required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreateStatusOption' responses: '201': description: '' '400': description: '' '404': description: '' /repos/{owner}/{repo}/subscribers: get: tags: - repository summary: List a Repo's Watchers operationId: repoListSubscribers parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/subscription: get: tags: - repository summary: Check if the Current User Is Watching a Repo operationId: userCurrentCheckSubscription parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string responses: '200': description: '' '404': description: User is not watching this repo or repo do not exist put: tags: - repository summary: Watch a Repo operationId: userCurrentPutSubscription parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string responses: '200': description: '' '403': description: '' '404': description: '' delete: tags: - repository summary: Unwatch a Repo operationId: userCurrentDeleteSubscription parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string responses: '204': description: '' '404': description: '' /repos/{owner}/{repo}/tag_protections: get: tags: - repository summary: List Tag Protections for a Repository operationId: repoListTagProtection parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string responses: '200': description: '' post: tags: - repository summary: Create a Tag Protections for a Repository operationId: repoCreateTagProtection parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreateTagProtectionOption' responses: '201': description: '' '403': description: '' '404': description: '' '422': description: '' '423': description: '' /repos/{owner}/{repo}/tag_protections/{id}: get: tags: - repository summary: Get a Specific Tag Protection for the Repository operationId: repoGetTagProtection parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of the tag protect to get required: true schema: type: integer responses: '200': description: '' '404': description: '' delete: tags: - repository summary: Delete a Specific Tag Protection for the Repository operationId: repoDeleteTagProtection parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of protected tag required: true schema: type: integer responses: '204': description: '' '404': description: '' patch: tags: - repository summary: Edit a Tag Protections for a Repository. Only Fields That Are Set Will Be Changed operationId: repoEditTagProtection parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: id in: path description: id of protected tag required: true schema: type: integer requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/EditTagProtectionOption' responses: '200': description: '' '404': description: '' '422': description: '' '423': description: '' /repos/{owner}/{repo}/tags: get: tags: - repository summary: List a Repository's Tags operationId: repoListTags parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results, default maximum page size is 50 schema: type: integer responses: '200': description: '' '404': description: '' post: tags: - repository summary: Create a New Git Tag in a Repository operationId: repoCreateTag parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreateTagOption' responses: '200': description: '' '404': description: '' '405': description: '' '409': description: '' '422': description: '' '423': description: '' /repos/{owner}/{repo}/tags/{tag}: get: tags: - repository summary: Get the Tag of a Repository by Tag Name operationId: repoGetTag parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: tag in: path description: name of tag required: true schema: type: string responses: '200': description: '' '404': description: '' delete: tags: - repository summary: Delete a Repository's Tag by Name operationId: repoDeleteTag parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: tag in: path description: name of tag to delete required: true schema: type: string responses: '204': description: '' '404': description: '' '405': description: '' '409': description: '' '422': description: '' '423': description: '' /repos/{owner}/{repo}/teams: get: tags: - repository summary: List a Repository's Teams operationId: repoListTeams parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/teams/{team}: get: tags: - repository summary: Check if a Team Is Assigned to a Repository operationId: repoCheckTeam parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: team in: path description: team name required: true schema: type: string responses: '200': description: '' '404': description: '' '405': description: '' put: tags: - repository summary: Add a Team to a Repository operationId: repoAddTeam parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: team in: path description: team name required: true schema: type: string responses: '204': description: '' '404': description: '' '405': description: '' '422': description: '' delete: tags: - repository summary: Delete a Team from a Repository operationId: repoDeleteTeam parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: team in: path description: team name required: true schema: type: string responses: '204': description: '' '404': description: '' '405': description: '' '422': description: '' /repos/{owner}/{repo}/times: get: tags: - repository summary: List a Repo's Tracked Times operationId: repoTrackedTimes parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: user in: query description: optional filter by user (available for issue managers) schema: type: string - name: since in: query description: Only show times updated after the given time. This is a timestamp in RFC 3339 format schema: type: string format: date-time - name: before in: query description: Only show times updated before the given time. This is a timestamp in RFC 3339 format schema: type: string format: date-time - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '400': description: '' '403': description: '' '404': description: '' /repos/{owner}/{repo}/times/{user}: get: tags: - repository summary: List a User's Tracked Times in a Repo operationId: userTrackedTimes parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: user in: path description: username of the user whose tracked times are to be listed required: true schema: type: string responses: '200': description: '' '400': description: '' '403': description: '' '404': description: '' /repos/{owner}/{repo}/topics: get: tags: - repository summary: Get List of Topics That a Repository Has operationId: repoListTopics parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' put: tags: - repository summary: Replace List of Topics for a Repository operationId: repoUpdateTopics parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/RepoTopicOptions' responses: '204': description: '' '404': description: '' '422': description: '' /repos/{owner}/{repo}/topics/{topic}: put: tags: - repository summary: Add a Topic to a Repository operationId: repoAddTopic parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: topic in: path description: name of the topic to add required: true schema: type: string responses: '204': description: '' '404': description: '' '422': description: '' delete: tags: - repository summary: Delete a Topic from a Repository operationId: repoDeleteTopic parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: topic in: path description: name of the topic to delete required: true schema: type: string responses: '204': description: '' '404': description: '' '422': description: '' /repos/{owner}/{repo}/transfer: post: tags: - repository summary: Transfer a Repo Ownership operationId: repoTransfer parameters: - name: owner in: path description: owner of the repo to transfer required: true schema: type: string - name: repo in: path description: name of the repo to transfer required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TransferRepoOption' description: Transfer Options responses: '202': description: '' '403': description: '' '404': description: '' '422': description: '' /repos/{owner}/{repo}/transfer/accept: post: tags: - repository summary: Accept a Repo Transfer operationId: acceptRepoTransfer parameters: - name: owner in: path description: owner of the repo to transfer required: true schema: type: string - name: repo in: path description: name of the repo to transfer required: true schema: type: string responses: '202': description: '' '403': description: '' '404': description: '' /repos/{owner}/{repo}/transfer/reject: post: tags: - repository summary: Reject a Repo Transfer operationId: rejectRepoTransfer parameters: - name: owner in: path description: owner of the repo to transfer required: true schema: type: string - name: repo in: path description: name of the repo to transfer required: true schema: type: string responses: '200': description: '' '403': description: '' '404': description: '' /repos/{owner}/{repo}/wiki/new: post: tags: - repository summary: Create a Wiki Page operationId: repoCreateWikiPage parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreateWikiPageOptions' responses: '201': description: '' '400': description: '' '403': description: '' '404': description: '' '423': description: '' /repos/{owner}/{repo}/wiki/page/{pageName}: get: tags: - repository summary: Get a Wiki Page operationId: repoGetWikiPage parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: pageName in: path description: name of the page required: true schema: type: string responses: '200': description: '' '404': description: '' delete: tags: - repository summary: Delete a Wiki Page operationId: repoDeleteWikiPage parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: pageName in: path description: name of the page required: true schema: type: string responses: '204': description: '' '403': description: '' '404': description: '' '423': description: '' patch: tags: - repository summary: Edit a Wiki Page operationId: repoEditWikiPage parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: pageName in: path description: name of the page required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreateWikiPageOptions' responses: '200': description: '' '400': description: '' '403': description: '' '404': description: '' '423': description: '' /repos/{owner}/{repo}/wiki/pages: get: tags: - repository summary: Get All Wiki Pages operationId: repoGetWikiPages parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' /repos/{owner}/{repo}/wiki/revisions/{pageName}: get: tags: - repository summary: Get Revisions of a Wiki Page operationId: repoGetWikiPageRevisions parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string - name: pageName in: path description: name of the page required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer responses: '200': description: '' '404': description: '' /repos/{template_owner}/{template_repo}/generate: post: tags: - repository summary: Create a Repository Using a Template operationId: generateRepo parameters: - name: template_owner in: path description: owner of the template repository required: true schema: type: string - name: template_repo in: path description: name of the template repository required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/GenerateRepoOption' responses: '201': description: '' '403': description: '' '404': description: '' '409': description: The repository with the same name already exists. '422': description: '' /repositories/{id}: get: tags: - repository summary: Get a Repository by ID operationId: repoGetByID parameters: - name: id in: path description: id of the repo to get required: true schema: type: integer format: int64 responses: '200': description: '' '404': description: '' /settings/api: get: tags: - settings summary: Get Instance's Global Settings for API operationId: getGeneralAPISettings responses: '200': description: '' /settings/attachment: get: tags: - settings summary: Get Instance's Global Settings for Attachment operationId: getGeneralAttachmentSettings responses: '200': description: '' /settings/repository: get: tags: - settings summary: Get Instance's Global Settings for Repositories operationId: getGeneralRepositorySettings responses: '200': description: '' /settings/ui: get: tags: - settings summary: Get Instance's Global Settings for Ui operationId: getGeneralUISettings responses: '200': description: '' /signing-key.gpg: get: tags: - miscellaneous summary: Get Default Signing-Key.gpg operationId: getSigningKey responses: '200': description: GPG armored public key content: application/json: schema: type: string /signing-key.pub: get: tags: - miscellaneous summary: Get Default Signing-Key.pub operationId: getSigningKeySSH responses: '200': description: ssh public key content: application/json: schema: type: string /teams/{id}: get: tags: - organization summary: Get a Team operationId: orgGetTeam parameters: - name: id in: path description: id of the team to get required: true schema: type: integer format: int64 responses: '200': description: '' '404': description: '' delete: tags: - organization summary: Delete a Team operationId: orgDeleteTeam parameters: - name: id in: path description: id of the team to delete required: true schema: type: integer format: int64 responses: '204': description: team deleted '404': description: '' patch: tags: - organization summary: Edit a Team operationId: orgEditTeam parameters: - name: id in: path description: id of the team to edit required: true schema: type: integer requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/EditTeamOption' responses: '200': description: '' '404': description: '' /teams/{id}/activities/feeds: get: tags: - organization summary: List a Team's Activity Feeds operationId: orgListTeamActivityFeeds parameters: - name: id in: path description: id of the team required: true schema: type: integer format: int64 - name: date in: query description: the date of the activities to be found schema: type: string format: date - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' /teams/{id}/members: get: tags: - organization summary: List a Team's Members operationId: orgListTeamMembers parameters: - name: id in: path description: id of the team required: true schema: type: integer format: int64 - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' /teams/{id}/members/{username}: get: tags: - organization summary: List a Particular Member of Team operationId: orgListTeamMember parameters: - name: id in: path description: id of the team required: true schema: type: integer format: int64 - name: username in: path description: username of the user whose data is to be listed required: true schema: type: string responses: '200': description: '' '404': description: '' put: tags: - organization summary: Add a Team Member operationId: orgAddTeamMember parameters: - name: id in: path description: id of the team required: true schema: type: integer format: int64 - name: username in: path description: username of the user to add to a team required: true schema: type: string responses: '204': description: '' '403': description: '' '404': description: '' delete: tags: - organization summary: Remove a Team Member operationId: orgRemoveTeamMember parameters: - name: id in: path description: id of the team required: true schema: type: integer format: int64 - name: username in: path description: username of the user to remove from a team required: true schema: type: string responses: '204': description: '' '404': description: '' /teams/{id}/repos: get: tags: - organization summary: List a Team's Repos operationId: orgListTeamRepos parameters: - name: id in: path description: id of the team required: true schema: type: integer format: int64 - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' /teams/{id}/repos/{org}/{repo}: get: tags: - organization summary: List a Particular Repo of Team operationId: orgListTeamRepo parameters: - name: id in: path description: id of the team required: true schema: type: integer format: int64 - name: org in: path description: organization that owns the repo to list required: true schema: type: string - name: repo in: path description: name of the repo to list required: true schema: type: string responses: '200': description: '' '404': description: '' put: tags: - organization summary: Add a Repository to a Team operationId: orgAddTeamRepository parameters: - name: id in: path description: id of the team required: true schema: type: integer format: int64 - name: org in: path description: organization that owns the repo to add required: true schema: type: string - name: repo in: path description: name of the repo to add required: true schema: type: string responses: '204': description: '' '403': description: '' '404': description: '' delete: tags: - organization summary: Remove a Repository from a Team operationId: orgRemoveTeamRepository description: This does not delete the repository, it only removes the repository from the team. parameters: - name: id in: path description: id of the team required: true schema: type: integer format: int64 - name: org in: path description: organization that owns the repo to remove required: true schema: type: string - name: repo in: path description: name of the repo to remove required: true schema: type: string responses: '204': description: '' '403': description: '' '404': description: '' /topics/search: get: tags: - repository summary: Search Topics via Keyword operationId: topicSearch parameters: - name: q in: query description: keywords to search required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '403': description: '' '404': description: '' /user: get: tags: - user summary: Get the Authenticated User operationId: userGetCurrent responses: '200': description: '' /user/actions/jobs: get: tags: - user summary: Get Workflow Jobs operationId: getUserWorkflowJobs parameters: - name: status in: query description: workflow status (pending, queued, in_progress, failure, success, skipped) schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '400': description: '' '404': description: '' /user/actions/runners: get: tags: - user summary: Get User-Level Runners operationId: getUserRunners parameters: - name: disabled in: query description: filter by disabled status (true or false) schema: type: boolean responses: '200': description: '' '400': description: '' '404': description: '' /user/actions/runners/registration-token: post: tags: - user summary: Get a User's Actions Runner Registration Token operationId: userCreateRunnerRegistrationToken responses: '200': description: '' /user/actions/runners/{runner_id}: get: tags: - user summary: Get a User-Level Runner operationId: getUserRunner parameters: - name: runner_id in: path description: id of the runner required: true schema: type: string responses: '200': description: '' '400': description: '' '404': description: '' delete: tags: - user summary: Delete a User-Level Runner operationId: deleteUserRunner parameters: - name: runner_id in: path description: id of the runner required: true schema: type: string responses: '204': description: runner has been deleted '400': description: '' '404': description: '' patch: tags: - user summary: Update a User-Level Runner operationId: updateUserRunner parameters: - name: runner_id in: path description: id of the runner required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/EditActionRunnerOption' responses: '200': description: '' '400': description: '' '404': description: '' '422': description: '' /user/actions/runs: get: tags: - user summary: Get Workflow Runs operationId: getUserWorkflowRuns parameters: - name: event in: query description: workflow event name schema: type: string - name: branch in: query description: workflow branch schema: type: string - name: status in: query description: workflow status (pending, queued, in_progress, failure, success, skipped) schema: type: string - name: actor in: query description: triggered by user schema: type: string - name: head_sha in: query description: triggering sha of the workflow run schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '400': description: '' '404': description: '' /user/actions/secrets/{secretname}: put: tags: - user summary: Create or Update a Secret Value in a User Scope operationId: updateUserSecret parameters: - name: secretname in: path description: name of the secret required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreateOrUpdateSecretOption' responses: '201': description: response when creating a secret '204': description: response when updating a secret '400': description: '' '404': description: '' delete: tags: - user summary: Delete a Secret in a User Scope operationId: deleteUserSecret parameters: - name: secretname in: path description: name of the secret required: true schema: type: string responses: '204': description: delete one secret of the user '400': description: '' '404': description: '' /user/actions/variables: get: tags: - user summary: Get the User-Level List of Variables Which Is Created by Current Doer operationId: getUserVariablesList parameters: - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '400': description: '' '404': description: '' /user/actions/variables/{variablename}: get: tags: - user summary: Get a User-Level Variable Which Is Created by Current Doer operationId: getUserVariable parameters: - name: variablename in: path description: name of the variable required: true schema: type: string responses: '200': description: '' '400': description: '' '404': description: '' put: tags: - user summary: Update a User-Level Variable Which Is Created by Current Doer operationId: updateUserVariable parameters: - name: variablename in: path description: name of the variable required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/UpdateVariableOption' responses: '201': description: response when updating a variable '204': description: response when updating a variable '400': description: '' '404': description: '' post: tags: - user summary: Create a User-Level Variable operationId: createUserVariable parameters: - name: variablename in: path description: name of the variable required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreateVariableOption' responses: '201': description: successfully created the user-level variable '400': description: '' '409': description: variable name already exists. delete: tags: - user summary: Delete a User-Level Variable Which Is Created by Current Doer operationId: deleteUserVariable parameters: - name: variablename in: path description: name of the variable required: true schema: type: string responses: '201': description: response when deleting a variable '204': description: response when deleting a variable '400': description: '' '404': description: '' /user/applications/oauth2: get: tags: - user summary: List the Authenticated User's OAuth2 Applications operationId: userGetOauth2Application parameters: - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' post: tags: - user summary: Creates a New OAuth2 Application operationId: userCreateOAuth2Application requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateOAuth2ApplicationOptions' responses: '201': description: '' '400': description: '' /user/applications/oauth2/{id}: get: tags: - user summary: Get an OAuth2 Application operationId: userGetOAuth2Application parameters: - name: id in: path description: Application ID to be found required: true schema: type: integer format: int64 responses: '200': description: '' '404': description: '' delete: tags: - user summary: Delete an OAuth2 Application operationId: userDeleteOAuth2Application parameters: - name: id in: path description: token to be deleted required: true schema: type: integer format: int64 responses: '204': description: '' '404': description: '' patch: tags: - user summary: Update an OAuth2 Application, This Includes Regenerating the Client Secret operationId: userUpdateOAuth2Application parameters: - name: id in: path description: application to be updated required: true schema: type: integer format: int64 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateOAuth2ApplicationOptions' responses: '200': description: '' '404': description: '' /user/avatar: post: tags: - user summary: Update Avatar operationId: userUpdateAvatar requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/UpdateUserAvatarOption' responses: '204': description: '' delete: tags: - user summary: Delete Avatar operationId: userDeleteAvatar responses: '204': description: '' /user/blocks: get: tags: - user summary: List Users Blocked by the Authenticated User operationId: userListBlocks parameters: - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' /user/blocks/{username}: get: tags: - user summary: Check if a User Is Blocked by the Authenticated User operationId: userCheckUserBlock parameters: - name: username in: path description: username of the user to check required: true schema: type: string responses: '204': description: '' '404': description: '' put: tags: - user summary: Block a User operationId: userBlockUser parameters: - name: username in: path description: username of the user to block required: true schema: type: string - name: note in: query description: optional note for the block schema: type: string responses: '204': description: '' '404': description: '' '422': description: '' delete: tags: - user summary: Unblock a User operationId: userUnblockUser parameters: - name: username in: path description: username of the user to unblock required: true schema: type: string responses: '204': description: '' '404': description: '' '422': description: '' /user/emails: get: tags: - user summary: List the Authenticated User's Email Addresses operationId: userListEmails responses: '200': description: '' post: tags: - user summary: Add Email Addresses operationId: userAddEmail requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreateEmailOption' responses: '201': description: '' '422': description: '' delete: tags: - user summary: Delete Email Addresses operationId: userDeleteEmail requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/DeleteEmailOption' responses: '204': description: '' '404': description: '' /user/followers: get: tags: - user summary: List the Authenticated User's Followers operationId: userCurrentListFollowers parameters: - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' /user/following: get: tags: - user summary: List the Users That the Authenticated User Is Following operationId: userCurrentListFollowing parameters: - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' /user/following/{username}: get: tags: - user summary: Check Whether a User Is Followed by the Authenticated User operationId: userCurrentCheckFollowing parameters: - name: username in: path description: username of the user to check for authenticated followers required: true schema: type: string responses: '204': description: '' '404': description: '' put: tags: - user summary: Follow a User operationId: userCurrentPutFollow parameters: - name: username in: path description: username of the user to follow required: true schema: type: string responses: '204': description: '' '403': description: '' '404': description: '' delete: tags: - user summary: Unfollow a User operationId: userCurrentDeleteFollow parameters: - name: username in: path description: username of the user to unfollow required: true schema: type: string responses: '204': description: '' '404': description: '' /user/gpg_key_token: get: tags: - user summary: Get a Token to Verify operationId: getVerificationToken responses: '200': description: '' '404': description: '' /user/gpg_key_verify: post: tags: - user summary: Verify a GPG Key operationId: userVerifyGPGKey responses: '201': description: '' '404': description: '' '422': description: '' /user/gpg_keys: get: tags: - user summary: List the Authenticated User's GPG Keys operationId: userCurrentListGPGKeys parameters: - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' post: tags: - user summary: Create a GPG Key operationId: userCurrentPostGPGKey requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreateGPGKeyOption' responses: '201': description: '' '404': description: '' '422': description: '' /user/gpg_keys/{id}: get: tags: - user summary: Get a GPG Key operationId: userCurrentGetGPGKey parameters: - name: id in: path description: id of key to get required: true schema: type: integer format: int64 responses: '200': description: '' '404': description: '' delete: tags: - user summary: Remove a GPG Key operationId: userCurrentDeleteGPGKey parameters: - name: id in: path description: id of key to delete required: true schema: type: integer format: int64 responses: '204': description: '' '403': description: '' '404': description: '' /user/hooks: get: tags: - user summary: List the Authenticated User's Webhooks operationId: userListHooks parameters: - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' post: tags: - user summary: Create a Hook operationId: userCreateHook requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateHookOption' responses: '201': description: '' /user/hooks/{id}: get: tags: - user summary: Get a Hook operationId: userGetHook parameters: - name: id in: path description: id of the hook to get required: true schema: type: integer format: int64 responses: '200': description: '' delete: tags: - user summary: Delete a Hook operationId: userDeleteHook parameters: - name: id in: path description: id of the hook to delete required: true schema: type: integer format: int64 responses: '204': description: '' patch: tags: - user summary: Update a Hook operationId: userEditHook parameters: - name: id in: path description: id of the hook to update required: true schema: type: integer format: int64 requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/EditHookOption' responses: '200': description: '' /user/keys: get: tags: - user summary: List the Authenticated User's Public Keys operationId: userCurrentListKeys parameters: - name: fingerprint in: query description: fingerprint of the key schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' post: tags: - user summary: Create a Public Key operationId: userCurrentPostKey requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreateKeyOption' responses: '201': description: '' '422': description: '' /user/keys/{id}: get: tags: - user summary: Get a Public Key operationId: userCurrentGetKey parameters: - name: id in: path description: id of key to get required: true schema: type: integer format: int64 responses: '200': description: '' '404': description: '' delete: tags: - user summary: Delete a Public Key operationId: userCurrentDeleteKey parameters: - name: id in: path description: id of key to delete required: true schema: type: integer format: int64 responses: '204': description: '' '403': description: '' '404': description: '' /user/orgs: get: tags: - organization summary: List the Current User's Organizations operationId: orgListCurrentUserOrgs parameters: - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' /user/repos: get: tags: - user summary: List the Repos That the Authenticated User Owns operationId: userCurrentListRepos parameters: - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' post: tags: - repository - user summary: Create a Repository operationId: createCurrentUserRepo requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreateRepoOption' responses: '201': description: '' '400': description: '' '409': description: The repository with the same name already exists. '422': description: '' /user/settings: get: tags: - user summary: Get User Settings operationId: getUserSettings responses: '200': description: '' patch: tags: - user summary: Update User Settings operationId: updateUserSettings requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/UserSettingsOptions' responses: '200': description: '' /user/starred: get: tags: - user summary: The Repos That the Authenticated User Has Starred operationId: userCurrentListStarred parameters: - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '403': description: '' /user/starred/{owner}/{repo}: get: tags: - user summary: Whether the Authenticated Is Starring the Repo operationId: userCurrentCheckStarring parameters: - name: owner in: path description: owner of the repo required: true schema: type: string - name: repo in: path description: name of the repo required: true schema: type: string responses: '204': description: '' '403': description: '' '404': description: '' put: tags: - user summary: Star the Given Repo operationId: userCurrentPutStar parameters: - name: owner in: path description: owner of the repo to star required: true schema: type: string - name: repo in: path description: name of the repo to star required: true schema: type: string responses: '204': description: '' '403': description: '' '404': description: '' delete: tags: - user summary: Unstar the Given Repo operationId: userCurrentDeleteStar parameters: - name: owner in: path description: owner of the repo to unstar required: true schema: type: string - name: repo in: path description: name of the repo to unstar required: true schema: type: string responses: '204': description: '' '403': description: '' '404': description: '' /user/stopwatches: get: tags: - user summary: Get List of All Existing Stopwatches operationId: userGetStopWatches parameters: - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' /user/subscriptions: get: tags: - user summary: List Repositories Watched by the Authenticated User operationId: userCurrentListSubscriptions parameters: - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' /user/teams: get: tags: - user summary: List All the Teams a User Belongs To operationId: userListTeams parameters: - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' /user/times: get: tags: - user summary: List the Current User's Tracked Times operationId: userCurrentTrackedTimes parameters: - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer - name: since in: query description: Only show times updated after the given time. This is a timestamp in RFC 3339 format schema: type: string format: date-time - name: before in: query description: Only show times updated before the given time. This is a timestamp in RFC 3339 format schema: type: string format: date-time responses: '200': description: '' /users/search: get: tags: - user summary: Search for Users operationId: userSearch parameters: - name: q in: query description: keyword schema: type: string - name: uid in: query description: ID of the user to search for schema: type: integer format: int64 - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: SearchResults of a successful search content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/User' ok: type: boolean /users/{username}: get: tags: - user summary: Get a User operationId: userGet parameters: - name: username in: path description: username of the user whose data is to be listed required: true schema: type: string responses: '200': description: '' '404': description: '' /users/{username}/activities/feeds: get: tags: - user summary: List a User's Activity Feeds operationId: userListActivityFeeds parameters: - name: username in: path description: username of the user whose activity feeds are to be listed required: true schema: type: string - name: only-performed-by in: query description: if true, only show actions performed by the requested user schema: type: boolean - name: date in: query description: the date of the activities to be found schema: type: string format: date - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' /users/{username}/followers: get: tags: - user summary: List the Given User's Followers operationId: userListFollowers parameters: - name: username in: path description: username of the user whose followers are to be listed required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' /users/{username}/following: get: tags: - user summary: List the Users That the Given User Is Following operationId: userListFollowing parameters: - name: username in: path description: username of the user whose followed users are to be listed required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' /users/{username}/following/{target}: get: tags: - user summary: Check if One User Is Following Another User operationId: userCheckFollowing parameters: - name: username in: path description: username of the following user required: true schema: type: string - name: target in: path description: username of the followed user required: true schema: type: string responses: '204': description: '' '404': description: '' /users/{username}/gpg_keys: get: tags: - user summary: List the Given User's GPG Keys operationId: userListGPGKeys parameters: - name: username in: path description: username of the user whose GPG key list is to be obtained required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' /users/{username}/heatmap: get: tags: - user summary: Get a User's Heatmap operationId: userGetHeatmapData parameters: - name: username in: path description: username of the user whose heatmap is to be obtained required: true schema: type: string responses: '200': description: '' '404': description: '' /users/{username}/keys: get: tags: - user summary: List the Given User's Public Keys operationId: userListKeys parameters: - name: username in: path description: username of the user whose public keys are to be listed required: true schema: type: string - name: fingerprint in: query description: fingerprint of the key schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' /users/{username}/orgs: get: tags: - organization summary: List a User's Organizations operationId: orgListUserOrgs parameters: - name: username in: path description: username of the user whose organizations are to be listed required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' /users/{username}/orgs/{org}/permissions: get: tags: - organization summary: Get User Permissions in Organization operationId: orgGetUserPermissions parameters: - name: username in: path description: username of the user whose permissions are to be obtained required: true schema: type: string - name: org in: path description: name of the organization required: true schema: type: string responses: '200': description: '' '403': description: '' '404': description: '' /users/{username}/repos: get: tags: - user summary: List the Repos Owned by the Given User operationId: userListRepos parameters: - name: username in: path description: username of the user whose owned repos are to be listed required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' /users/{username}/starred: get: tags: - user summary: The Repos That the Given User Has Starred operationId: userListStarred parameters: - name: username in: path description: username of the user whose starred repos are to be listed required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '403': description: '' '404': description: '' /users/{username}/subscriptions: get: tags: - user summary: List the Repositories Watched by a User operationId: userListSubscriptions parameters: - name: username in: path description: username of the user whose watched repos are to be listed required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '404': description: '' /users/{username}/tokens: get: tags: - user summary: List the Authenticated User's Access Tokens operationId: userGetTokens parameters: - name: username in: path description: username of to user whose access tokens are to be listed required: true schema: type: string - name: page in: query description: page number of results to return (1-based) schema: type: integer - name: limit in: query description: page size of results schema: type: integer responses: '200': description: '' '403': description: '' post: tags: - user summary: Create an Access Token operationId: userCreateToken parameters: - name: username in: path description: username of the user whose token is to be created required: true schema: type: string requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/CreateAccessTokenOption' responses: '201': description: '' '400': description: '' '403': description: '' /users/{username}/tokens/{token}: delete: tags: - user summary: Delete an Access Token operationId: userDeleteAccessToken parameters: - name: username in: path description: username of the user whose token is to be deleted required: true schema: type: string - name: token in: path description: token to be deleted, identified by ID and if not available by name required: true schema: type: string responses: '204': description: '' '403': description: '' '404': description: '' '422': description: '' /version: get: tags: - miscellaneous summary: Returns the Version of the Gitea Application operationId: getVersion responses: '200': description: '' components: schemas: APIError: description: APIError is an api error with a message type: object properties: message: description: Message contains the error description type: string x-go-name: Message url: description: URL contains the documentation URL for this error type: string x-go-name: URL x-go-package: code.gitea.io/gitea/modules/structs AccessToken: type: object title: AccessToken represents an API access token. properties: created_at: description: The timestamp when the token was created type: string format: date-time x-go-name: Created id: description: The unique identifier of the access token type: integer format: int64 x-go-name: ID last_used_at: description: The timestamp when the token was last used type: string format: date-time x-go-name: Updated name: description: The name of the access token type: string x-go-name: Name scopes: description: The scopes granted to this access token type: array items: type: string x-go-name: Scopes sha1: description: The SHA1 hash of the access token type: string x-go-name: Token token_last_eight: description: The last eight characters of the token type: string x-go-name: TokenLastEight x-go-package: code.gitea.io/gitea/modules/structs ActionArtifact: description: ActionArtifact represents a ActionArtifact type: object properties: archive_download_url: type: string x-go-name: ArchiveDownloadURL created_at: type: string format: date-time x-go-name: CreatedAt expired: type: boolean x-go-name: Expired expires_at: type: string format: date-time x-go-name: ExpiresAt id: type: integer format: int64 x-go-name: ID name: type: string x-go-name: Name size_in_bytes: type: integer format: int64 x-go-name: SizeInBytes updated_at: type: string format: date-time x-go-name: UpdatedAt url: type: string x-go-name: URL workflow_run: $ref: '#/components/schemas/ActionWorkflowRun' x-go-package: code.gitea.io/gitea/modules/structs ActionArtifactsResponse: description: ActionArtifactsResponse returns ActionArtifacts type: object properties: artifacts: type: array items: $ref: '#/components/schemas/ActionArtifact' x-go-name: Entries total_count: type: integer format: int64 x-go-name: TotalCount x-go-package: code.gitea.io/gitea/modules/structs ActionRunner: description: ActionRunner represents a Runner type: object properties: busy: type: boolean x-go-name: Busy disabled: type: boolean x-go-name: Disabled ephemeral: type: boolean x-go-name: Ephemeral id: type: integer format: int64 x-go-name: ID labels: type: array items: $ref: '#/components/schemas/ActionRunnerLabel' x-go-name: Labels name: type: string x-go-name: Name status: type: string x-go-name: Status x-go-package: code.gitea.io/gitea/modules/structs ActionRunnerLabel: description: ActionRunnerLabel represents a Runner Label type: object properties: id: type: integer format: int64 x-go-name: ID name: type: string x-go-name: Name type: type: string x-go-name: Type x-go-package: code.gitea.io/gitea/modules/structs ActionRunnersResponse: description: ActionRunnersResponse returns Runners type: object properties: runners: type: array items: $ref: '#/components/schemas/ActionRunner' x-go-name: Entries total_count: type: integer format: int64 x-go-name: TotalCount x-go-package: code.gitea.io/gitea/modules/structs ActionTask: description: ActionTask represents a ActionTask type: object properties: created_at: type: string format: date-time x-go-name: CreatedAt display_title: description: DisplayTitle is the display title for the workflow run type: string x-go-name: DisplayTitle event: description: Event is the type of event that triggered the workflow type: string x-go-name: Event head_branch: description: HeadBranch is the branch that triggered the workflow type: string x-go-name: HeadBranch head_sha: description: HeadSHA is the commit SHA that triggered the workflow type: string x-go-name: HeadSHA id: description: ID is the unique identifier for the action task type: integer format: int64 x-go-name: ID name: description: Name is the name of the workflow type: string x-go-name: Name run_number: description: RunNumber is the sequential number of the workflow run type: integer format: int64 x-go-name: RunNumber run_started_at: type: string format: date-time x-go-name: RunStartedAt status: description: Status indicates the current status of the workflow run type: string x-go-name: Status updated_at: type: string format: date-time x-go-name: UpdatedAt url: description: URL is the API URL for this workflow run type: string x-go-name: URL workflow_id: description: WorkflowID is the identifier of the workflow type: string x-go-name: WorkflowID x-go-package: code.gitea.io/gitea/modules/structs ActionTaskResponse: description: ActionTaskResponse returns a ActionTask type: object properties: total_count: description: TotalCount is the total number of workflow runs type: integer format: int64 x-go-name: TotalCount workflow_runs: description: Entries contains the list of workflow runs type: array items: $ref: '#/components/schemas/ActionTask' x-go-name: Entries x-go-package: code.gitea.io/gitea/modules/structs ActionVariable: description: ActionVariable return value of the query API type: object properties: data: description: the value of the variable type: string x-go-name: Data description: description: the description of the variable type: string x-go-name: Description name: description: the name of the variable type: string x-go-name: Name owner_id: description: the owner to which the variable belongs type: integer format: int64 x-go-name: OwnerID repo_id: description: the repository to which the variable belongs type: integer format: int64 x-go-name: RepoID x-go-package: code.gitea.io/gitea/modules/structs ActionWorkflow: description: ActionWorkflow represents a ActionWorkflow type: object properties: badge_url: description: BadgeURL is the URL for the workflow badge type: string x-go-name: BadgeURL created_at: type: string format: date-time x-go-name: CreatedAt deleted_at: type: string format: date-time x-go-name: DeletedAt html_url: description: HTMLURL is the web URL for viewing the workflow type: string x-go-name: HTMLURL id: description: ID is the unique identifier for the workflow type: string x-go-name: ID name: description: Name is the name of the workflow type: string x-go-name: Name path: description: Path is the file path of the workflow type: string x-go-name: Path state: description: State indicates if the workflow is active or disabled type: string x-go-name: State updated_at: type: string format: date-time x-go-name: UpdatedAt url: description: URL is the API URL for this workflow type: string x-go-name: URL x-go-package: code.gitea.io/gitea/modules/structs ActionWorkflowJob: description: ActionWorkflowJob represents a WorkflowJob type: object properties: completed_at: type: string format: date-time x-go-name: CompletedAt conclusion: type: string x-go-name: Conclusion created_at: type: string format: date-time x-go-name: CreatedAt head_branch: type: string x-go-name: HeadBranch head_sha: type: string x-go-name: HeadSha html_url: type: string x-go-name: HTMLURL id: type: integer format: int64 x-go-name: ID labels: type: array items: type: string x-go-name: Labels name: type: string x-go-name: Name run_attempt: type: integer format: int64 x-go-name: RunAttempt run_id: type: integer format: int64 x-go-name: RunID run_url: type: string x-go-name: RunURL runner_id: type: integer format: int64 x-go-name: RunnerID runner_name: type: string x-go-name: RunnerName started_at: type: string format: date-time x-go-name: StartedAt status: type: string x-go-name: Status steps: type: array items: $ref: '#/components/schemas/ActionWorkflowStep' x-go-name: Steps url: type: string x-go-name: URL x-go-package: code.gitea.io/gitea/modules/structs ActionWorkflowJobsResponse: description: ActionWorkflowJobsResponse returns ActionWorkflowJobs type: object properties: jobs: type: array items: $ref: '#/components/schemas/ActionWorkflowJob' x-go-name: Entries total_count: type: integer format: int64 x-go-name: TotalCount x-go-package: code.gitea.io/gitea/modules/structs ActionWorkflowResponse: description: ActionWorkflowResponse returns a ActionWorkflow type: object properties: total_count: type: integer format: int64 x-go-name: TotalCount workflows: type: array items: $ref: '#/components/schemas/ActionWorkflow' x-go-name: Workflows x-go-package: code.gitea.io/gitea/modules/structs ActionWorkflowRun: description: ActionWorkflowRun represents a WorkflowRun type: object properties: actor: $ref: '#/components/schemas/User' completed_at: type: string format: date-time x-go-name: CompletedAt conclusion: type: string x-go-name: Conclusion display_title: type: string x-go-name: DisplayTitle event: type: string x-go-name: Event head_branch: type: string x-go-name: HeadBranch head_repository: $ref: '#/components/schemas/Repository' head_sha: type: string x-go-name: HeadSha html_url: type: string x-go-name: HTMLURL id: type: integer format: int64 x-go-name: ID path: type: string x-go-name: Path repository: $ref: '#/components/schemas/Repository' repository_id: type: integer format: int64 x-go-name: RepositoryID run_attempt: type: integer format: int64 x-go-name: RunAttempt run_number: type: integer format: int64 x-go-name: RunNumber started_at: type: string format: date-time x-go-name: StartedAt status: type: string x-go-name: Status trigger_actor: $ref: '#/components/schemas/User' url: type: string x-go-name: URL x-go-package: code.gitea.io/gitea/modules/structs ActionWorkflowRunsResponse: description: ActionWorkflowRunsResponse returns ActionWorkflowRuns type: object properties: total_count: type: integer format: int64 x-go-name: TotalCount workflow_runs: type: array items: $ref: '#/components/schemas/ActionWorkflowRun' x-go-name: Entries x-go-package: code.gitea.io/gitea/modules/structs ActionWorkflowStep: description: ActionWorkflowStep represents a step of a WorkflowJob type: object properties: completed_at: type: string format: date-time x-go-name: CompletedAt conclusion: type: string x-go-name: Conclusion name: type: string x-go-name: Name number: type: integer format: int64 x-go-name: Number started_at: type: string format: date-time x-go-name: StartedAt status: type: string x-go-name: Status x-go-package: code.gitea.io/gitea/modules/structs Activity: type: object properties: act_user: $ref: '#/components/schemas/User' act_user_id: description: The ID of the user who performed the action type: integer format: int64 x-go-name: ActUserID comment: $ref: '#/components/schemas/Comment' comment_id: description: The ID of the comment associated with the activity (if applicable) type: integer format: int64 x-go-name: CommentID content: description: Additional content or details about the activity type: string x-go-name: Content created: description: The date and time when the activity occurred type: string format: date-time x-go-name: Created id: description: The unique identifier of the activity type: integer format: int64 x-go-name: ID is_private: description: Whether this activity is from a private repository type: boolean x-go-name: IsPrivate op_type: description: the type of action type: string enum: - create_repo - rename_repo - star_repo - watch_repo - commit_repo - create_issue - create_pull_request - transfer_repo - push_tag - comment_issue - merge_pull_request - close_issue - reopen_issue - close_pull_request - reopen_pull_request - delete_tag - delete_branch - mirror_sync_push - mirror_sync_create - mirror_sync_delete - approve_pull_request - reject_pull_request - comment_pull - publish_release - pull_review_dismissed - pull_request_ready_for_review - auto_merge_pull_request x-go-name: OpType ref_name: description: The name of the git reference (branch/tag) associated with the activity type: string x-go-name: RefName repo: $ref: '#/components/schemas/Repository' repo_id: description: The ID of the repository associated with the activity type: integer format: int64 x-go-name: RepoID user_id: description: The ID of the user who receives/sees this activity type: integer format: int64 x-go-name: UserID x-go-package: code.gitea.io/gitea/modules/structs AddCollaboratorOption: description: AddCollaboratorOption options when adding a user as a collaborator of a repository type: object properties: permission: type: string enum: - read - write - admin x-go-name: Permission x-go-package: code.gitea.io/gitea/modules/structs AddTimeOption: description: AddTimeOption options for adding time to an issue type: object required: - time properties: created: type: string format: date-time x-go-name: Created time: description: time in seconds type: integer format: int64 x-go-name: Time user_name: description: username of the user who spent the time working on the issue (optional) type: string x-go-name: User x-go-package: code.gitea.io/gitea/modules/structs AnnotatedTag: description: AnnotatedTag represents an annotated tag type: object properties: message: description: The message associated with the annotated tag type: string x-go-name: Message object: $ref: '#/components/schemas/AnnotatedTagObject' sha: description: The SHA hash of the annotated tag type: string x-go-name: SHA tag: description: The name of the annotated tag type: string x-go-name: Tag tagger: $ref: '#/components/schemas/CommitUser' url: description: The URL to access the annotated tag type: string x-go-name: URL verification: $ref: '#/components/schemas/PayloadCommitVerification' x-go-package: code.gitea.io/gitea/modules/structs AnnotatedTagObject: description: AnnotatedTagObject contains meta information of the tag object type: object properties: sha: description: The SHA hash of the tagged object type: string x-go-name: SHA type: description: The type of the tagged object (e.g., commit, tree) type: string x-go-name: Type url: description: The URL to access the tagged object type: string x-go-name: URL x-go-package: code.gitea.io/gitea/modules/structs ApplyDiffPatchFileOptions: description: 'ApplyDiffPatchFileOptions options for applying a diff patch Note: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)' type: object required: - content properties: author: $ref: '#/components/schemas/Identity' branch: description: branch (optional) is the base branch for the changes. If not supplied, the default branch is used type: string x-go-name: BranchName committer: $ref: '#/components/schemas/Identity' content: type: string x-go-name: Content dates: $ref: '#/components/schemas/CommitDateOptions' force_push: description: force_push (optional) will do a force-push if the new branch already exists type: boolean x-go-name: ForcePush message: description: message (optional) is the commit message of the changes. If not supplied, a default message will be used type: string x-go-name: Message new_branch: description: new_branch (optional) will make a new branch from base branch for the changes. If not supplied, the changes will be committed to the base branch type: string x-go-name: NewBranchName signoff: description: Add a Signed-off-by trailer by the committer at the end of the commit log message. type: boolean x-go-name: Signoff x-go-package: code.gitea.io/gitea/modules/structs Attachment: description: Attachment a generic attachment type: object properties: browser_download_url: description: DownloadURL is the URL to download the attachment type: string x-go-name: DownloadURL created_at: type: string format: date-time x-go-name: Created download_count: description: DownloadCount is the number of times the attachment has been downloaded type: integer format: int64 x-go-name: DownloadCount id: description: ID is the unique identifier for the attachment type: integer format: int64 x-go-name: ID name: description: Name is the filename of the attachment type: string x-go-name: Name size: description: Size is the file size in bytes type: integer format: int64 x-go-name: Size uuid: description: UUID is the unique identifier for the attachment file type: string x-go-name: UUID x-go-package: code.gitea.io/gitea/modules/structs Badge: description: Badge represents a user badge type: object properties: description: type: string x-go-name: Description id: type: integer format: int64 x-go-name: ID image_url: type: string x-go-name: ImageURL slug: type: string x-go-name: Slug x-go-package: code.gitea.io/gitea/modules/structs Branch: description: Branch represents a repository branch type: object properties: commit: $ref: '#/components/schemas/PayloadCommit' effective_branch_protection_name: description: EffectiveBranchProtectionName is the name of the effective branch protection rule type: string x-go-name: EffectiveBranchProtectionName enable_status_check: description: EnableStatusCheck indicates if status checks are enabled type: boolean x-go-name: EnableStatusCheck name: description: Name is the branch name type: string x-go-name: Name protected: description: Protected indicates if the branch is protected type: boolean x-go-name: Protected required_approvals: description: RequiredApprovals is the number of required approvals for pull requests type: integer format: int64 x-go-name: RequiredApprovals status_check_contexts: description: StatusCheckContexts contains the list of required status check contexts type: array items: type: string x-go-name: StatusCheckContexts user_can_merge: description: UserCanMerge indicates if the current user can merge to this branch type: boolean x-go-name: UserCanMerge user_can_push: description: UserCanPush indicates if the current user can push to this branch type: boolean x-go-name: UserCanPush x-go-package: code.gitea.io/gitea/modules/structs BranchProtection: description: BranchProtection represents a branch protection for a repository type: object properties: approvals_whitelist_teams: type: array items: type: string x-go-name: ApprovalsWhitelistTeams approvals_whitelist_username: type: array items: type: string x-go-name: ApprovalsWhitelistUsernames block_admin_merge_override: type: boolean x-go-name: BlockAdminMergeOverride block_on_official_review_requests: type: boolean x-go-name: BlockOnOfficialReviewRequests block_on_outdated_branch: type: boolean x-go-name: BlockOnOutdatedBranch block_on_rejected_reviews: type: boolean x-go-name: BlockOnRejectedReviews branch_name: description: 'Deprecated: true' type: string x-go-name: BranchName created_at: type: string format: date-time x-go-name: Created dismiss_stale_approvals: type: boolean x-go-name: DismissStaleApprovals enable_approvals_whitelist: type: boolean x-go-name: EnableApprovalsWhitelist enable_force_push: type: boolean x-go-name: EnableForcePush enable_force_push_allowlist: type: boolean x-go-name: EnableForcePushAllowlist enable_merge_whitelist: type: boolean x-go-name: EnableMergeWhitelist enable_push: type: boolean x-go-name: EnablePush enable_push_whitelist: type: boolean x-go-name: EnablePushWhitelist enable_status_check: type: boolean x-go-name: EnableStatusCheck force_push_allowlist_deploy_keys: type: boolean x-go-name: ForcePushAllowlistDeployKeys force_push_allowlist_teams: type: array items: type: string x-go-name: ForcePushAllowlistTeams force_push_allowlist_usernames: type: array items: type: string x-go-name: ForcePushAllowlistUsernames ignore_stale_approvals: type: boolean x-go-name: IgnoreStaleApprovals merge_whitelist_teams: type: array items: type: string x-go-name: MergeWhitelistTeams merge_whitelist_usernames: type: array items: type: string x-go-name: MergeWhitelistUsernames priority: description: Priority is the priority of this branch protection rule type: integer format: int64 x-go-name: Priority protected_file_patterns: type: string x-go-name: ProtectedFilePatterns push_whitelist_deploy_keys: type: boolean x-go-name: PushWhitelistDeployKeys push_whitelist_teams: type: array items: type: string x-go-name: PushWhitelistTeams push_whitelist_usernames: type: array items: type: string x-go-name: PushWhitelistUsernames require_signed_commits: type: boolean x-go-name: RequireSignedCommits required_approvals: type: integer format: int64 x-go-name: RequiredApprovals rule_name: description: RuleName is the name of the branch protection rule type: string x-go-name: RuleName status_check_contexts: type: array items: type: string x-go-name: StatusCheckContexts unprotected_file_patterns: type: string x-go-name: UnprotectedFilePatterns updated_at: type: string format: date-time x-go-name: Updated x-go-package: code.gitea.io/gitea/modules/structs ChangeFileOperation: description: ChangeFileOperation for creating, updating or deleting a file type: object required: - operation - path properties: content: description: new or updated file content, it must be base64 encoded type: string x-go-name: ContentBase64 from_path: description: old path of the file to move type: string x-go-name: FromPath operation: description: 'indicates what to do with the file: "create" for creating a new file, "update" for updating an existing file, "upload" for creating or updating a file, "rename" for renaming a file, and "delete" for deleting an existing file.' type: string enum: - create - update - upload - rename - delete x-go-name: Operation path: description: path to the existing or new file type: string x-go-name: Path sha: description: the blob ID (SHA) for the file that already exists, required for changing existing files type: string x-go-name: SHA x-go-package: code.gitea.io/gitea/modules/structs ChangeFilesOptions: description: 'ChangeFilesOptions options for creating, updating or deleting multiple files Note: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)' type: object required: - files properties: author: $ref: '#/components/schemas/Identity' branch: description: branch (optional) is the base branch for the changes. If not supplied, the default branch is used type: string x-go-name: BranchName committer: $ref: '#/components/schemas/Identity' dates: $ref: '#/components/schemas/CommitDateOptions' files: description: list of file operations type: array items: $ref: '#/components/schemas/ChangeFileOperation' x-go-name: Files force_push: description: force_push (optional) will do a force-push if the new branch already exists type: boolean x-go-name: ForcePush message: description: message (optional) is the commit message of the changes. If not supplied, a default message will be used type: string x-go-name: Message new_branch: description: new_branch (optional) will make a new branch from base branch for the changes. If not supplied, the changes will be committed to the base branch type: string x-go-name: NewBranchName signoff: description: Add a Signed-off-by trailer by the committer at the end of the commit log message. type: boolean x-go-name: Signoff x-go-package: code.gitea.io/gitea/modules/structs ChangedFile: description: ChangedFile store information about files affected by the pull request type: object properties: additions: description: The number of lines added to the file type: integer format: int64 x-go-name: Additions changes: description: The total number of changes to the file type: integer format: int64 x-go-name: Changes contents_url: description: The API URL to get the file contents type: string x-go-name: ContentsURL deletions: description: The number of lines deleted from the file type: integer format: int64 x-go-name: Deletions filename: description: The name of the changed file type: string x-go-name: Filename html_url: description: The HTML URL to view the file changes type: string x-go-name: HTMLURL previous_filename: description: The previous filename if the file was renamed type: string x-go-name: PreviousFilename raw_url: description: The raw URL to download the file type: string x-go-name: RawURL status: description: The status of the file change (added, modified, deleted, etc.) type: string x-go-name: Status x-go-package: code.gitea.io/gitea/modules/structs CombinedStatus: description: CombinedStatus holds the combined state of several statuses for a single commit type: object properties: commit_url: description: CommitURL is the API URL for the commit type: string x-go-name: CommitURL repository: $ref: '#/components/schemas/Repository' sha: description: SHA is the commit SHA this status applies to type: string x-go-name: SHA state: description: 'State is the overall combined status state pending CommitStatusPending CommitStatusPending is for when the CommitStatus is Pending success CommitStatusSuccess CommitStatusSuccess is for when the CommitStatus is Success error CommitStatusError CommitStatusError is for when the CommitStatus is Error failure CommitStatusFailure CommitStatusFailure is for when the CommitStatus is Failure warning CommitStatusWarning CommitStatusWarning is for when the CommitStatus is Warning skipped CommitStatusSkipped CommitStatusSkipped is for when CommitStatus is Skipped' type: string enum: - pending - success - error - failure - warning - skipped x-go-enum-desc: 'pending CommitStatusPending CommitStatusPending is for when the CommitStatus is Pending success CommitStatusSuccess CommitStatusSuccess is for when the CommitStatus is Success error CommitStatusError CommitStatusError is for when the CommitStatus is Error failure CommitStatusFailure CommitStatusFailure is for when the CommitStatus is Failure warning CommitStatusWarning CommitStatusWarning is for when the CommitStatus is Warning skipped CommitStatusSkipped CommitStatusSkipped is for when CommitStatus is Skipped' x-go-name: State statuses: description: Statuses contains all individual commit statuses type: array items: $ref: '#/components/schemas/CommitStatus' x-go-name: Statuses total_count: description: TotalCount is the total number of statuses type: integer format: int64 x-go-name: TotalCount url: description: URL is the API URL for this combined status type: string x-go-name: URL x-go-package: code.gitea.io/gitea/modules/structs Comment: description: Comment represents a comment on a commit or issue type: object properties: assets: description: Attachments contains files attached to the comment type: array items: $ref: '#/components/schemas/Attachment' x-go-name: Attachments body: description: Body contains the comment text content type: string x-go-name: Body created_at: type: string format: date-time x-go-name: Created html_url: description: HTMLURL is the web URL for viewing the comment type: string x-go-name: HTMLURL id: description: ID is the unique identifier for the comment type: integer format: int64 x-go-name: ID issue_url: description: IssueURL is the API URL for the issue type: string x-go-name: IssueURL original_author: description: OriginalAuthor is the original author name (for imported comments) type: string x-go-name: OriginalAuthor original_author_id: description: OriginalAuthorID is the original author ID (for imported comments) type: integer format: int64 x-go-name: OriginalAuthorID pull_request_url: description: PRURL is the API URL for the pull request (if applicable) type: string x-go-name: PRURL updated_at: type: string format: date-time x-go-name: Updated user: $ref: '#/components/schemas/User' x-go-package: code.gitea.io/gitea/modules/structs Commit: type: object title: Commit contains information generated from a Git commit. properties: author: $ref: '#/components/schemas/User' commit: $ref: '#/components/schemas/RepoCommit' committer: $ref: '#/components/schemas/User' created: type: string format: date-time x-go-name: Created files: description: Files contains information about files affected by the commit type: array items: $ref: '#/components/schemas/CommitAffectedFiles' x-go-name: Files html_url: description: HTMLURL is the web URL for viewing the commit type: string x-go-name: HTMLURL parents: description: Parents contains the parent commit information type: array items: $ref: '#/components/schemas/CommitMeta' x-go-name: Parents sha: description: SHA is the commit SHA hash type: string x-go-name: SHA stats: $ref: '#/components/schemas/CommitStats' url: description: URL is the API URL for the commit type: string x-go-name: URL x-go-package: code.gitea.io/gitea/modules/structs CommitAffectedFiles: description: CommitAffectedFiles store information about files affected by the commit type: object properties: filename: description: Filename is the path of the affected file type: string x-go-name: Filename status: description: Status indicates how the file was affected (added, modified, deleted) type: string x-go-name: Status x-go-package: code.gitea.io/gitea/modules/structs CommitDateOptions: description: CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE type: object properties: author: type: string format: date-time x-go-name: Author committer: type: string format: date-time x-go-name: Committer x-go-package: code.gitea.io/gitea/modules/structs CommitMeta: type: object title: CommitMeta contains meta information of a commit in terms of API. properties: created: type: string format: date-time x-go-name: Created sha: description: SHA is the commit SHA hash type: string x-go-name: SHA url: description: URL is the API URL for the commit type: string x-go-name: URL x-go-package: code.gitea.io/gitea/modules/structs CommitStats: description: CommitStats is statistics for a RepoCommit type: object properties: additions: description: Additions is the number of lines added type: integer format: int64 x-go-name: Additions deletions: description: Deletions is the number of lines deleted type: integer format: int64 x-go-name: Deletions total: description: Total is the total number of lines changed type: integer format: int64 x-go-name: Total x-go-package: code.gitea.io/gitea/modules/structs CommitStatus: description: CommitStatus holds a single status of a single Commit type: object properties: context: description: Context is the unique context identifier for the status type: string x-go-name: Context created_at: type: string format: date-time x-go-name: Created creator: $ref: '#/components/schemas/User' description: description: Description provides a brief description of the status type: string x-go-name: Description id: description: ID is the unique identifier for the commit status type: integer format: int64 x-go-name: ID status: description: 'State represents the status state (pending, success, error, failure) pending CommitStatusPending CommitStatusPending is for when the CommitStatus is Pending success CommitStatusSuccess CommitStatusSuccess is for when the CommitStatus is Success error CommitStatusError CommitStatusError is for when the CommitStatus is Error failure CommitStatusFailure CommitStatusFailure is for when the CommitStatus is Failure warning CommitStatusWarning CommitStatusWarning is for when the CommitStatus is Warning skipped CommitStatusSkipped CommitStatusSkipped is for when CommitStatus is Skipped' type: string enum: - pending - success - error - failure - warning - skipped x-go-enum-desc: 'pending CommitStatusPending CommitStatusPending is for when the CommitStatus is Pending success CommitStatusSuccess CommitStatusSuccess is for when the CommitStatus is Success error CommitStatusError CommitStatusError is for when the CommitStatus is Error failure CommitStatusFailure CommitStatusFailure is for when the CommitStatus is Failure warning CommitStatusWarning CommitStatusWarning is for when the CommitStatus is Warning skipped CommitStatusSkipped CommitStatusSkipped is for when CommitStatus is Skipped' x-go-name: State target_url: description: TargetURL is the URL to link to for more details type: string x-go-name: TargetURL updated_at: type: string format: date-time x-go-name: Updated url: description: URL is the API URL for this status type: string x-go-name: URL x-go-package: code.gitea.io/gitea/modules/structs CommitUser: type: object title: CommitUser contains information of a user in the context of a commit. properties: date: description: Date is the commit date in string format type: string x-go-name: Date email: type: string format: email x-go-name: Email name: description: Name is the person's name type: string x-go-name: Name x-go-package: code.gitea.io/gitea/modules/structs Compare: type: object title: Compare represents a comparison between two commits. properties: commits: type: array items: $ref: '#/components/schemas/Commit' x-go-name: Commits total_commits: type: integer format: int64 x-go-name: TotalCommits x-go-package: code.gitea.io/gitea/modules/structs ContentsExtResponse: type: object properties: dir_contents: description: DirContents contains directory listing when the path represents a directory type: array items: $ref: '#/components/schemas/ContentsResponse' x-go-name: DirContents file_contents: $ref: '#/components/schemas/ContentsResponse' x-go-package: code.gitea.io/gitea/modules/structs ContentsResponse: description: ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and content type: object properties: _links: $ref: '#/components/schemas/FileLinksResponse' content: description: '`content` is populated when `type` is `file`, otherwise null' type: string x-go-name: Content download_url: description: DownloadURL is the direct download URL for this file type: string x-go-name: DownloadURL encoding: description: '`encoding` is populated when `type` is `file`, otherwise null' type: string x-go-name: Encoding git_url: description: GitURL is the Git API URL for this blob or tree type: string x-go-name: GitURL html_url: description: HTMLURL is the web URL for this file or directory type: string x-go-name: HTMLURL last_author_date: type: string format: date-time x-go-name: LastAuthorDate last_commit_message: description: LastCommitMessage is the message of the last commit that affected this file type: string x-go-name: LastCommitMessage last_commit_sha: description: LastCommitSHA is the SHA of the last commit that affected this file type: string x-go-name: LastCommitSHA last_committer_date: type: string format: date-time x-go-name: LastCommitterDate lfs_oid: description: LfsOid is the Git LFS object ID if this file is stored in LFS type: string x-go-name: LfsOid lfs_size: description: LfsSize is the file size if this file is stored in LFS type: integer format: int64 x-go-name: LfsSize name: description: Name is the file or directory name type: string x-go-name: Name path: description: Path is the full path to the file or directory type: string x-go-name: Path sha: description: SHA is the Git blob or tree SHA type: string x-go-name: SHA size: description: Size is the file size in bytes type: integer format: int64 x-go-name: Size submodule_git_url: description: '`submodule_git_url` is populated when `type` is `submodule`, otherwise null' type: string x-go-name: SubmoduleGitURL target: description: '`target` is populated when `type` is `symlink`, otherwise null' type: string x-go-name: Target type: description: '`type` will be `file`, `dir`, `symlink`, or `submodule`' type: string x-go-name: Type url: description: URL is the API URL for this file or directory type: string x-go-name: URL x-go-package: code.gitea.io/gitea/modules/structs CreateAccessTokenOption: description: CreateAccessTokenOption options when create access token type: object required: - name properties: name: type: string x-go-name: Name scopes: type: array items: type: string x-go-name: Scopes example: - all - read:activitypub - read:issue - write:misc - read:notification - read:organization - read:package - read:repository - read:user x-go-package: code.gitea.io/gitea/modules/structs CreateActionWorkflowDispatch: description: CreateActionWorkflowDispatch represents the payload for triggering a workflow dispatch event type: object required: - ref properties: inputs: type: object additionalProperties: type: string x-go-name: Inputs ref: type: string x-go-name: Ref example: refs/heads/main x-go-package: code.gitea.io/gitea/modules/structs CreateBranchProtectionOption: description: CreateBranchProtectionOption options for creating a branch protection type: object properties: approvals_whitelist_teams: type: array items: type: string x-go-name: ApprovalsWhitelistTeams approvals_whitelist_username: type: array items: type: string x-go-name: ApprovalsWhitelistUsernames block_admin_merge_override: type: boolean x-go-name: BlockAdminMergeOverride block_on_official_review_requests: type: boolean x-go-name: BlockOnOfficialReviewRequests block_on_outdated_branch: type: boolean x-go-name: BlockOnOutdatedBranch block_on_rejected_reviews: type: boolean x-go-name: BlockOnRejectedReviews branch_name: description: 'Deprecated: true' type: string x-go-name: BranchName dismiss_stale_approvals: type: boolean x-go-name: DismissStaleApprovals enable_approvals_whitelist: type: boolean x-go-name: EnableApprovalsWhitelist enable_force_push: type: boolean x-go-name: EnableForcePush enable_force_push_allowlist: type: boolean x-go-name: EnableForcePushAllowlist enable_merge_whitelist: type: boolean x-go-name: EnableMergeWhitelist enable_push: type: boolean x-go-name: EnablePush enable_push_whitelist: type: boolean x-go-name: EnablePushWhitelist enable_status_check: type: boolean x-go-name: EnableStatusCheck force_push_allowlist_deploy_keys: type: boolean x-go-name: ForcePushAllowlistDeployKeys force_push_allowlist_teams: type: array items: type: string x-go-name: ForcePushAllowlistTeams force_push_allowlist_usernames: type: array items: type: string x-go-name: ForcePushAllowlistUsernames ignore_stale_approvals: type: boolean x-go-name: IgnoreStaleApprovals merge_whitelist_teams: type: array items: type: string x-go-name: MergeWhitelistTeams merge_whitelist_usernames: type: array items: type: string x-go-name: MergeWhitelistUsernames priority: type: integer format: int64 x-go-name: Priority protected_file_patterns: type: string x-go-name: ProtectedFilePatterns push_whitelist_deploy_keys: type: boolean x-go-name: PushWhitelistDeployKeys push_whitelist_teams: type: array items: type: string x-go-name: PushWhitelistTeams push_whitelist_usernames: type: array items: type: string x-go-name: PushWhitelistUsernames require_signed_commits: type: boolean x-go-name: RequireSignedCommits required_approvals: type: integer format: int64 x-go-name: RequiredApprovals rule_name: type: string x-go-name: RuleName status_check_contexts: type: array items: type: string x-go-name: StatusCheckContexts unprotected_file_patterns: type: string x-go-name: UnprotectedFilePatterns x-go-package: code.gitea.io/gitea/modules/structs CreateBranchRepoOption: description: CreateBranchRepoOption options when creating a branch in a repository type: object required: - new_branch_name properties: new_branch_name: description: Name of the branch to create type: string uniqueItems: true x-go-name: BranchName old_branch_name: description: 'Deprecated: true Name of the old branch to create from' type: string uniqueItems: true x-go-name: OldBranchName old_ref_name: description: Name of the old branch/tag/commit to create from type: string uniqueItems: true x-go-name: OldRefName x-go-package: code.gitea.io/gitea/modules/structs CreateEmailOption: description: CreateEmailOption options when creating email addresses type: object properties: emails: description: email addresses to add type: array items: type: string x-go-name: Emails x-go-package: code.gitea.io/gitea/modules/structs CreateFileOptions: description: 'CreateFileOptions options for creating a file Note: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)' type: object required: - content properties: author: $ref: '#/components/schemas/Identity' branch: description: branch (optional) is the base branch for the changes. If not supplied, the default branch is used type: string x-go-name: BranchName committer: $ref: '#/components/schemas/Identity' content: description: content must be base64 encoded type: string x-go-name: ContentBase64 dates: $ref: '#/components/schemas/CommitDateOptions' force_push: description: force_push (optional) will do a force-push if the new branch already exists type: boolean x-go-name: ForcePush message: description: message (optional) is the commit message of the changes. If not supplied, a default message will be used type: string x-go-name: Message new_branch: description: new_branch (optional) will make a new branch from base branch for the changes. If not supplied, the changes will be committed to the base branch type: string x-go-name: NewBranchName signoff: description: Add a Signed-off-by trailer by the committer at the end of the commit log message. type: boolean x-go-name: Signoff x-go-package: code.gitea.io/gitea/modules/structs CreateForkOption: description: CreateForkOption options for creating a fork type: object properties: name: description: name of the forked repository type: string x-go-name: Name organization: description: organization name, if forking into an organization type: string x-go-name: Organization x-go-package: code.gitea.io/gitea/modules/structs CreateGPGKeyOption: description: CreateGPGKeyOption options create user GPG key type: object required: - armored_public_key properties: armored_public_key: description: An armored GPG key to add type: string uniqueItems: true x-go-name: ArmoredKey armored_signature: description: An optional armored signature for the GPG key type: string x-go-name: Signature x-go-package: code.gitea.io/gitea/modules/structs CreateHookOption: description: CreateHookOption options when create a hook type: object required: - type - config properties: active: type: boolean default: false x-go-name: Active authorization_header: description: Authorization header to include in webhook requests type: string x-go-name: AuthorizationHeader branch_filter: description: Branch filter pattern to determine which branches trigger the webhook type: string x-go-name: BranchFilter config: $ref: '#/components/schemas/CreateHookOptionConfig' events: description: List of events that will trigger this webhook type: array items: type: string x-go-name: Events name: description: Optional human-readable name for the webhook type: string x-go-name: Name type: type: string enum: - dingtalk - discord - gitea - gogs - msteams - slack - telegram - feishu - wechatwork - packagist x-go-name: Type x-go-package: code.gitea.io/gitea/modules/structs CreateHookOptionConfig: description: 'CreateHookOptionConfig has all config options in it required are "content_type" and "url" Required' type: object additionalProperties: type: string x-go-package: code.gitea.io/gitea/modules/structs CreateIssueCommentOption: description: CreateIssueCommentOption options for creating a comment on an issue type: object required: - body properties: body: type: string x-go-name: Body x-go-package: code.gitea.io/gitea/modules/structs CreateIssueOption: description: CreateIssueOption options to create one issue type: object required: - title properties: assignee: description: deprecated type: string x-go-name: Assignee assignees: type: array items: type: string x-go-name: Assignees body: type: string x-go-name: Body closed: type: boolean x-go-name: Closed due_date: type: string format: date-time x-go-name: Deadline labels: description: list of label ids type: array items: type: integer format: int64 x-go-name: Labels milestone: description: milestone id type: integer format: int64 x-go-name: Milestone ref: type: string x-go-name: Ref title: type: string x-go-name: Title x-go-package: code.gitea.io/gitea/modules/structs CreateKeyOption: description: CreateKeyOption options when creating a key type: object required: - title - key properties: key: description: An armored SSH key to add type: string uniqueItems: true x-go-name: Key read_only: description: Describe if the key has only read access or read/write type: boolean x-go-name: ReadOnly title: description: Title of the key to add type: string uniqueItems: true x-go-name: Title x-go-package: code.gitea.io/gitea/modules/structs CreateLabelOption: description: CreateLabelOption options for creating a label type: object required: - name - color properties: color: type: string x-go-name: Color example: '#00aabb' description: description: Description provides additional context about the label's purpose type: string x-go-name: Description exclusive: type: boolean x-go-name: Exclusive example: false is_archived: type: boolean x-go-name: IsArchived example: false name: type: string x-go-name: Name x-go-package: code.gitea.io/gitea/modules/structs CreateMilestoneOption: description: CreateMilestoneOption options for creating a milestone type: object properties: description: description: Description provides details about the milestone type: string x-go-name: Description due_on: type: string format: date-time x-go-name: Deadline state: type: string enum: - open - closed x-go-name: State title: description: Title is the title of the new milestone type: string x-go-name: Title x-go-package: code.gitea.io/gitea/modules/structs CreateOAuth2ApplicationOptions: description: CreateOAuth2ApplicationOptions holds options to create an oauth2 application type: object properties: confidential_client: description: Whether the client is confidential type: boolean x-go-name: ConfidentialClient name: description: The name of the OAuth2 application type: string x-go-name: Name redirect_uris: description: The list of allowed redirect URIs type: array items: type: string x-go-name: RedirectURIs skip_secondary_authorization: description: Whether to skip secondary authorization type: boolean x-go-name: SkipSecondaryAuthorization x-go-package: code.gitea.io/gitea/modules/structs CreateOrUpdateSecretOption: description: CreateOrUpdateSecretOption options when creating or updating secret type: object required: - data properties: data: description: Data of the secret to update type: string x-go-name: Data description: description: Description of the secret to update type: string x-go-name: Description x-go-package: code.gitea.io/gitea/modules/structs CreateOrgOption: description: CreateOrgOption options for creating an organization type: object required: - username properties: description: description: The description of the organization type: string x-go-name: Description email: description: The email address of the organization type: string x-go-name: Email full_name: description: The full display name of the organization type: string x-go-name: FullName location: description: The location of the organization type: string x-go-name: Location repo_admin_change_team_access: description: Whether repository administrators can change team access type: boolean x-go-name: RepoAdminChangeTeamAccess username: description: username of the organization type: string x-go-name: UserName visibility: description: possible values are `public` (default), `limited` or `private` type: string enum: - public - limited - private x-go-name: Visibility website: description: The website URL of the organization type: string x-go-name: Website x-go-package: code.gitea.io/gitea/modules/structs CreatePullRequestOption: description: CreatePullRequestOption options when creating a pull request type: object properties: allow_maintainer_edit: description: Whether maintainers can edit the pull request type: boolean x-go-name: AllowMaintainerEdit assignee: description: The primary assignee username type: string x-go-name: Assignee assignees: description: The list of assignee usernames type: array items: type: string x-go-name: Assignees base: description: The base branch for the pull request type: string x-go-name: Base body: description: The description body of the pull request type: string x-go-name: Body due_date: type: string format: date-time x-go-name: Deadline head: description: 'The head branch for the pull request, it could be a branch name on the base repository or a form like `:` which refers to the user''s fork repository''s branch.' type: string x-go-name: Head labels: description: The list of label IDs to assign to the pull request type: array items: type: integer format: int64 x-go-name: Labels milestone: description: The milestone ID to assign to the pull request type: integer format: int64 x-go-name: Milestone reviewers: description: The list of reviewer usernames type: array items: type: string x-go-name: Reviewers team_reviewers: description: The list of team reviewer names type: array items: type: string x-go-name: TeamReviewers title: description: The title of the pull request type: string x-go-name: Title x-go-package: code.gitea.io/gitea/modules/structs CreatePullReviewComment: description: CreatePullReviewComment represent a review comment for creation api type: object properties: body: type: string x-go-name: Body new_position: description: if comment to new file line or 0 type: integer format: int64 x-go-name: NewLineNum old_position: description: if comment to old file line or 0 type: integer format: int64 x-go-name: OldLineNum path: description: the tree path type: string x-go-name: Path x-go-package: code.gitea.io/gitea/modules/structs CreatePullReviewOptions: description: CreatePullReviewOptions are options to create a pull request review type: object properties: body: type: string x-go-name: Body comments: type: array items: $ref: '#/components/schemas/CreatePullReviewComment' x-go-name: Comments commit_id: type: string x-go-name: CommitID event: type: string enum: - APPROVED - PENDING - COMMENT - REQUEST_CHANGES - REQUEST_REVIEW x-go-enum-desc: 'APPROVED ReviewStateApproved ReviewStateApproved pr is approved PENDING ReviewStatePending ReviewStatePending pr state is pending COMMENT ReviewStateComment ReviewStateComment is a comment review REQUEST_CHANGES ReviewStateRequestChanges ReviewStateRequestChanges changes for pr are requested REQUEST_REVIEW ReviewStateRequestReview ReviewStateRequestReview review is requested from user' x-go-name: Event x-go-package: code.gitea.io/gitea/modules/structs CreatePushMirrorOption: type: object title: CreatePushMirrorOption represents need information to create a push mirror of a repository. properties: interval: description: The sync interval for automatic updates type: string x-go-name: Interval remote_address: description: The remote repository URL to push to type: string x-go-name: RemoteAddress remote_password: description: The password for authentication with the remote repository type: string x-go-name: RemotePassword remote_username: description: The username for authentication with the remote repository type: string x-go-name: RemoteUsername sync_on_commit: description: Whether to sync on every commit type: boolean x-go-name: SyncOnCommit x-go-package: code.gitea.io/gitea/modules/structs CreateReleaseOption: description: CreateReleaseOption options when creating a release type: object required: - tag_name properties: body: description: The release notes or description type: string x-go-name: Note draft: description: Whether to create the release as a draft type: boolean x-go-name: IsDraft name: description: The display title of the release type: string x-go-name: Title prerelease: description: Whether to mark the release as a prerelease type: boolean x-go-name: IsPrerelease tag_message: description: The message for the git tag type: string x-go-name: TagMessage tag_name: type: string x-go-name: TagName target_commitish: description: The target commitish for the release type: string x-go-name: Target x-go-package: code.gitea.io/gitea/modules/structs CreateRepoOption: description: CreateRepoOption options when creating repository type: object required: - name properties: auto_init: description: Whether the repository should be auto-initialized? type: boolean x-go-name: AutoInit default_branch: description: DefaultBranch of the repository (used when initializes and in template) type: string x-go-name: DefaultBranch description: description: Description of the repository to create type: string x-go-name: Description gitignores: description: Gitignores to use type: string x-go-name: Gitignores issue_labels: description: Label-Set to use type: string x-go-name: IssueLabels license: description: License to use type: string x-go-name: License name: description: Name of the repository to create type: string uniqueItems: true x-go-name: Name object_format_name: description: ObjectFormatName of the underlying git repository, empty string for default (sha1) type: string enum: - sha1 - sha256 x-go-name: ObjectFormatName private: description: Whether the repository is private type: boolean x-go-name: Private readme: description: Readme of the repository to create type: string x-go-name: Readme template: description: Whether the repository is template type: boolean x-go-name: Template trust_model: description: TrustModel of the repository type: string enum: - default - collaborator - committer - collaboratorcommitter x-go-name: TrustModel x-go-package: code.gitea.io/gitea/modules/structs CreateStatusOption: description: CreateStatusOption holds the information needed to create a new CommitStatus for a Commit type: object properties: context: description: Context is the unique context identifier for the status type: string x-go-name: Context description: description: Description provides a brief description of the status type: string x-go-name: Description state: description: 'State represents the status state to set (pending, success, error, failure) pending CommitStatusPending CommitStatusPending is for when the CommitStatus is Pending success CommitStatusSuccess CommitStatusSuccess is for when the CommitStatus is Success error CommitStatusError CommitStatusError is for when the CommitStatus is Error failure CommitStatusFailure CommitStatusFailure is for when the CommitStatus is Failure warning CommitStatusWarning CommitStatusWarning is for when the CommitStatus is Warning skipped CommitStatusSkipped CommitStatusSkipped is for when CommitStatus is Skipped' type: string enum: - pending - success - error - failure - warning - skipped x-go-enum-desc: 'pending CommitStatusPending CommitStatusPending is for when the CommitStatus is Pending success CommitStatusSuccess CommitStatusSuccess is for when the CommitStatus is Success error CommitStatusError CommitStatusError is for when the CommitStatus is Error failure CommitStatusFailure CommitStatusFailure is for when the CommitStatus is Failure warning CommitStatusWarning CommitStatusWarning is for when the CommitStatus is Warning skipped CommitStatusSkipped CommitStatusSkipped is for when CommitStatus is Skipped' x-go-name: State target_url: description: TargetURL is the URL to link to for more details type: string x-go-name: TargetURL x-go-package: code.gitea.io/gitea/modules/structs CreateTagOption: description: CreateTagOption options when creating a tag type: object required: - tag_name properties: message: description: The message to associate with the tag type: string x-go-name: Message tag_name: type: string x-go-name: TagName target: description: The target commit SHA or branch name for the tag type: string x-go-name: Target x-go-package: code.gitea.io/gitea/modules/structs CreateTagProtectionOption: description: CreateTagProtectionOption options for creating a tag protection type: object properties: name_pattern: description: The pattern to match tag names for protection type: string x-go-name: NamePattern whitelist_teams: description: List of team names allowed to create/delete protected tags type: array items: type: string x-go-name: WhitelistTeams whitelist_usernames: description: List of usernames allowed to create/delete protected tags type: array items: type: string x-go-name: WhitelistUsernames x-go-package: code.gitea.io/gitea/modules/structs CreateTeamOption: description: CreateTeamOption options for creating a team type: object required: - name properties: can_create_org_repo: description: Whether the team can create repositories in the organization type: boolean x-go-name: CanCreateOrgRepo description: description: The description of the team type: string x-go-name: Description includes_all_repositories: description: Whether the team has access to all repositories in the organization type: boolean x-go-name: IncludesAllRepositories name: type: string x-go-name: Name permission: type: string enum: - read - write - admin x-go-name: Permission units: type: array items: type: string x-go-name: Units example: - repo.actions - repo.code - repo.issues - repo.ext_issues - repo.wiki - repo.ext_wiki - repo.pulls - repo.releases - repo.projects - repo.ext_wiki units_map: type: object additionalProperties: type: string x-go-name: UnitsMap example: '{"repo.actions","repo.packages","repo.code":"read","repo.issues":"write","repo.ext_issues":"none","repo.wiki":"admin","repo.pulls":"owner","repo.releases":"none","repo.projects":"none","repo.ext_wiki":"none"}' x-go-package: code.gitea.io/gitea/modules/structs CreateUserOption: description: CreateUserOption create user options type: object required: - username - email properties: created_at: description: 'For explicitly setting the user creation timestamp. Useful when users are migrated from other systems. When omitted, the user''s creation timestamp will be set to "now".' type: string format: date-time x-go-name: Created email: type: string format: email x-go-name: Email full_name: description: The full display name of the user type: string x-go-name: FullName login_name: description: identifier of the user, provided by the external authenticator (if configured) type: string default: empty x-go-name: LoginName must_change_password: description: Whether the user must change password on first login type: boolean x-go-name: MustChangePassword password: description: The plain text password for the user type: string x-go-name: Password restricted: description: Whether the user has restricted access privileges type: boolean x-go-name: Restricted send_notify: description: Whether to send welcome notification email to the user type: boolean x-go-name: SendNotify source_id: description: The authentication source ID to associate with the user type: integer format: int64 x-go-name: SourceID username: description: username of the user type: string x-go-name: Username visibility: description: 'User visibility level: public, limited, or private' type: string x-go-name: Visibility x-go-package: code.gitea.io/gitea/modules/structs CreateVariableOption: description: CreateVariableOption the option when creating variable type: object required: - value properties: description: description: Description of the variable to create type: string x-go-name: Description value: description: Value of the variable to create type: string x-go-name: Value x-go-package: code.gitea.io/gitea/modules/structs CreateWikiPageOptions: description: CreateWikiPageOptions form for creating wiki type: object properties: content_base64: description: content must be base64 encoded type: string x-go-name: ContentBase64 message: description: optional commit message summarizing the change type: string x-go-name: Message title: description: page title. leave empty to keep unchanged type: string x-go-name: Title x-go-package: code.gitea.io/gitea/modules/structs Cron: description: Cron represents a Cron task type: object properties: exec_times: description: The total number of times this cron task has been executed type: integer format: int64 x-go-name: ExecTimes name: description: The name of the cron task type: string x-go-name: Name next: description: The next scheduled execution time type: string format: date-time x-go-name: Next prev: description: The previous execution time type: string format: date-time x-go-name: Prev schedule: description: The cron schedule expression (e.g., "0 0 * * *") type: string x-go-name: Schedule x-go-package: code.gitea.io/gitea/modules/structs DeleteEmailOption: description: DeleteEmailOption options when deleting email addresses type: object properties: emails: description: email addresses to delete type: array items: type: string x-go-name: Emails x-go-package: code.gitea.io/gitea/modules/structs DeleteFileOptions: description: 'DeleteFileOptions options for deleting a file Note: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)' type: object required: - sha properties: author: $ref: '#/components/schemas/Identity' branch: description: branch (optional) is the base branch for the changes. If not supplied, the default branch is used type: string x-go-name: BranchName committer: $ref: '#/components/schemas/Identity' dates: $ref: '#/components/schemas/CommitDateOptions' force_push: description: force_push (optional) will do a force-push if the new branch already exists type: boolean x-go-name: ForcePush message: description: message (optional) is the commit message of the changes. If not supplied, a default message will be used type: string x-go-name: Message new_branch: description: new_branch (optional) will make a new branch from base branch for the changes. If not supplied, the changes will be committed to the base branch type: string x-go-name: NewBranchName sha: description: the blob ID (SHA) for the file to delete type: string x-go-name: SHA signoff: description: Add a Signed-off-by trailer by the committer at the end of the commit log message. type: boolean x-go-name: Signoff x-go-package: code.gitea.io/gitea/modules/structs DeployKey: description: DeployKey a deploy key type: object properties: created_at: type: string format: date-time x-go-name: Created fingerprint: description: Fingerprint is the key's fingerprint type: string x-go-name: Fingerprint id: description: ID is the unique identifier for the deploy key type: integer format: int64 x-go-name: ID key: description: Key contains the actual SSH key content type: string x-go-name: Key key_id: description: KeyID is the associated public key ID type: integer format: int64 x-go-name: KeyID read_only: description: ReadOnly indicates if the key has read-only access type: boolean x-go-name: ReadOnly repository: $ref: '#/components/schemas/Repository' title: description: Title is the human-readable name for the key type: string x-go-name: Title url: description: URL is the API URL for this deploy key type: string x-go-name: URL x-go-package: code.gitea.io/gitea/modules/structs DismissPullReviewOptions: description: DismissPullReviewOptions are options to dismiss a pull request review type: object properties: message: type: string x-go-name: Message priors: type: boolean x-go-name: Priors x-go-package: code.gitea.io/gitea/modules/structs EditActionRunnerOption: type: object title: EditActionRunnerOption represents the editable fields for a runner. required: - disabled properties: disabled: type: boolean x-go-name: Disabled x-go-package: code.gitea.io/gitea/modules/structs EditAttachmentOptions: description: EditAttachmentOptions options for editing attachments type: object properties: name: description: Name is the new filename for the attachment type: string x-go-name: Name x-go-package: code.gitea.io/gitea/modules/structs EditBranchProtectionOption: description: EditBranchProtectionOption options for editing a branch protection type: object properties: approvals_whitelist_teams: type: array items: type: string x-go-name: ApprovalsWhitelistTeams approvals_whitelist_username: type: array items: type: string x-go-name: ApprovalsWhitelistUsernames block_admin_merge_override: type: boolean x-go-name: BlockAdminMergeOverride block_on_official_review_requests: type: boolean x-go-name: BlockOnOfficialReviewRequests block_on_outdated_branch: type: boolean x-go-name: BlockOnOutdatedBranch block_on_rejected_reviews: type: boolean x-go-name: BlockOnRejectedReviews dismiss_stale_approvals: type: boolean x-go-name: DismissStaleApprovals enable_approvals_whitelist: type: boolean x-go-name: EnableApprovalsWhitelist enable_force_push: type: boolean x-go-name: EnableForcePush enable_force_push_allowlist: type: boolean x-go-name: EnableForcePushAllowlist enable_merge_whitelist: type: boolean x-go-name: EnableMergeWhitelist enable_push: type: boolean x-go-name: EnablePush enable_push_whitelist: type: boolean x-go-name: EnablePushWhitelist enable_status_check: type: boolean x-go-name: EnableStatusCheck force_push_allowlist_deploy_keys: type: boolean x-go-name: ForcePushAllowlistDeployKeys force_push_allowlist_teams: type: array items: type: string x-go-name: ForcePushAllowlistTeams force_push_allowlist_usernames: type: array items: type: string x-go-name: ForcePushAllowlistUsernames ignore_stale_approvals: type: boolean x-go-name: IgnoreStaleApprovals merge_whitelist_teams: type: array items: type: string x-go-name: MergeWhitelistTeams merge_whitelist_usernames: type: array items: type: string x-go-name: MergeWhitelistUsernames priority: type: integer format: int64 x-go-name: Priority protected_file_patterns: type: string x-go-name: ProtectedFilePatterns push_whitelist_deploy_keys: type: boolean x-go-name: PushWhitelistDeployKeys push_whitelist_teams: type: array items: type: string x-go-name: PushWhitelistTeams push_whitelist_usernames: type: array items: type: string x-go-name: PushWhitelistUsernames require_signed_commits: type: boolean x-go-name: RequireSignedCommits required_approvals: type: integer format: int64 x-go-name: RequiredApprovals status_check_contexts: type: array items: type: string x-go-name: StatusCheckContexts unprotected_file_patterns: type: string x-go-name: UnprotectedFilePatterns x-go-package: code.gitea.io/gitea/modules/structs EditDeadlineOption: description: EditDeadlineOption options for creating a deadline type: object required: - due_date properties: due_date: type: string format: date-time x-go-name: Deadline x-go-package: code.gitea.io/gitea/modules/structs EditGitHookOption: description: EditGitHookOption options when modifying one Git hook type: object properties: content: description: Content is the new script content for the hook type: string x-go-name: Content x-go-package: code.gitea.io/gitea/modules/structs EditHookOption: description: EditHookOption options when modify one hook type: object properties: active: description: Whether the webhook is active and will be triggered type: boolean x-go-name: Active authorization_header: description: Authorization header to include in webhook requests type: string x-go-name: AuthorizationHeader branch_filter: description: Branch filter pattern to determine which branches trigger the webhook type: string x-go-name: BranchFilter config: description: Configuration settings for the webhook type: object additionalProperties: type: string x-go-name: Config events: description: List of events that trigger this webhook type: array items: type: string x-go-name: Events name: description: Optional human-readable name type: string x-go-name: Name x-go-package: code.gitea.io/gitea/modules/structs EditIssueCommentOption: description: EditIssueCommentOption options for editing a comment type: object required: - body properties: body: type: string x-go-name: Body x-go-package: code.gitea.io/gitea/modules/structs EditIssueOption: description: EditIssueOption options for editing an issue type: object properties: assignee: description: deprecated type: string x-go-name: Assignee assignees: type: array items: type: string x-go-name: Assignees body: type: string x-go-name: Body content_version: description: The current version of the issue content to detect conflicts during editing type: integer format: int64 x-go-name: ContentVersion due_date: type: string format: date-time x-go-name: Deadline milestone: type: integer format: int64 x-go-name: Milestone ref: type: string x-go-name: Ref state: type: string x-go-name: State title: type: string x-go-name: Title unset_due_date: type: boolean x-go-name: RemoveDeadline x-go-package: code.gitea.io/gitea/modules/structs EditLabelOption: description: EditLabelOption options for editing a label type: object properties: color: type: string x-go-name: Color example: '#00aabb' description: description: Description provides additional context about the label's purpose type: string x-go-name: Description exclusive: type: boolean x-go-name: Exclusive example: false is_archived: type: boolean x-go-name: IsArchived example: false name: description: Name is the new display name for the label type: string x-go-name: Name x-go-package: code.gitea.io/gitea/modules/structs EditMilestoneOption: description: EditMilestoneOption options for editing a milestone type: object properties: description: description: Description provides updated details about the milestone type: string x-go-name: Description due_on: description: Deadline is the updated due date for the milestone type: string format: date-time x-go-name: Deadline state: description: State indicates the updated state of the milestone type: string enum: - open - closed x-go-name: State title: description: Title is the updated title of the milestone type: string x-go-name: Title x-go-package: code.gitea.io/gitea/modules/structs EditOrgOption: description: EditOrgOption options for editing an organization type: object properties: description: description: The description of the organization type: string x-go-name: Description email: description: The email address of the organization; use empty string to clear type: string x-go-name: Email full_name: description: The full display name of the organization type: string x-go-name: FullName location: description: The location of the organization type: string x-go-name: Location repo_admin_change_team_access: description: Whether repository administrators can change team access type: boolean x-go-name: RepoAdminChangeTeamAccess visibility: description: possible values are `public`, `limited` or `private` type: string enum: - public - limited - private x-go-name: Visibility website: description: The website URL of the organization type: string x-go-name: Website x-go-package: code.gitea.io/gitea/modules/structs EditPullRequestOption: description: EditPullRequestOption options when modify pull request type: object properties: allow_maintainer_edit: description: Whether to allow maintainer edits type: boolean x-go-name: AllowMaintainerEdit assignee: description: The new primary assignee username type: string x-go-name: Assignee assignees: description: The new list of assignee usernames type: array items: type: string x-go-name: Assignees base: description: The new base branch for the pull request type: string x-go-name: Base body: description: The new description body for the pull request type: string x-go-name: Body content_version: description: The current version of the pull request content to detect conflicts during editing type: integer format: int64 x-go-name: ContentVersion due_date: type: string format: date-time x-go-name: Deadline labels: description: The new list of label IDs for the pull request type: array items: type: integer format: int64 x-go-name: Labels milestone: description: The new milestone ID for the pull request type: integer format: int64 x-go-name: Milestone state: description: The new state for the pull request type: string x-go-name: State title: description: The new title for the pull request type: string x-go-name: Title unset_due_date: description: Whether to remove the current deadline type: boolean x-go-name: RemoveDeadline x-go-package: code.gitea.io/gitea/modules/structs EditReactionOption: description: EditReactionOption contain the reaction type type: object properties: content: description: The reaction content (e.g., emoji or reaction type) type: string x-go-name: Reaction x-go-package: code.gitea.io/gitea/modules/structs EditReleaseOption: description: EditReleaseOption options when editing a release type: object properties: body: description: The new release notes or description type: string x-go-name: Note draft: description: Whether to change the draft status type: boolean x-go-name: IsDraft name: description: The new display title of the release type: string x-go-name: Title prerelease: description: Whether to change the prerelease status type: boolean x-go-name: IsPrerelease tag_name: description: The new name of the git tag type: string x-go-name: TagName target_commitish: description: The new target commitish for the release type: string x-go-name: Target x-go-package: code.gitea.io/gitea/modules/structs EditRepoOption: description: EditRepoOption options when editing a repository's properties type: object properties: allow_fast_forward_only_merge: description: either `true` to allow fast-forward-only merging pull requests, or `false` to prevent fast-forward-only merging. type: boolean x-go-name: AllowFastForwardOnly allow_manual_merge: description: either `true` to allow mark pr as merged manually, or `false` to prevent it. type: boolean x-go-name: AllowManualMerge allow_merge_commits: description: either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. type: boolean x-go-name: AllowMerge allow_rebase: description: either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. type: boolean x-go-name: AllowRebase allow_rebase_explicit: description: either `true` to allow rebase with explicit merge commits (--no-ff), or `false` to prevent rebase with explicit merge commits. type: boolean x-go-name: AllowRebaseMerge allow_rebase_update: description: either `true` to allow updating pull request branch by rebase, or `false` to prevent it. type: boolean x-go-name: AllowRebaseUpdate allow_squash_merge: description: either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. type: boolean x-go-name: AllowSquash archived: description: set to `true` to archive this repository. type: boolean x-go-name: Archived autodetect_manual_merge: description: 'either `true` to enable AutodetectManualMerge, or `false` to prevent it. Note: In some special cases, misjudgments can occur.' type: boolean x-go-name: AutodetectManualMerge default_allow_maintainer_edit: description: set to `true` to allow edits from maintainers by default type: boolean x-go-name: DefaultAllowMaintainerEdit default_branch: description: sets the default branch for this repository. type: string x-go-name: DefaultBranch default_delete_branch_after_merge: description: set to `true` to delete pr branch after merge by default type: boolean x-go-name: DefaultDeleteBranchAfterMerge default_merge_style: description: 'set to a merge style to be used by this repository: "merge", "rebase", "rebase-merge", "squash", or "fast-forward-only".' type: string x-go-name: DefaultMergeStyle description: description: a short description of the repository. type: string x-go-name: Description enable_prune: description: enable prune - remove obsolete remote-tracking references when mirroring type: boolean x-go-name: EnablePrune external_tracker: $ref: '#/components/schemas/ExternalTracker' external_wiki: $ref: '#/components/schemas/ExternalWiki' has_actions: description: either `true` to enable actions unit, or `false` to disable them. type: boolean x-go-name: HasActions has_code: description: either `true` to enable code for this repository or `false` to disable it. type: boolean x-go-name: HasCode has_issues: description: either `true` to enable issues for this repository or `false` to disable them. type: boolean x-go-name: HasIssues has_packages: description: either `true` to enable packages unit, or `false` to disable them. type: boolean x-go-name: HasPackages has_projects: description: either `true` to enable project unit, or `false` to disable them. type: boolean x-go-name: HasProjects has_pull_requests: description: either `true` to allow pull requests, or `false` to prevent pull request. type: boolean x-go-name: HasPullRequests has_releases: description: either `true` to enable releases unit, or `false` to disable them. type: boolean x-go-name: HasReleases has_wiki: description: either `true` to enable the wiki for this repository or `false` to disable it. type: boolean x-go-name: HasWiki ignore_whitespace_conflicts: description: either `true` to ignore whitespace for conflicts, or `false` to not ignore whitespace. type: boolean x-go-name: IgnoreWhitespaceConflicts internal_tracker: $ref: '#/components/schemas/InternalTracker' mirror_interval: description: set to a string like `8h30m0s` to set the mirror interval time type: string x-go-name: MirrorInterval name: description: name of the repository type: string uniqueItems: true x-go-name: Name private: description: 'either `true` to make the repository private or `false` to make it public. Note: you will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.' type: boolean x-go-name: Private projects_mode: description: '`repo` to only allow repo-level projects, `owner` to only allow owner projects, `all` to allow both.' type: string x-go-name: ProjectsMode template: description: either `true` to make this repository a template or `false` to make it a normal repository type: boolean x-go-name: Template website: description: a URL with more information about the repository. type: string x-go-name: Website x-go-package: code.gitea.io/gitea/modules/structs EditTagProtectionOption: description: EditTagProtectionOption options for editing a tag protection type: object properties: name_pattern: description: The pattern to match tag names for protection type: string x-go-name: NamePattern whitelist_teams: description: List of team names allowed to create/delete protected tags type: array items: type: string x-go-name: WhitelistTeams whitelist_usernames: description: List of usernames allowed to create/delete protected tags type: array items: type: string x-go-name: WhitelistUsernames x-go-package: code.gitea.io/gitea/modules/structs EditTeamOption: description: EditTeamOption options for editing a team type: object required: - name properties: can_create_org_repo: description: Whether the team can create repositories in the organization type: boolean x-go-name: CanCreateOrgRepo description: description: The description of the team type: string x-go-name: Description includes_all_repositories: description: Whether the team has access to all repositories in the organization type: boolean x-go-name: IncludesAllRepositories name: type: string x-go-name: Name permission: type: string enum: - read - write - admin x-go-name: Permission units: type: array items: type: string x-go-name: Units example: - repo.code - repo.issues - repo.ext_issues - repo.wiki - repo.pulls - repo.releases - repo.projects - repo.ext_wiki units_map: type: object additionalProperties: type: string x-go-name: UnitsMap example: repo.code: read repo.ext_issues: none repo.ext_wiki: none repo.issues: write repo.projects: none repo.pulls: owner repo.releases: none repo.wiki: admin x-go-package: code.gitea.io/gitea/modules/structs EditUserOption: description: EditUserOption edit user options type: object required: - source_id - login_name properties: active: description: Whether the user account is active type: boolean x-go-name: Active admin: description: Whether the user has administrator privileges type: boolean x-go-name: Admin allow_create_organization: description: Whether the user can create organizations type: boolean x-go-name: AllowCreateOrganization allow_git_hook: description: Whether the user can use Git hooks type: boolean x-go-name: AllowGitHook allow_import_local: description: Whether the user can import local repositories type: boolean x-go-name: AllowImportLocal description: description: The user's personal description or bio type: string x-go-name: Description email: type: string format: email x-go-name: Email full_name: description: The full display name of the user type: string x-go-name: FullName location: description: The user's location or address type: string x-go-name: Location login_name: description: identifier of the user, provided by the external authenticator (if configured) type: string default: empty x-go-name: LoginName max_repo_creation: description: Maximum number of repositories the user can create type: integer format: int64 x-go-name: MaxRepoCreation must_change_password: description: Whether the user must change password on next login type: boolean x-go-name: MustChangePassword password: description: The plain text password for the user type: string x-go-name: Password prohibit_login: description: Whether the user is prohibited from logging in type: boolean x-go-name: ProhibitLogin restricted: description: Whether the user has restricted access privileges type: boolean x-go-name: Restricted source_id: type: integer format: int64 x-go-name: SourceID visibility: description: 'User visibility level: public, limited, or private' type: string x-go-name: Visibility website: description: The user's personal website URL type: string x-go-name: Website x-go-package: code.gitea.io/gitea/modules/structs Email: description: Email an email address belonging to a user type: object properties: email: type: string format: email x-go-name: Email primary: description: Whether this is the primary email address type: boolean x-go-name: Primary user_id: description: The unique identifier of the user who owns this email type: integer format: int64 x-go-name: UserID username: description: username of the user type: string x-go-name: UserName verified: description: Whether the email address has been verified type: boolean x-go-name: Verified x-go-package: code.gitea.io/gitea/modules/structs ExternalTracker: description: ExternalTracker represents settings for external tracker type: object properties: external_tracker_format: description: External Issue Tracker URL Format. Use the placeholders {user}, {repo} and {index} for the username, repository name and issue index. type: string x-go-name: ExternalTrackerFormat external_tracker_regexp_pattern: description: External Issue Tracker issue regular expression type: string x-go-name: ExternalTrackerRegexpPattern external_tracker_style: description: External Issue Tracker Number Format, either `numeric`, `alphanumeric`, or `regexp` type: string x-go-name: ExternalTrackerStyle external_tracker_url: description: URL of external issue tracker. type: string x-go-name: ExternalTrackerURL x-go-package: code.gitea.io/gitea/modules/structs ExternalWiki: description: ExternalWiki represents setting for external wiki type: object properties: external_wiki_url: description: URL of external wiki. type: string x-go-name: ExternalWikiURL x-go-package: code.gitea.io/gitea/modules/structs FileCommitResponse: type: object title: FileCommitResponse contains information generated from a Git commit for a repo's file. properties: author: $ref: '#/components/schemas/CommitUser' committer: $ref: '#/components/schemas/CommitUser' created: type: string format: date-time x-go-name: Created html_url: description: HTMLURL is the web URL for viewing this commit type: string x-go-name: HTMLURL message: description: Message is the commit message type: string x-go-name: Message parents: description: Parents contains parent commit metadata type: array items: $ref: '#/components/schemas/CommitMeta' x-go-name: Parents sha: description: SHA is the commit SHA hash type: string x-go-name: SHA tree: $ref: '#/components/schemas/CommitMeta' url: description: URL is the API URL for the commit type: string x-go-name: URL x-go-package: code.gitea.io/gitea/modules/structs FileDeleteResponse: description: FileDeleteResponse contains information about a repo's file that was deleted type: object properties: commit: $ref: '#/components/schemas/FileCommitResponse' content: description: Content is always null for delete operations x-go-name: Content verification: $ref: '#/components/schemas/PayloadCommitVerification' x-go-package: code.gitea.io/gitea/modules/structs FileLinksResponse: description: FileLinksResponse contains the links for a repo's file type: object properties: git: description: GitURL is the Git API URL for this file type: string x-go-name: GitURL html: description: HTMLURL is the web URL for this file type: string x-go-name: HTMLURL self: description: Self is the API URL for this file type: string x-go-name: Self x-go-package: code.gitea.io/gitea/modules/structs FileResponse: description: FileResponse contains information about a repo's file type: object properties: commit: $ref: '#/components/schemas/FileCommitResponse' content: $ref: '#/components/schemas/ContentsResponse' verification: $ref: '#/components/schemas/PayloadCommitVerification' x-go-package: code.gitea.io/gitea/modules/structs FilesResponse: description: FilesResponse contains information about multiple files from a repo type: object properties: commit: $ref: '#/components/schemas/FileCommitResponse' files: description: Files contains the list of file contents and metadata type: array items: $ref: '#/components/schemas/ContentsResponse' x-go-name: Files verification: $ref: '#/components/schemas/PayloadCommitVerification' x-go-package: code.gitea.io/gitea/modules/structs GPGKey: description: GPGKey a user GPG key to sign commit and tag in repository type: object properties: can_certify: description: Whether the key can be used for certification type: boolean x-go-name: CanCertify can_encrypt_comms: description: Whether the key can be used for encrypting communications type: boolean x-go-name: CanEncryptComms can_encrypt_storage: description: Whether the key can be used for encrypting storage type: boolean x-go-name: CanEncryptStorage can_sign: description: Whether the key can be used for signing type: boolean x-go-name: CanSign created_at: type: string format: date-time x-go-name: Created emails: description: List of email addresses associated with this GPG key type: array items: $ref: '#/components/schemas/GPGKeyEmail' x-go-name: Emails expires_at: type: string format: date-time x-go-name: Expires id: description: The unique identifier of the GPG key type: integer format: int64 x-go-name: ID key_id: description: The key ID of the GPG key type: string x-go-name: KeyID primary_key_id: description: The primary key ID of the GPG key type: string x-go-name: PrimaryKeyID public_key: description: The public key content in armored format type: string x-go-name: PublicKey subkeys: description: List of subkeys of this GPG key type: array items: $ref: '#/components/schemas/GPGKey' x-go-name: SubsKey verified: description: Whether the GPG key has been verified type: boolean x-go-name: Verified x-go-package: code.gitea.io/gitea/modules/structs GPGKeyEmail: description: GPGKeyEmail an email attached to a GPGKey type: object properties: email: description: The email address associated with the GPG key type: string x-go-name: Email verified: description: Whether the email address has been verified type: boolean x-go-name: Verified x-go-package: code.gitea.io/gitea/modules/structs GeneralAPISettings: description: GeneralAPISettings contains global api settings exposed by it type: object properties: default_git_trees_per_page: description: DefaultGitTreesPerPage is the default number of Git tree items per page type: integer format: int64 x-go-name: DefaultGitTreesPerPage default_max_blob_size: description: DefaultMaxBlobSize is the default maximum blob size for API responses type: integer format: int64 x-go-name: DefaultMaxBlobSize default_max_response_size: description: DefaultMaxResponseSize is the default maximum response size type: integer format: int64 x-go-name: DefaultMaxResponseSize default_paging_num: description: DefaultPagingNum is the default number of items per page type: integer format: int64 x-go-name: DefaultPagingNum max_response_items: description: MaxResponseItems is the maximum number of items returned in API responses type: integer format: int64 x-go-name: MaxResponseItems x-go-package: code.gitea.io/gitea/modules/structs GeneralAttachmentSettings: description: GeneralAttachmentSettings contains global Attachment settings exposed by API type: object properties: allowed_types: description: AllowedTypes contains the allowed file types for attachments type: string x-go-name: AllowedTypes enabled: description: Enabled indicates if file attachments are enabled type: boolean x-go-name: Enabled max_files: description: MaxFiles is the maximum number of files per attachment type: integer format: int64 x-go-name: MaxFiles max_size: description: MaxSize is the maximum size for individual attachments type: integer format: int64 x-go-name: MaxSize x-go-package: code.gitea.io/gitea/modules/structs GeneralRepoSettings: description: GeneralRepoSettings contains global repository settings exposed by API type: object properties: http_git_disabled: description: HTTPGitDisabled indicates if HTTP Git operations are disabled type: boolean x-go-name: HTTPGitDisabled lfs_disabled: description: LFSDisabled indicates if Git LFS support is disabled type: boolean x-go-name: LFSDisabled migrations_disabled: description: MigrationsDisabled indicates if repository migrations are disabled type: boolean x-go-name: MigrationsDisabled mirrors_disabled: description: MirrorsDisabled indicates if repository mirroring is disabled type: boolean x-go-name: MirrorsDisabled stars_disabled: description: StarsDisabled indicates if repository starring is disabled type: boolean x-go-name: StarsDisabled time_tracking_disabled: description: TimeTrackingDisabled indicates if time tracking is disabled type: boolean x-go-name: TimeTrackingDisabled x-go-package: code.gitea.io/gitea/modules/structs GeneralUISettings: description: GeneralUISettings contains global ui settings exposed by API type: object properties: allowed_reactions: description: AllowedReactions contains the list of allowed emoji reactions type: array items: type: string x-go-name: AllowedReactions custom_emojis: description: CustomEmojis contains the list of custom emojis type: array items: type: string x-go-name: CustomEmojis default_theme: description: DefaultTheme is the default UI theme type: string x-go-name: DefaultTheme x-go-package: code.gitea.io/gitea/modules/structs GenerateRepoOption: description: GenerateRepoOption options when creating a repository using a template type: object required: - owner - name properties: avatar: description: include avatar of the template repo type: boolean x-go-name: Avatar default_branch: description: Default branch of the new repository type: string x-go-name: DefaultBranch description: description: Description of the repository to create type: string x-go-name: Description git_content: description: include git content of default branch in template repo type: boolean x-go-name: GitContent git_hooks: description: include git hooks in template repo type: boolean x-go-name: GitHooks labels: description: include labels in template repo type: boolean x-go-name: Labels name: type: string uniqueItems: true x-go-name: Name owner: description: the organization's name or individual user's name who will own the new repository type: string x-go-name: Owner private: description: Whether the repository is private type: boolean x-go-name: Private protected_branch: description: include protected branches in template repo type: boolean x-go-name: ProtectedBranch topics: description: include topics in template repo type: boolean x-go-name: Topics webhooks: description: include webhooks in template repo type: boolean x-go-name: Webhooks x-go-package: code.gitea.io/gitea/modules/structs GetFilesOptions: description: GetFilesOptions options for retrieving metadate and content of multiple files type: object properties: files: description: Files is the list of file paths to retrieve type: array items: type: string x-go-name: Files x-go-package: code.gitea.io/gitea/modules/structs GitBlobResponse: description: GitBlobResponse represents a git blob type: object properties: content: description: The content of the git blob (may be base64 encoded) type: string x-go-name: Content encoding: description: The encoding used for the content (e.g., "base64") type: string x-go-name: Encoding lfs_oid: description: The LFS object ID if this blob is stored in LFS type: string x-go-name: LfsOid lfs_size: description: The size of the LFS object if this blob is stored in LFS type: integer format: int64 x-go-name: LfsSize sha: description: The SHA hash of the git blob type: string x-go-name: SHA size: description: The size of the git blob in bytes type: integer format: int64 x-go-name: Size url: description: The URL to access this git blob type: string x-go-name: URL x-go-package: code.gitea.io/gitea/modules/structs GitEntry: description: GitEntry represents a git tree type: object properties: mode: description: Mode is the file mode (permissions) type: string x-go-name: Mode path: description: Path is the file or directory path type: string x-go-name: Path sha: description: SHA is the Git object SHA type: string x-go-name: SHA size: description: Size is the file size in bytes type: integer format: int64 x-go-name: Size type: description: Type indicates if this is a file, directory, or symlink type: string x-go-name: Type url: description: URL is the API URL for this tree entry type: string x-go-name: URL x-go-package: code.gitea.io/gitea/modules/structs GitHook: description: GitHook represents a Git repository hook type: object properties: content: description: Content contains the script content of the hook type: string x-go-name: Content is_active: description: IsActive indicates if the hook is active type: boolean x-go-name: IsActive name: description: Name is the name of the Git hook type: string x-go-name: Name x-go-package: code.gitea.io/gitea/modules/structs GitObject: type: object title: GitObject represents a Git object. properties: sha: description: The SHA hash of the Git object type: string x-go-name: SHA type: description: The type of the Git object (e.g., commit, tag, tree, blob) type: string x-go-name: Type url: description: The URL to access this Git object type: string x-go-name: URL x-go-package: code.gitea.io/gitea/modules/structs GitTreeResponse: description: GitTreeResponse returns a git tree type: object properties: page: description: Page is the current page number for pagination type: integer format: int64 x-go-name: Page sha: description: SHA is the tree object SHA type: string x-go-name: SHA total_count: description: TotalCount is the total number of entries in the tree type: integer format: int64 x-go-name: TotalCount tree: description: Entries contains the tree entries (files and directories) type: array items: $ref: '#/components/schemas/GitEntry' x-go-name: Entries truncated: description: Truncated indicates if the response was truncated due to size type: boolean x-go-name: Truncated url: description: URL is the API URL for this tree type: string x-go-name: URL x-go-package: code.gitea.io/gitea/modules/structs GitignoreTemplateInfo: description: GitignoreTemplateInfo name and text of a gitignore template type: object properties: name: description: Name is the name of the gitignore template type: string x-go-name: Name source: description: Source contains the content of the gitignore template type: string x-go-name: Source x-go-package: code.gitea.io/gitea/modules/structs Hook: description: Hook a hook is a web hook when one repository changed type: object properties: active: description: Whether the webhook is active and will be triggered type: boolean x-go-name: Active authorization_header: description: Authorization header to include in webhook requests type: string x-go-name: AuthorizationHeader branch_filter: description: Branch filter pattern to determine which branches trigger the webhook type: string x-go-name: BranchFilter config: description: Configuration settings for the webhook type: object additionalProperties: type: string x-go-name: Config created_at: type: string format: date-time x-go-name: Created events: description: List of events that trigger this webhook type: array items: type: string x-go-name: Events id: description: The unique identifier of the webhook type: integer format: int64 x-go-name: ID name: description: Optional human-readable name for the webhook type: string x-go-name: Name type: description: The type of the webhook (e.g., gitea, slack, discord) type: string x-go-name: Type updated_at: type: string format: date-time x-go-name: Updated x-go-package: code.gitea.io/gitea/modules/structs Identity: description: Identity for a person's identity like an author or committer type: object properties: email: type: string format: email x-go-name: Email name: description: Name is the person's name type: string x-go-name: Name x-go-package: code.gitea.io/gitea/modules/structs InternalTracker: description: InternalTracker represents settings for internal tracker type: object properties: allow_only_contributors_to_track_time: description: Let only contributors track time (Built-in issue tracker) type: boolean x-go-name: AllowOnlyContributorsToTrackTime enable_issue_dependencies: description: Enable dependencies for issues and pull requests (Built-in issue tracker) type: boolean x-go-name: EnableIssueDependencies enable_time_tracker: description: Enable time tracking (Built-in issue tracker) type: boolean x-go-name: EnableTimeTracker x-go-package: code.gitea.io/gitea/modules/structs Issue: description: Issue represents an issue in a repository type: object properties: assets: type: array items: $ref: '#/components/schemas/Attachment' x-go-name: Attachments assignee: $ref: '#/components/schemas/User' assignees: type: array items: $ref: '#/components/schemas/User' x-go-name: Assignees body: type: string x-go-name: Body closed_at: type: string format: date-time x-go-name: Closed comments: type: integer format: int64 x-go-name: Comments content_version: description: The version of the issue content for optimistic locking type: integer format: int64 x-go-name: ContentVersion created_at: type: string format: date-time x-go-name: Created due_date: type: string format: date-time x-go-name: Deadline html_url: type: string x-go-name: HTMLURL id: type: integer format: int64 x-go-name: ID is_locked: type: boolean x-go-name: IsLocked labels: type: array items: $ref: '#/components/schemas/Label' x-go-name: Labels milestone: $ref: '#/components/schemas/Milestone' number: type: integer format: int64 x-go-name: Index original_author: type: string x-go-name: OriginalAuthor original_author_id: type: integer format: int64 x-go-name: OriginalAuthorID pin_order: type: integer format: int64 x-go-name: PinOrder pull_request: $ref: '#/components/schemas/PullRequestMeta' ref: type: string x-go-name: Ref repository: $ref: '#/components/schemas/RepositoryMeta' state: type: string enum: - open - closed x-go-enum-desc: 'open StateOpen StateOpen pr is opened closed StateClosed StateClosed pr is closed' x-go-name: State time_estimate: type: integer format: int64 x-go-name: TimeEstimate title: type: string x-go-name: Title updated_at: type: string format: date-time x-go-name: Updated url: type: string x-go-name: URL user: $ref: '#/components/schemas/User' x-go-package: code.gitea.io/gitea/modules/structs IssueConfig: type: object properties: blank_issues_enabled: type: boolean x-go-name: BlankIssuesEnabled contact_links: type: array items: $ref: '#/components/schemas/IssueConfigContactLink' x-go-name: ContactLinks x-go-package: code.gitea.io/gitea/modules/structs IssueConfigContactLink: type: object properties: about: type: string x-go-name: About name: type: string x-go-name: Name url: type: string x-go-name: URL x-go-package: code.gitea.io/gitea/modules/structs IssueConfigValidation: type: object properties: message: type: string x-go-name: Message valid: type: boolean x-go-name: Valid x-go-package: code.gitea.io/gitea/modules/structs IssueDeadline: description: IssueDeadline represents an issue deadline type: object properties: due_date: type: string format: date-time x-go-name: Deadline x-go-package: code.gitea.io/gitea/modules/structs IssueFormField: description: IssueFormField represents a form field type: object properties: attributes: type: object additionalProperties: {} x-go-name: Attributes id: type: string x-go-name: ID type: type: string enum: - markdown - textarea - input - dropdown - checkboxes x-go-enum-desc: 'markdown IssueFormFieldTypeMarkdown textarea IssueFormFieldTypeTextarea input IssueFormFieldTypeInput dropdown IssueFormFieldTypeDropdown checkboxes IssueFormFieldTypeCheckboxes' x-go-name: Type validations: type: object additionalProperties: {} x-go-name: Validations visible: type: array items: type: string enum: - form - content x-go-enum-desc: 'form IssueFormFieldVisibleForm content IssueFormFieldVisibleContent' x-go-name: Visible x-go-package: code.gitea.io/gitea/modules/structs IssueLabelsOption: description: IssueLabelsOption a collection of labels type: object properties: labels: description: 'Labels can be a list of integers representing label IDs or a list of strings representing label names' type: array items: {} x-go-name: Labels x-go-package: code.gitea.io/gitea/modules/structs IssueMeta: description: IssueMeta basic issue information type: object properties: index: type: integer format: int64 x-go-name: Index owner: description: owner of the issue's repo type: string x-go-name: Owner repo: type: string x-go-name: Name x-go-package: code.gitea.io/gitea/modules/structs IssueTemplate: description: IssueTemplate represents an issue template for a repository type: object properties: about: type: string x-go-name: About assignees: $ref: '#/components/schemas/IssueTemplateStringSlice' body: type: array items: $ref: '#/components/schemas/IssueFormField' x-go-name: Fields content: type: string x-go-name: Content file_name: type: string x-go-name: FileName labels: $ref: '#/components/schemas/IssueTemplateStringSlice' name: type: string x-go-name: Name ref: type: string x-go-name: Ref title: type: string x-go-name: Title x-go-package: code.gitea.io/gitea/modules/structs IssueTemplateStringSlice: type: array items: type: string x-go-package: code.gitea.io/gitea/modules/structs Label: description: Label a label to an issue or a pr type: object properties: color: type: string x-go-name: Color example: 00aabb description: description: Description provides additional context about the label's purpose type: string x-go-name: Description exclusive: type: boolean x-go-name: Exclusive example: false id: description: ID is the unique identifier for the label type: integer format: int64 x-go-name: ID is_archived: type: boolean x-go-name: IsArchived example: false name: description: Name is the display name of the label type: string x-go-name: Name url: description: URL is the API endpoint for accessing this label type: string x-go-name: URL x-go-package: code.gitea.io/gitea/modules/structs LabelTemplate: description: LabelTemplate info of a Label template type: object properties: color: type: string x-go-name: Color example: 00aabb description: description: Description provides additional context about the label template's purpose type: string x-go-name: Description exclusive: type: boolean x-go-name: Exclusive example: false name: description: Name is the display name of the label template type: string x-go-name: Name x-go-package: code.gitea.io/gitea/modules/structs LicenseTemplateInfo: description: LicensesInfo contains information about a License type: object properties: body: description: Body contains the full text of the license type: string x-go-name: Body implementation: description: Implementation contains license implementation details type: string x-go-name: Implementation key: description: Key is the unique identifier for the license template type: string x-go-name: Key name: description: Name is the display name of the license type: string x-go-name: Name url: description: URL is the reference URL for the license type: string x-go-name: URL x-go-package: code.gitea.io/gitea/modules/structs LicensesTemplateListEntry: description: LicensesListEntry is used for the API type: object properties: key: description: Key is the unique identifier for the license template type: string x-go-name: Key name: description: Name is the display name of the license type: string x-go-name: Name url: description: URL is the reference URL for the license type: string x-go-name: URL x-go-package: code.gitea.io/gitea/modules/structs LockIssueOption: description: LockIssueOption options to lock an issue type: object properties: lock_reason: type: string x-go-name: Reason x-go-package: code.gitea.io/gitea/modules/structs MarkdownOption: description: MarkdownOption markdown options type: object properties: Context: description: 'URL path for rendering issue, media and file links Expected format: /subpath/{user}/{repo}/src/{branch, commit, tag}/{identifier/path}/{file/dir} in: body' type: string Mode: description: 'Mode to render (markdown, comment, wiki, file) in: body' type: string Text: description: 'Text markdown to render in: body' type: string Wiki: description: 'Is it a wiki page? (use mode=wiki instead) Deprecated: true in: body' type: boolean x-go-package: code.gitea.io/gitea/modules/structs MarkupOption: description: MarkupOption markup options type: object properties: Context: description: 'URL path for rendering issue, media and file links Expected format: /subpath/{user}/{repo}/src/{branch, commit, tag}/{identifier/path}/{file/dir} in: body' type: string FilePath: description: 'File path for detecting extension in file mode in: body' type: string Mode: description: 'Mode to render (markdown, comment, wiki, file) in: body' type: string Text: description: 'Text markup to render in: body' type: string Wiki: description: 'Is it a wiki page? (use mode=wiki instead) Deprecated: true in: body' type: boolean x-go-package: code.gitea.io/gitea/modules/structs MergePullRequestOption: description: MergePullRequestForm form for merging Pull Request type: object required: - do properties: delete_branch_after_merge: type: boolean x-go-name: DeleteBranchAfterMerge do: type: string enum: - merge - rebase - rebase-merge - squash - fast-forward-only - manually-merged x-go-name: Do force_merge: type: boolean x-go-name: ForceMerge head_commit_id: type: string x-go-name: HeadCommitID merge_commit_id: type: string x-go-name: MergeCommitID merge_message_field: type: string x-go-name: MergeMessageField merge_title_field: type: string x-go-name: MergeTitleField merge_when_checks_succeed: type: boolean x-go-name: MergeWhenChecksSucceed x-go-name: MergePullRequestForm x-go-package: code.gitea.io/gitea/services/forms MergeUpstreamRequest: type: object properties: branch: type: string x-go-name: Branch ff_only: type: boolean x-go-name: FfOnly x-go-package: code.gitea.io/gitea/modules/structs MergeUpstreamResponse: type: object properties: merge_type: type: string x-go-name: MergeStyle x-go-package: code.gitea.io/gitea/modules/structs MigrateRepoOptions: description: 'MigrateRepoOptions options for migrating repository''s this is used to interact with api v1' type: object required: - clone_addr - repo_name properties: auth_password: type: string x-go-name: AuthPassword auth_token: type: string x-go-name: AuthToken auth_username: type: string x-go-name: AuthUsername aws_access_key_id: type: string x-go-name: AWSAccessKeyID aws_secret_access_key: type: string x-go-name: AWSSecretAccessKey clone_addr: type: string x-go-name: CloneAddr description: type: string x-go-name: Description issues: type: boolean x-go-name: Issues labels: type: boolean x-go-name: Labels lfs: type: boolean x-go-name: LFS lfs_endpoint: type: string x-go-name: LFSEndpoint milestones: type: boolean x-go-name: Milestones mirror: type: boolean x-go-name: Mirror mirror_interval: type: string x-go-name: MirrorInterval private: type: boolean x-go-name: Private pull_requests: type: boolean x-go-name: PullRequests releases: type: boolean x-go-name: Releases repo_name: type: string x-go-name: RepoName repo_owner: description: the organization's name or individual user's name who will own the migrated repository type: string x-go-name: RepoOwner service: type: string enum: - git - github - gitea - gitlab - gogs - onedev - gitbucket - codebase - codecommit x-go-name: Service uid: description: deprecated (only for backwards compatibility, use repo_owner instead) type: integer format: int64 x-go-name: RepoOwnerID wiki: type: boolean x-go-name: Wiki x-go-package: code.gitea.io/gitea/modules/structs Milestone: description: Milestone milestone is a collection of issues on one repository type: object properties: closed_at: type: string format: date-time x-go-name: Closed closed_issues: description: ClosedIssues is the number of closed issues in this milestone type: integer format: int64 x-go-name: ClosedIssues created_at: type: string format: date-time x-go-name: Created description: description: Description provides details about the milestone type: string x-go-name: Description due_on: type: string format: date-time x-go-name: Deadline id: description: ID is the unique identifier for the milestone type: integer format: int64 x-go-name: ID open_issues: description: OpenIssues is the number of open issues in this milestone type: integer format: int64 x-go-name: OpenIssues state: description: 'State indicates if the milestone is open or closed open StateOpen StateOpen pr is opened closed StateClosed StateClosed pr is closed' type: string enum: - open - closed x-go-enum-desc: 'open StateOpen StateOpen pr is opened closed StateClosed StateClosed pr is closed' x-go-name: State title: description: Title is the title of the milestone type: string x-go-name: Title updated_at: type: string format: date-time x-go-name: Updated x-go-package: code.gitea.io/gitea/modules/structs NewIssuePinsAllowed: description: NewIssuePinsAllowed represents an API response that says if new Issue Pins are allowed type: object properties: issues: type: boolean x-go-name: Issues pull_requests: type: boolean x-go-name: PullRequests x-go-package: code.gitea.io/gitea/modules/structs NodeInfo: description: NodeInfo contains standardized way of exposing metadata about a server running one of the distributed social networks type: object properties: metadata: description: Metadata contains free form key value pairs for software specific values type: object x-go-name: Metadata openRegistrations: description: OpenRegistrations indicates if new user registrations are accepted type: boolean x-go-name: OpenRegistrations protocols: description: Protocols lists the protocols supported by this server type: array items: type: string x-go-name: Protocols services: $ref: '#/components/schemas/NodeInfoServices' software: $ref: '#/components/schemas/NodeInfoSoftware' usage: $ref: '#/components/schemas/NodeInfoUsage' version: description: Version specifies the schema version type: string x-go-name: Version x-go-package: code.gitea.io/gitea/modules/structs NodeInfoServices: description: NodeInfoServices contains the third party sites this server can connect to via their application API type: object properties: inbound: description: Inbound lists services that can deliver content to this server type: array items: type: string x-go-name: Inbound outbound: description: Outbound lists services this server can deliver content to type: array items: type: string x-go-name: Outbound x-go-package: code.gitea.io/gitea/modules/structs NodeInfoSoftware: description: NodeInfoSoftware contains Metadata about server software in use type: object properties: homepage: description: Homepage is the URL to the homepage of this server software type: string x-go-name: Homepage name: description: Name is the canonical name of this server software type: string x-go-name: Name repository: description: Repository is the URL to the source code repository type: string x-go-name: Repository version: description: Version is the version of this server software type: string x-go-name: Version x-go-package: code.gitea.io/gitea/modules/structs NodeInfoUsage: description: NodeInfoUsage contains usage statistics for this server type: object properties: localComments: description: LocalComments is the total amount of comments made by users local to this server type: integer format: int64 x-go-name: LocalComments localPosts: description: LocalPosts is the total amount of posts made by users local to this server type: integer format: int64 x-go-name: LocalPosts users: $ref: '#/components/schemas/NodeInfoUsageUsers' x-go-package: code.gitea.io/gitea/modules/structs NodeInfoUsageUsers: description: NodeInfoUsageUsers contains statistics about the users of this server type: object properties: activeHalfyear: description: ActiveHalfyear is the amount of users that signed in at least once in the last 180 days type: integer format: int64 x-go-name: ActiveHalfyear activeMonth: description: ActiveMonth is the amount of users that signed in at least once in the last 30 days type: integer format: int64 x-go-name: ActiveMonth total: description: Total is the total amount of users on this server type: integer format: int64 x-go-name: Total x-go-package: code.gitea.io/gitea/modules/structs Note: description: Note contains information related to a git note type: object properties: commit: $ref: '#/components/schemas/Commit' message: description: The content message of the git note type: string x-go-name: Message x-go-package: code.gitea.io/gitea/modules/structs NotificationCount: description: NotificationCount number of unread notifications type: object properties: new: description: New is the number of unread notifications type: integer format: int64 x-go-name: New x-go-package: code.gitea.io/gitea/modules/structs NotificationSubject: description: NotificationSubject contains the notification subject (Issue/Pull/Commit) type: object properties: html_url: description: HTMLURL is the web URL for the notification subject type: string x-go-name: HTMLURL latest_comment_html_url: description: LatestCommentHTMLURL is the web URL for the latest comment type: string x-go-name: LatestCommentHTMLURL latest_comment_url: description: LatestCommentURL is the API URL for the latest comment type: string x-go-name: LatestCommentURL state: description: 'State indicates the current state of the notification subject open NotifySubjectStateOpen NotifySubjectStateOpen is an open subject closed NotifySubjectStateClosed NotifySubjectStateClosed is a closed subject merged NotifySubjectStateMerged NotifySubjectStateMerged is a merged pull request' type: string enum: - open - closed - merged x-go-enum-desc: 'open NotifySubjectStateOpen NotifySubjectStateOpen is an open subject closed NotifySubjectStateClosed NotifySubjectStateClosed is a closed subject merged NotifySubjectStateMerged NotifySubjectStateMerged is a merged pull request' x-go-name: State title: description: Title is the title of the notification subject type: string x-go-name: Title type: description: 'Type indicates the type of the notification subject Issue NotifySubjectIssue NotifySubjectIssue a issue is subject of an notification Pull NotifySubjectPull NotifySubjectPull a pull is subject of an notification Commit NotifySubjectCommit NotifySubjectCommit a commit is subject of an notification Repository NotifySubjectRepository NotifySubjectRepository a repository is subject of an notification' type: string enum: - Issue - Pull - Commit - Repository x-go-enum-desc: 'Issue NotifySubjectIssue NotifySubjectIssue a issue is subject of an notification Pull NotifySubjectPull NotifySubjectPull a pull is subject of an notification Commit NotifySubjectCommit NotifySubjectCommit a commit is subject of an notification Repository NotifySubjectRepository NotifySubjectRepository a repository is subject of an notification' x-go-name: Type url: description: URL is the API URL for the notification subject type: string x-go-name: URL x-go-package: code.gitea.io/gitea/modules/structs NotificationThread: description: NotificationThread expose Notification on API type: object properties: id: description: ID is the unique identifier for the notification thread type: integer format: int64 x-go-name: ID pinned: description: Pinned indicates if the notification is pinned type: boolean x-go-name: Pinned repository: $ref: '#/components/schemas/Repository' subject: $ref: '#/components/schemas/NotificationSubject' unread: description: Unread indicates if the notification has been read type: boolean x-go-name: Unread updated_at: description: UpdatedAt is the time when the notification was last updated type: string format: date-time x-go-name: UpdatedAt url: description: URL is the API URL for this notification thread type: string x-go-name: URL x-go-package: code.gitea.io/gitea/modules/structs OAuth2Application: type: object title: OAuth2Application represents an OAuth2 application. properties: client_id: description: The client ID of the OAuth2 application type: string x-go-name: ClientID client_secret: description: The client secret of the OAuth2 application type: string x-go-name: ClientSecret confidential_client: description: Whether the client is confidential type: boolean x-go-name: ConfidentialClient created: description: The timestamp when the application was created type: string format: date-time x-go-name: Created id: description: The unique identifier of the OAuth2 application type: integer format: int64 x-go-name: ID name: description: The name of the OAuth2 application type: string x-go-name: Name redirect_uris: description: The list of allowed redirect URIs type: array items: type: string x-go-name: RedirectURIs skip_secondary_authorization: description: Whether to skip secondary authorization type: boolean x-go-name: SkipSecondaryAuthorization x-go-package: code.gitea.io/gitea/modules/structs Organization: description: Organization represents an organization type: object properties: avatar_url: description: The URL of the organization's avatar type: string x-go-name: AvatarURL description: description: The description of the organization type: string x-go-name: Description email: description: The email address of the organization type: string x-go-name: Email full_name: description: The full display name of the organization type: string x-go-name: FullName id: description: The unique identifier of the organization type: integer format: int64 x-go-name: ID location: description: The location of the organization type: string x-go-name: Location name: description: The name of the organization type: string x-go-name: Name repo_admin_change_team_access: description: Whether repository administrators can change team access type: boolean x-go-name: RepoAdminChangeTeamAccess username: description: 'username of the organization deprecated' type: string x-go-name: UserName visibility: description: The visibility level of the organization (public, limited, private) type: string x-go-name: Visibility website: description: The website URL of the organization type: string x-go-name: Website x-go-package: code.gitea.io/gitea/modules/structs OrganizationPermissions: description: OrganizationPermissions list different users permissions on an organization type: object properties: can_create_repository: description: Whether the user can create repositories in the organization type: boolean x-go-name: CanCreateRepository can_read: description: Whether the user can read the organization type: boolean x-go-name: CanRead can_write: description: Whether the user can write to the organization type: boolean x-go-name: CanWrite is_admin: description: Whether the user is an admin of the organization type: boolean x-go-name: IsAdmin is_owner: description: Whether the user is an owner of the organization type: boolean x-go-name: IsOwner x-go-package: code.gitea.io/gitea/modules/structs PRBranchInfo: description: PRBranchInfo information about a branch type: object properties: label: description: The display name of the branch type: string x-go-name: Name ref: description: The git reference of the branch type: string x-go-name: Ref repo: $ref: '#/components/schemas/Repository' repo_id: description: The unique identifier of the repository type: integer format: int64 x-go-name: RepoID sha: description: The commit SHA of the branch head type: string x-go-name: Sha x-go-package: code.gitea.io/gitea/modules/structs Package: description: Package represents a package type: object properties: created_at: type: string format: date-time x-go-name: CreatedAt creator: $ref: '#/components/schemas/User' html_url: description: The HTML URL to view the package type: string x-go-name: HTMLURL id: description: The unique identifier of the package type: integer format: int64 x-go-name: ID name: description: The name of the package type: string x-go-name: Name owner: $ref: '#/components/schemas/User' repository: $ref: '#/components/schemas/Repository' type: description: The type of the package (e.g., npm, maven, docker) type: string x-go-name: Type version: description: The version of the package type: string x-go-name: Version x-go-package: code.gitea.io/gitea/modules/structs PackageFile: description: PackageFile represents a package file type: object properties: id: description: The unique identifier of the package file type: integer format: int64 x-go-name: ID md5: description: The MD5 hash of the package file type: string x-go-name: HashMD5 name: description: The name of the package file type: string x-go-name: Name sha1: description: The SHA1 hash of the package file type: string x-go-name: HashSHA1 sha256: description: The SHA256 hash of the package file type: string x-go-name: HashSHA256 sha512: description: The SHA512 hash of the package file type: string x-go-name: HashSHA512 size: description: The size of the package file in bytes type: integer format: int64 x-go-name: Size x-go-package: code.gitea.io/gitea/modules/structs PayloadCommit: description: PayloadCommit represents a commit type: object properties: added: description: List of files added in this commit type: array items: type: string x-go-name: Added author: $ref: '#/components/schemas/PayloadUser' committer: $ref: '#/components/schemas/PayloadUser' id: description: sha1 hash of the commit type: string x-go-name: ID message: description: The commit message type: string x-go-name: Message modified: description: List of files modified in this commit type: array items: type: string x-go-name: Modified removed: description: List of files removed in this commit type: array items: type: string x-go-name: Removed timestamp: type: string format: date-time x-go-name: Timestamp url: description: The URL to view this commit type: string x-go-name: URL verification: $ref: '#/components/schemas/PayloadCommitVerification' x-go-package: code.gitea.io/gitea/modules/structs PayloadCommitVerification: description: PayloadCommitVerification represents the GPG verification of a commit type: object properties: payload: description: The signed payload content type: string x-go-name: Payload reason: description: The reason for the verification status type: string x-go-name: Reason signature: description: The GPG signature of the commit type: string x-go-name: Signature signer: $ref: '#/components/schemas/PayloadUser' verified: description: Whether the commit signature is verified type: boolean x-go-name: Verified x-go-package: code.gitea.io/gitea/modules/structs PayloadUser: description: PayloadUser represents the author or committer of a commit type: object properties: email: type: string format: email x-go-name: Email name: description: Full name of the commit author type: string x-go-name: Name username: description: username of the user type: string x-go-name: UserName x-go-package: code.gitea.io/gitea/modules/structs Permission: description: Permission represents a set of permissions type: object properties: admin: type: boolean x-go-name: Admin pull: type: boolean x-go-name: Pull push: type: boolean x-go-name: Push x-go-package: code.gitea.io/gitea/modules/structs PublicKey: description: PublicKey publickey is a user key to push code to repository type: object properties: created_at: type: string format: date-time x-go-name: Created fingerprint: description: Fingerprint is the key's fingerprint type: string x-go-name: Fingerprint id: description: ID is the unique identifier for the public key type: integer format: int64 x-go-name: ID key: description: Key contains the actual SSH public key content type: string x-go-name: Key key_type: description: KeyType indicates the type of the SSH key type: string x-go-name: KeyType last_used_at: description: Updated is the time when the key was last used type: string format: date-time x-go-name: Updated read_only: description: ReadOnly indicates if the key has read-only access type: boolean x-go-name: ReadOnly title: description: Title is the human-readable name for the key type: string x-go-name: Title url: description: URL is the API URL for this key type: string x-go-name: URL user: $ref: '#/components/schemas/User' x-go-package: code.gitea.io/gitea/modules/structs PullRequest: description: PullRequest represents a pull request type: object properties: additions: description: The number of lines added in the pull request type: integer format: int64 x-go-name: Additions allow_maintainer_edit: description: Whether maintainers can edit the pull request type: boolean x-go-name: AllowMaintainerEdit assignee: $ref: '#/components/schemas/User' assignees: description: The list of users assigned to the pull request type: array items: $ref: '#/components/schemas/User' x-go-name: Assignees base: $ref: '#/components/schemas/PRBranchInfo' body: description: The description body of the pull request type: string x-go-name: Body changed_files: description: The number of files changed in the pull request type: integer format: int64 x-go-name: ChangedFiles closed_at: type: string format: date-time x-go-name: Closed comments: description: The number of comments on the pull request type: integer format: int64 x-go-name: Comments content_version: description: The version of the pull request content for optimistic locking type: integer format: int64 x-go-name: ContentVersion created_at: type: string format: date-time x-go-name: Created deletions: description: The number of lines deleted in the pull request type: integer format: int64 x-go-name: Deletions diff_url: description: The URL to download the diff patch type: string x-go-name: DiffURL draft: description: Whether the pull request is a draft type: boolean x-go-name: Draft due_date: type: string format: date-time x-go-name: Deadline head: $ref: '#/components/schemas/PRBranchInfo' html_url: description: The HTML URL to view the pull request type: string x-go-name: HTMLURL id: description: The unique identifier of the pull request type: integer format: int64 x-go-name: ID is_locked: description: Whether the pull request conversation is locked type: boolean x-go-name: IsLocked labels: description: The labels attached to the pull request type: array items: $ref: '#/components/schemas/Label' x-go-name: Labels merge_base: description: The merge base commit SHA type: string x-go-name: MergeBase merge_commit_sha: description: The SHA of the merge commit type: string x-go-name: MergedCommitID mergeable: description: Whether the pull request can be merged type: boolean x-go-name: Mergeable merged: description: Whether the pull request has been merged type: boolean x-go-name: HasMerged merged_at: type: string format: date-time x-go-name: Merged merged_by: $ref: '#/components/schemas/User' milestone: $ref: '#/components/schemas/Milestone' number: description: The pull request number type: integer format: int64 x-go-name: Index patch_url: description: The URL to download the patch file type: string x-go-name: PatchURL pin_order: description: The pin order for the pull request type: integer format: int64 x-go-name: PinOrder requested_reviewers: description: The users requested to review the pull request type: array items: $ref: '#/components/schemas/User' x-go-name: RequestedReviewers requested_reviewers_teams: description: The teams requested to review the pull request type: array items: $ref: '#/components/schemas/Team' x-go-name: RequestedReviewersTeams review_comments: description: number of review comments made on the diff of a PR review (not including comments on commits or issues in a PR) type: integer format: int64 x-go-name: ReviewComments state: description: 'The current state of the pull request open StateOpen StateOpen pr is opened closed StateClosed StateClosed pr is closed' type: string enum: - open - closed x-go-enum-desc: 'open StateOpen StateOpen pr is opened closed StateClosed StateClosed pr is closed' x-go-name: State title: description: The title of the pull request type: string x-go-name: Title updated_at: type: string format: date-time x-go-name: Updated url: description: The API URL of the pull request type: string x-go-name: URL user: $ref: '#/components/schemas/User' x-go-package: code.gitea.io/gitea/modules/structs PullRequestMeta: description: PullRequestMeta PR info if an issue is a PR type: object properties: draft: type: boolean x-go-name: IsWorkInProgress html_url: type: string x-go-name: HTMLURL merged: type: boolean x-go-name: HasMerged merged_at: type: string format: date-time x-go-name: Merged x-go-package: code.gitea.io/gitea/modules/structs PullReview: description: PullReview represents a pull request review type: object properties: body: type: string x-go-name: Body comments_count: type: integer format: int64 x-go-name: CodeCommentsCount commit_id: type: string x-go-name: CommitID dismissed: type: boolean x-go-name: Dismissed html_url: description: HTMLURL is the web URL for viewing the review type: string x-go-name: HTMLURL id: type: integer format: int64 x-go-name: ID official: type: boolean x-go-name: Official pull_request_url: description: HTMLPullURL is the web URL for the pull request type: string x-go-name: HTMLPullURL stale: type: boolean x-go-name: Stale state: type: string enum: - APPROVED - PENDING - COMMENT - REQUEST_CHANGES - REQUEST_REVIEW x-go-enum-desc: 'APPROVED ReviewStateApproved ReviewStateApproved pr is approved PENDING ReviewStatePending ReviewStatePending pr state is pending COMMENT ReviewStateComment ReviewStateComment is a comment review REQUEST_CHANGES ReviewStateRequestChanges ReviewStateRequestChanges changes for pr are requested REQUEST_REVIEW ReviewStateRequestReview ReviewStateRequestReview review is requested from user' x-go-name: State submitted_at: type: string format: date-time x-go-name: Submitted team: $ref: '#/components/schemas/Team' updated_at: type: string format: date-time x-go-name: Updated user: $ref: '#/components/schemas/User' x-go-package: code.gitea.io/gitea/modules/structs PullReviewComment: description: PullReviewComment represents a comment on a pull request review type: object properties: body: type: string x-go-name: Body commit_id: type: string x-go-name: CommitID created_at: type: string format: date-time x-go-name: Created diff_hunk: type: string x-go-name: DiffHunk html_url: type: string x-go-name: HTMLURL id: type: integer format: int64 x-go-name: ID original_commit_id: type: string x-go-name: OrigCommitID original_position: type: integer format: uint64 x-go-name: OldLineNum path: type: string x-go-name: Path position: type: integer format: uint64 x-go-name: LineNum pull_request_review_id: type: integer format: int64 x-go-name: ReviewID pull_request_url: type: string x-go-name: HTMLPullURL resolver: $ref: '#/components/schemas/User' updated_at: type: string format: date-time x-go-name: Updated user: $ref: '#/components/schemas/User' x-go-package: code.gitea.io/gitea/modules/structs PullReviewRequestOptions: description: PullReviewRequestOptions are options to add or remove pull request review requests type: object properties: reviewers: type: array items: type: string x-go-name: Reviewers team_reviewers: type: array items: type: string x-go-name: TeamReviewers x-go-package: code.gitea.io/gitea/modules/structs PushMirror: description: PushMirror represents information of a push mirror type: object properties: created: type: string format: date-time x-go-name: CreatedUnix interval: description: The sync interval for automatic updates type: string x-go-name: Interval last_error: description: The last error message encountered during sync type: string x-go-name: LastError last_update: type: string format: date-time x-go-name: LastUpdateUnix remote_address: description: The remote repository URL being mirrored to type: string x-go-name: RemoteAddress remote_name: description: The name of the remote in the git configuration type: string x-go-name: RemoteName repo_name: description: The name of the source repository type: string x-go-name: RepoName sync_on_commit: description: Whether to sync on every commit type: boolean x-go-name: SyncOnCommit x-go-package: code.gitea.io/gitea/modules/structs Reaction: description: Reaction contain one reaction type: object properties: content: description: The reaction content (e.g., emoji or reaction type) type: string x-go-name: Reaction created_at: type: string format: date-time x-go-name: Created user: $ref: '#/components/schemas/User' x-go-package: code.gitea.io/gitea/modules/structs Reference: type: object title: Reference represents a Git reference. properties: object: $ref: '#/components/schemas/GitObject' ref: description: The name of the Git reference (e.g., refs/heads/main) type: string x-go-name: Ref url: description: The URL to access this Git reference type: string x-go-name: URL x-go-package: code.gitea.io/gitea/modules/structs Release: description: Release represents a repository release type: object properties: assets: description: The files attached to the release type: array items: $ref: '#/components/schemas/Attachment' x-go-name: Attachments author: $ref: '#/components/schemas/User' body: description: The release notes or description type: string x-go-name: Note created_at: type: string format: date-time x-go-name: CreatedAt draft: description: Whether the release is a draft type: boolean x-go-name: IsDraft html_url: description: The HTML URL to view the release type: string x-go-name: HTMLURL id: description: The unique identifier of the release type: integer format: int64 x-go-name: ID name: description: The display title of the release type: string x-go-name: Title prerelease: description: Whether the release is a prerelease type: boolean x-go-name: IsPrerelease published_at: type: string format: date-time x-go-name: PublishedAt tag_name: description: The name of the git tag associated with the release type: string x-go-name: TagName tarball_url: description: The URL to download the tarball archive type: string x-go-name: TarURL target_commitish: description: The target commitish for the release type: string x-go-name: Target upload_url: description: The URL template for uploading release assets type: string x-go-name: UploadURL url: description: The API URL of the release type: string x-go-name: URL zipball_url: description: The URL to download the zip archive type: string x-go-name: ZipURL x-go-package: code.gitea.io/gitea/modules/structs RenameBranchRepoOption: description: RenameBranchRepoOption options when renaming a branch in a repository type: object required: - name properties: name: description: New branch name type: string uniqueItems: true x-go-name: Name x-go-package: code.gitea.io/gitea/modules/structs RenameOrgOption: description: RenameOrgOption options when renaming an organization type: object required: - new_name properties: new_name: description: New username for this org. This name cannot be in use yet by any other user. type: string uniqueItems: true x-go-name: NewName x-go-package: code.gitea.io/gitea/modules/structs RenameUserOption: description: RenameUserOption options when renaming a user type: object required: - new_username properties: new_username: description: New username for this user. This name cannot be in use yet by any other user. type: string uniqueItems: true x-go-name: NewName x-go-package: code.gitea.io/gitea/modules/structs RepoCollaboratorPermission: description: RepoCollaboratorPermission to get repository permission for a collaborator type: object properties: permission: description: Permission level of the collaborator type: string x-go-name: Permission role_name: description: RoleName is the name of the permission role type: string x-go-name: RoleName user: $ref: '#/components/schemas/User' x-go-package: code.gitea.io/gitea/modules/structs RepoCommit: type: object title: RepoCommit contains information of a commit in the context of a repository. properties: author: $ref: '#/components/schemas/CommitUser' committer: $ref: '#/components/schemas/CommitUser' message: description: Message is the commit message type: string x-go-name: Message tree: $ref: '#/components/schemas/CommitMeta' url: description: URL is the API URL for the commit type: string x-go-name: URL verification: $ref: '#/components/schemas/PayloadCommitVerification' x-go-package: code.gitea.io/gitea/modules/structs RepoTopicOptions: description: RepoTopicOptions a collection of repo topic names type: object properties: topics: description: list of topic names type: array items: type: string x-go-name: Topics x-go-package: code.gitea.io/gitea/modules/structs RepoTransfer: description: RepoTransfer represents a pending repo transfer type: object properties: doer: $ref: '#/components/schemas/User' recipient: $ref: '#/components/schemas/User' teams: type: array items: $ref: '#/components/schemas/Team' x-go-name: Teams x-go-package: code.gitea.io/gitea/modules/structs Repository: description: Repository represents a repository type: object properties: allow_fast_forward_only_merge: type: boolean x-go-name: AllowFastForwardOnly allow_manual_merge: type: boolean x-go-name: AllowManualMerge allow_merge_commits: type: boolean x-go-name: AllowMerge allow_rebase: type: boolean x-go-name: AllowRebase allow_rebase_explicit: type: boolean x-go-name: AllowRebaseMerge allow_rebase_update: type: boolean x-go-name: AllowRebaseUpdate allow_squash_merge: type: boolean x-go-name: AllowSquash archived: type: boolean x-go-name: Archived archived_at: type: string format: date-time x-go-name: ArchivedAt autodetect_manual_merge: type: boolean x-go-name: AutodetectManualMerge avatar_url: type: string x-go-name: AvatarURL branch_count: type: integer format: int64 x-go-name: BranchCount clone_url: type: string x-go-name: CloneURL created_at: type: string format: date-time x-go-name: Created default_allow_maintainer_edit: type: boolean x-go-name: DefaultAllowMaintainerEdit default_branch: type: string x-go-name: DefaultBranch default_delete_branch_after_merge: type: boolean x-go-name: DefaultDeleteBranchAfterMerge default_merge_style: type: string x-go-name: DefaultMergeStyle default_target_branch: type: string x-go-name: DefaultTargetBranch description: type: string x-go-name: Description empty: type: boolean x-go-name: Empty external_tracker: $ref: '#/components/schemas/ExternalTracker' external_wiki: $ref: '#/components/schemas/ExternalWiki' fork: type: boolean x-go-name: Fork forks_count: type: integer format: int64 x-go-name: Forks full_name: type: string x-go-name: FullName has_actions: type: boolean x-go-name: HasActions has_code: type: boolean x-go-name: HasCode has_issues: type: boolean x-go-name: HasIssues has_packages: type: boolean x-go-name: HasPackages has_projects: type: boolean x-go-name: HasProjects has_pull_requests: type: boolean x-go-name: HasPullRequests has_releases: type: boolean x-go-name: HasReleases has_wiki: type: boolean x-go-name: HasWiki html_url: type: string x-go-name: HTMLURL id: type: integer format: int64 x-go-name: ID ignore_whitespace_conflicts: type: boolean x-go-name: IgnoreWhitespaceConflicts internal: type: boolean x-go-name: Internal internal_tracker: $ref: '#/components/schemas/InternalTracker' language: type: string x-go-name: Language languages_url: type: string x-go-name: LanguagesURL licenses: type: array items: type: string x-go-name: Licenses link: type: string x-go-name: Link mirror: type: boolean x-go-name: Mirror mirror_interval: type: string x-go-name: MirrorInterval mirror_updated: type: string format: date-time x-go-name: MirrorUpdated name: type: string x-go-name: Name object_format_name: description: ObjectFormatName of the underlying git repository type: string enum: - sha1 - sha256 x-go-name: ObjectFormatName open_issues_count: type: integer format: int64 x-go-name: OpenIssues open_pr_counter: type: integer format: int64 x-go-name: OpenPulls original_url: type: string x-go-name: OriginalURL owner: $ref: '#/components/schemas/User' parent: $ref: '#/components/schemas/Repository' permissions: $ref: '#/components/schemas/Permission' private: type: boolean x-go-name: Private projects_mode: type: string x-go-name: ProjectsMode release_counter: type: integer format: int64 x-go-name: Releases repo_transfer: $ref: '#/components/schemas/RepoTransfer' size: type: integer format: int64 x-go-name: Size ssh_url: type: string x-go-name: SSHURL stars_count: type: integer format: int64 x-go-name: Stars template: type: boolean x-go-name: Template topics: type: array items: type: string x-go-name: Topics updated_at: type: string format: date-time x-go-name: Updated url: type: string x-go-name: URL watchers_count: type: integer format: int64 x-go-name: Watchers website: type: string x-go-name: Website x-go-package: code.gitea.io/gitea/modules/structs RepositoryMeta: description: RepositoryMeta basic repository information type: object properties: full_name: type: string x-go-name: FullName id: type: integer format: int64 x-go-name: ID name: type: string x-go-name: Name owner: type: string x-go-name: Owner x-go-package: code.gitea.io/gitea/modules/structs RunDetails: description: RunDetails returns workflow_dispatch runid and url type: object properties: html_url: type: string x-go-name: HTMLURL run_url: type: string x-go-name: RunURL workflow_run_id: type: integer format: int64 x-go-name: WorkflowRunID x-go-package: code.gitea.io/gitea/modules/structs SearchResults: description: SearchResults results of a successful search type: object properties: data: description: Data contains the repository search results type: array items: $ref: '#/components/schemas/Repository' x-go-name: Data ok: description: OK indicates if the search was successful type: boolean x-go-name: OK x-go-package: code.gitea.io/gitea/modules/structs Secret: description: Secret represents a secret type: object properties: created_at: type: string format: date-time x-go-name: Created description: description: the secret's description type: string x-go-name: Description name: description: the secret's name type: string x-go-name: Name x-go-package: code.gitea.io/gitea/modules/structs ServerVersion: description: ServerVersion wraps the version of the server type: object properties: version: description: Version is the server version string type: string x-go-name: Version x-go-package: code.gitea.io/gitea/modules/structs StopWatch: description: StopWatch represent a running stopwatch type: object properties: created: type: string format: date-time x-go-name: Created duration: description: Duration is a human-readable duration string type: string x-go-name: Duration issue_index: description: IssueIndex is the index number of the associated issue type: integer format: int64 x-go-name: IssueIndex issue_title: description: IssueTitle is the title of the associated issue type: string x-go-name: IssueTitle repo_name: description: RepoName is the name of the repository type: string x-go-name: RepoName repo_owner_name: description: RepoOwnerName is the name of the repository owner type: string x-go-name: RepoOwnerName seconds: description: Seconds is the total elapsed time in seconds type: integer format: int64 x-go-name: Seconds x-go-package: code.gitea.io/gitea/modules/structs SubmitPullReviewOptions: description: SubmitPullReviewOptions are options to submit a pending pull request review type: object properties: body: type: string x-go-name: Body event: type: string enum: - APPROVED - PENDING - COMMENT - REQUEST_CHANGES - REQUEST_REVIEW x-go-enum-desc: 'APPROVED ReviewStateApproved ReviewStateApproved pr is approved PENDING ReviewStatePending ReviewStatePending pr state is pending COMMENT ReviewStateComment ReviewStateComment is a comment review REQUEST_CHANGES ReviewStateRequestChanges ReviewStateRequestChanges changes for pr are requested REQUEST_REVIEW ReviewStateRequestReview ReviewStateRequestReview review is requested from user' x-go-name: Event x-go-package: code.gitea.io/gitea/modules/structs Tag: description: Tag represents a repository tag type: object properties: commit: $ref: '#/components/schemas/CommitMeta' id: description: The ID (SHA) of the tag type: string x-go-name: ID message: description: The message associated with the tag type: string x-go-name: Message name: description: The name of the tag type: string x-go-name: Name tarball_url: description: The URL to download the tarball archive type: string x-go-name: TarballURL zipball_url: description: The URL to download the zipball archive type: string x-go-name: ZipballURL x-go-package: code.gitea.io/gitea/modules/structs TagProtection: description: TagProtection represents a tag protection type: object properties: created_at: type: string format: date-time x-go-name: Created id: description: The unique identifier of the tag protection type: integer format: int64 x-go-name: ID name_pattern: description: The pattern to match tag names for protection type: string x-go-name: NamePattern updated_at: type: string format: date-time x-go-name: Updated whitelist_teams: description: List of team names allowed to create/delete protected tags type: array items: type: string x-go-name: WhitelistTeams whitelist_usernames: description: List of usernames allowed to create/delete protected tags type: array items: type: string x-go-name: WhitelistUsernames x-go-package: code.gitea.io/gitea/modules/structs Team: description: Team represents a team in an organization type: object properties: can_create_org_repo: description: Whether the team can create repositories in the organization type: boolean x-go-name: CanCreateOrgRepo description: description: The description of the team type: string x-go-name: Description id: description: The unique identifier of the team type: integer format: int64 x-go-name: ID includes_all_repositories: description: Whether the team has access to all repositories in the organization type: boolean x-go-name: IncludesAllRepositories name: description: The name of the team type: string x-go-name: Name organization: $ref: '#/components/schemas/Organization' permission: type: string enum: - none - read - write - admin - owner x-go-name: Permission units: type: array items: type: string x-go-name: Units example: - repo.code - repo.issues - repo.ext_issues - repo.wiki - repo.pulls - repo.releases - repo.projects - repo.ext_wiki units_map: type: object additionalProperties: type: string x-go-name: UnitsMap example: repo.code: read repo.ext_issues: none repo.ext_wiki: none repo.issues: write repo.projects: none repo.pulls: owner repo.releases: none repo.wiki: admin x-go-package: code.gitea.io/gitea/modules/structs TimeStamp: description: TimeStamp defines a timestamp type: integer format: int64 x-go-package: code.gitea.io/gitea/modules/timeutil TimelineComment: description: TimelineComment represents a timeline comment (comment of any type) on a commit or issue type: object properties: assignee: $ref: '#/components/schemas/User' assignee_team: $ref: '#/components/schemas/Team' body: description: Body contains the timeline event content type: string x-go-name: Body created_at: type: string format: date-time x-go-name: Created dependent_issue: $ref: '#/components/schemas/Issue' html_url: description: HTMLURL is the web URL for viewing the comment type: string x-go-name: HTMLURL id: description: ID is the unique identifier for the timeline comment type: integer format: int64 x-go-name: ID issue_url: description: IssueURL is the API URL for the issue type: string x-go-name: IssueURL label: $ref: '#/components/schemas/Label' milestone: $ref: '#/components/schemas/Milestone' new_ref: type: string x-go-name: NewRef new_title: type: string x-go-name: NewTitle old_milestone: $ref: '#/components/schemas/Milestone' old_project_id: type: integer format: int64 x-go-name: OldProjectID old_ref: type: string x-go-name: OldRef old_title: type: string x-go-name: OldTitle project_id: type: integer format: int64 x-go-name: ProjectID pull_request_url: description: PRURL is the API URL for the pull request (if applicable) type: string x-go-name: PRURL ref_action: type: string x-go-name: RefAction ref_comment: $ref: '#/components/schemas/Comment' ref_commit_sha: description: commit SHA where issue/PR was referenced type: string x-go-name: RefCommitSHA ref_issue: $ref: '#/components/schemas/Issue' removed_assignee: description: whether the assignees were removed or added type: boolean x-go-name: RemovedAssignee resolve_doer: $ref: '#/components/schemas/User' review_id: type: integer format: int64 x-go-name: ReviewID tracked_time: $ref: '#/components/schemas/TrackedTime' type: description: Type indicates the type of timeline event type: string x-go-name: Type updated_at: type: string format: date-time x-go-name: Updated user: $ref: '#/components/schemas/User' x-go-package: code.gitea.io/gitea/modules/structs TopicName: description: TopicName a list of repo topic names type: object properties: topics: description: List of topic names type: array items: type: string x-go-name: TopicNames x-go-package: code.gitea.io/gitea/modules/structs TopicResponse: description: TopicResponse for returning topics type: object properties: created: description: The date and time when the topic was created type: string format: date-time x-go-name: Created id: description: The unique identifier of the topic type: integer format: int64 x-go-name: ID repo_count: description: The number of repositories using this topic type: integer format: int64 x-go-name: RepoCount topic_name: description: The name of the topic type: string x-go-name: Name updated: description: The date and time when the topic was last updated type: string format: date-time x-go-name: Updated x-go-package: code.gitea.io/gitea/modules/structs TrackedTime: description: TrackedTime worked time for an issue / pr type: object properties: created: type: string format: date-time x-go-name: Created id: description: ID is the unique identifier for the tracked time entry type: integer format: int64 x-go-name: ID issue: $ref: '#/components/schemas/Issue' issue_id: description: deprecated (only for backwards compatibility) type: integer format: int64 x-go-name: IssueID time: description: Time in seconds type: integer format: int64 x-go-name: Time user_id: description: deprecated (only for backwards compatibility) type: integer format: int64 x-go-name: UserID user_name: description: username of the user type: string x-go-name: UserName x-go-package: code.gitea.io/gitea/modules/structs TransferRepoOption: description: TransferRepoOption options when transfer a repository's ownership type: object required: - new_owner properties: new_owner: type: string x-go-name: NewOwner team_ids: description: ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories. type: array items: type: integer format: int64 x-go-name: TeamIDs x-go-package: code.gitea.io/gitea/modules/structs UpdateBranchProtectionPriories: description: UpdateBranchProtectionPriories a list to update the branch protection rule priorities type: object properties: ids: type: array items: type: integer format: int64 x-go-name: IDs x-go-package: code.gitea.io/gitea/modules/structs UpdateBranchRepoOption: description: UpdateBranchRepoOption options when updating a branch reference in a repository type: object required: - new_commit_id properties: force: description: Force update even if the change is not a fast-forward type: boolean x-go-name: Force new_commit_id: description: New commit SHA (or any ref) the branch should point to type: string x-go-name: NewCommitID old_commit_id: description: Expected old commit SHA of the branch; if provided it must match the current tip type: string x-go-name: OldCommitID x-go-package: code.gitea.io/gitea/modules/structs UpdateFileOptions: description: 'UpdateFileOptions options for updating or creating a file Note: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)' type: object required: - content properties: author: $ref: '#/components/schemas/Identity' branch: description: branch (optional) is the base branch for the changes. If not supplied, the default branch is used type: string x-go-name: BranchName committer: $ref: '#/components/schemas/Identity' content: description: content must be base64 encoded type: string x-go-name: ContentBase64 dates: $ref: '#/components/schemas/CommitDateOptions' force_push: description: force_push (optional) will do a force-push if the new branch already exists type: boolean x-go-name: ForcePush from_path: description: from_path (optional) is the path of the original file which will be moved/renamed to the path in the URL type: string x-go-name: FromPath message: description: message (optional) is the commit message of the changes. If not supplied, a default message will be used type: string x-go-name: Message new_branch: description: new_branch (optional) will make a new branch from base branch for the changes. If not supplied, the changes will be committed to the base branch type: string x-go-name: NewBranchName sha: description: the blob ID (SHA) for the file that already exists to update, or leave it empty to create a new file type: string x-go-name: SHA signoff: description: Add a Signed-off-by trailer by the committer at the end of the commit log message. type: boolean x-go-name: Signoff x-go-package: code.gitea.io/gitea/modules/structs UpdateRepoAvatarOption: description: UpdateRepoAvatarUserOption options when updating the repo avatar type: object properties: image: description: image must be base64 encoded type: string x-go-name: Image x-go-package: code.gitea.io/gitea/modules/structs UpdateUserAvatarOption: description: UpdateUserAvatarUserOption options when updating the user avatar type: object properties: image: description: image must be base64 encoded type: string x-go-name: Image x-go-package: code.gitea.io/gitea/modules/structs UpdateVariableOption: description: UpdateVariableOption the option when updating variable type: object required: - value properties: description: description: Description of the variable to update type: string x-go-name: Description name: description: New name for the variable. If the field is empty, the variable name won't be updated. type: string x-go-name: Name value: description: Value of the variable to update type: string x-go-name: Value x-go-package: code.gitea.io/gitea/modules/structs User: description: User represents a user type: object properties: active: description: Is user active type: boolean x-go-name: IsActive avatar_url: description: URL to the user's avatar type: string x-go-name: AvatarURL created: type: string format: date-time x-go-name: Created description: description: the user's description type: string x-go-name: Description email: type: string format: email x-go-name: Email followers_count: description: user counts type: integer format: int64 x-go-name: Followers following_count: type: integer format: int64 x-go-name: Following full_name: description: the user's full name type: string x-go-name: FullName html_url: description: URL to the user's gitea page type: string x-go-name: HTMLURL id: description: the user's id type: integer format: int64 x-go-name: ID is_admin: description: Is the user an administrator type: boolean x-go-name: IsAdmin language: description: User locale type: string x-go-name: Language last_login: type: string format: date-time x-go-name: LastLogin location: description: the user's location type: string x-go-name: Location login: description: login of the user, same as `username` type: string x-go-name: UserName login_name: description: identifier of the user, provided by the external authenticator (if configured) type: string default: empty x-go-name: LoginName prohibit_login: description: Is user login prohibited type: boolean x-go-name: ProhibitLogin restricted: description: Is user restricted type: boolean x-go-name: Restricted source_id: description: The ID of the user's Authentication Source type: integer format: int64 x-go-name: SourceID starred_repos_count: type: integer format: int64 x-go-name: StarredRepos visibility: description: 'User visibility level option: public, limited, private' type: string x-go-name: Visibility website: description: the user's website type: string x-go-name: Website x-go-package: code.gitea.io/gitea/modules/structs UserBadgeOption: description: UserBadgeOption options for link between users and badges type: object properties: badge_slugs: type: array items: type: string x-go-name: BadgeSlugs example: - badge1 - badge2 x-go-package: code.gitea.io/gitea/modules/structs UserHeatmapData: description: UserHeatmapData represents the data needed to create a heatmap type: object properties: contributions: type: integer format: int64 x-go-name: Contributions timestamp: $ref: '#/components/schemas/TimeStamp' x-go-package: code.gitea.io/gitea/models/activities UserSettings: description: UserSettings represents user settings type: object properties: description: type: string x-go-name: Description diff_view_style: type: string x-go-name: DiffViewStyle full_name: type: string x-go-name: FullName hide_activity: type: boolean x-go-name: HideActivity hide_email: description: Privacy type: boolean x-go-name: HideEmail language: type: string x-go-name: Language location: type: string x-go-name: Location theme: type: string x-go-name: Theme website: type: string x-go-name: Website x-go-package: code.gitea.io/gitea/modules/structs UserSettingsOptions: description: UserSettingsOptions represents options to change user settings type: object properties: description: type: string x-go-name: Description diff_view_style: type: string x-go-name: DiffViewStyle full_name: type: string x-go-name: FullName hide_activity: type: boolean x-go-name: HideActivity hide_email: description: Privacy type: boolean x-go-name: HideEmail language: type: string x-go-name: Language location: type: string x-go-name: Location theme: type: string x-go-name: Theme website: type: string x-go-name: Website x-go-package: code.gitea.io/gitea/modules/structs WatchInfo: description: WatchInfo represents an API watch status of one repository type: object properties: created_at: description: The timestamp when the watch status was created type: string format: date-time x-go-name: CreatedAt ignored: description: Whether notifications for the repository are ignored type: boolean x-go-name: Ignored reason: description: The reason for the current watch status x-go-name: Reason repository_url: description: The URL of the repository being watched type: string x-go-name: RepositoryURL subscribed: description: Whether the repository is being watched for notifications type: boolean x-go-name: Subscribed url: description: The URL for managing the watch status type: string x-go-name: URL x-go-package: code.gitea.io/gitea/modules/structs WikiCommit: description: WikiCommit page commit/revision type: object properties: author: $ref: '#/components/schemas/CommitUser' commiter: $ref: '#/components/schemas/CommitUser' message: description: The commit message type: string x-go-name: Message sha: description: The commit SHA hash type: string x-go-name: ID x-go-package: code.gitea.io/gitea/modules/structs WikiCommitList: description: WikiCommitList commit/revision list type: object properties: commits: description: The list of wiki commits type: array items: $ref: '#/components/schemas/WikiCommit' x-go-name: WikiCommits count: description: The total count of commits type: integer format: int64 x-go-name: Count x-go-package: code.gitea.io/gitea/modules/structs WikiPage: description: WikiPage a wiki page type: object properties: commit_count: description: The number of commits that modified this page type: integer format: int64 x-go-name: CommitCount content_base64: description: Page content, base64 encoded type: string x-go-name: ContentBase64 footer: description: The footer content for the wiki page type: string x-go-name: Footer html_url: description: The HTML URL to view the wiki page type: string x-go-name: HTMLURL last_commit: $ref: '#/components/schemas/WikiCommit' sidebar: description: The sidebar content for the wiki page type: string x-go-name: Sidebar sub_url: description: The sub URL path for the wiki page type: string x-go-name: SubURL title: description: The title of the wiki page type: string x-go-name: Title x-go-package: code.gitea.io/gitea/modules/structs WikiPageMetaData: description: WikiPageMetaData wiki page meta information type: object properties: html_url: description: The HTML URL to view the wiki page type: string x-go-name: HTMLURL last_commit: $ref: '#/components/schemas/WikiCommit' sub_url: description: The sub URL path for the wiki page type: string x-go-name: SubURL title: description: The title of the wiki page type: string x-go-name: Title x-go-package: code.gitea.io/gitea/modules/structs securitySchemes: AccessToken: type: apiKey in: query name: access_token AuthorizationHeaderToken: type: apiKey in: header name: Authorization BasicAuth: type: http scheme: basic SudoHeader: type: apiKey in: header name: Sudo SudoParam: type: apiKey in: query name: sudo TOTPHeader: type: apiKey in: header name: X-GITEA-OTP Token: type: apiKey in: query name: token tags: [] security: - BasicAuth: [] - Token: [] - AccessToken: [] - AuthorizationHeaderToken: [] - SudoParam: [] - SudoHeader: [] - TOTPHeader: []