swagger: '2.0' info: description: This documentation describes the Gitea API. title: Gitea admin organization API license: name: MIT url: http://opensource.org/licenses/MIT version: 1.27.0+dev-89-gf52b6f3315 basePath: /api/v1 schemes: - https - http consumes: - application/json produces: - application/json security: - BasicAuth: [] - Token: [] - AccessToken: [] - AuthorizationHeaderToken: [] - SudoParam: [] - SudoHeader: [] - TOTPHeader: [] tags: - name: organization paths: /org/{org}/repos: post: consumes: - application/json produces: - application/json tags: - organization summary: Create a repository in an organization operationId: createOrgRepoDeprecated deprecated: true parameters: - type: string description: name of organization name: org in: path required: true - name: body in: body schema: $ref: '#/definitions/CreateRepoOption' responses: '201': $ref: '#/responses/Repository' '403': $ref: '#/responses/forbidden' '404': $ref: '#/responses/notFound' '422': $ref: '#/responses/validationError' /orgs: get: produces: - application/json tags: - organization summary: Get list of organizations operationId: orgGetAll parameters: - type: integer description: page number of results to return (1-based) name: page in: query - type: integer description: page size of results name: limit in: query responses: '200': $ref: '#/responses/OrganizationList' post: consumes: - application/json produces: - application/json tags: - organization summary: Create an organization operationId: orgCreate parameters: - name: organization in: body required: true schema: $ref: '#/definitions/CreateOrgOption' responses: '201': $ref: '#/responses/Organization' '403': $ref: '#/responses/forbidden' '422': $ref: '#/responses/validationError' /orgs/{org}: get: produces: - application/json tags: - organization summary: Get an organization operationId: orgGet parameters: - type: string description: name of the organization to get name: org in: path required: true responses: '200': $ref: '#/responses/Organization' '404': $ref: '#/responses/notFound' delete: produces: - application/json tags: - organization summary: Delete an organization operationId: orgDelete parameters: - type: string description: organization that is to be deleted name: org in: path required: true responses: '204': $ref: '#/responses/empty' '404': $ref: '#/responses/notFound' patch: consumes: - application/json produces: - application/json tags: - organization summary: Edit an organization operationId: orgEdit parameters: - type: string description: name of the organization to edit name: org in: path required: true - name: body in: body required: true schema: $ref: '#/definitions/EditOrgOption' responses: '200': $ref: '#/responses/Organization' '404': $ref: '#/responses/notFound' /orgs/{org}/actions/jobs: get: produces: - application/json tags: - organization summary: Get org-level workflow jobs operationId: getOrgWorkflowJobs parameters: - type: string description: name of the organization name: org in: path required: true - type: string description: workflow status (pending, queued, in_progress, failure, success, skipped) name: status in: query - type: integer description: page number of results to return (1-based) name: page in: query - type: integer description: page size of results name: limit in: query responses: '200': $ref: '#/responses/WorkflowJobsList' '400': $ref: '#/responses/error' '404': $ref: '#/responses/notFound' /orgs/{org}/actions/runners: get: produces: - application/json tags: - organization summary: Get org-level runners operationId: getOrgRunners parameters: - type: string description: name of the organization name: org in: path required: true - type: boolean description: filter by disabled status (true or false) name: disabled in: query responses: '200': $ref: '#/responses/RunnerList' '400': $ref: '#/responses/error' '404': $ref: '#/responses/notFound' /orgs/{org}/actions/runners/registration-token: post: produces: - application/json tags: - organization summary: Get an organization's actions runner registration token operationId: orgCreateRunnerRegistrationToken parameters: - type: string description: name of the organization name: org in: path required: true responses: '200': $ref: '#/responses/RegistrationToken' /orgs/{org}/actions/runners/{runner_id}: get: produces: - application/json tags: - organization summary: Get an org-level runner operationId: getOrgRunner parameters: - type: string description: name of the organization name: org in: path required: true - type: string description: id of the runner name: runner_id in: path required: true responses: '200': $ref: '#/responses/Runner' '400': $ref: '#/responses/error' '404': $ref: '#/responses/notFound' delete: produces: - application/json tags: - organization summary: Delete an org-level runner operationId: deleteOrgRunner parameters: - type: string description: name of the organization name: org in: path required: true - type: string description: id of the runner name: runner_id in: path required: true responses: '204': description: runner has been deleted '400': $ref: '#/responses/error' '404': $ref: '#/responses/notFound' patch: consumes: - application/json produces: - application/json tags: - organization summary: Update an org-level runner operationId: updateOrgRunner parameters: - type: string description: name of the organization name: org in: path required: true - type: string description: id of the runner name: runner_id in: path required: true - name: body in: body schema: $ref: '#/definitions/EditActionRunnerOption' responses: '200': $ref: '#/responses/Runner' '400': $ref: '#/responses/error' '404': $ref: '#/responses/notFound' '422': $ref: '#/responses/validationError' /orgs/{org}/actions/runs: get: produces: - application/json tags: - organization summary: Get org-level workflow runs operationId: getOrgWorkflowRuns parameters: - type: string description: name of the organization name: org in: path required: true - type: string description: workflow event name name: event in: query - type: string description: workflow branch name: branch in: query - type: string description: workflow status (pending, queued, in_progress, failure, success, skipped) name: status in: query - type: string description: triggered by user name: actor in: query - type: string description: triggering sha of the workflow run name: head_sha in: query - type: integer description: page number of results to return (1-based) name: page in: query - type: integer description: page size of results name: limit in: query responses: '200': $ref: '#/responses/WorkflowRunsList' '400': $ref: '#/responses/error' '404': $ref: '#/responses/notFound' /orgs/{org}/actions/secrets: get: produces: - application/json tags: - organization summary: List an organization's actions secrets operationId: orgListActionsSecrets parameters: - type: string description: name of the organization name: org in: path required: true - type: integer description: page number of results to return (1-based) name: page in: query - type: integer description: page size of results name: limit in: query responses: '200': $ref: '#/responses/SecretList' '404': $ref: '#/responses/notFound' /orgs/{org}/actions/secrets/{secretname}: put: consumes: - application/json produces: - application/json tags: - organization summary: Create or Update a secret value in an organization operationId: updateOrgSecret parameters: - type: string description: name of organization name: org in: path required: true - type: string description: name of the secret name: secretname in: path required: true - name: body in: body schema: $ref: '#/definitions/CreateOrUpdateSecretOption' responses: '201': description: response when creating a secret '204': description: response when updating a secret '400': $ref: '#/responses/error' '404': $ref: '#/responses/notFound' delete: consumes: - application/json produces: - application/json tags: - organization summary: Delete a secret in an organization operationId: deleteOrgSecret parameters: - type: string description: name of organization name: org in: path required: true - type: string description: name of the secret name: secretname in: path required: true responses: '204': description: delete one secret of the organization '400': $ref: '#/responses/error' '404': $ref: '#/responses/notFound' /orgs/{org}/actions/variables: get: produces: - application/json tags: - organization summary: Get an org-level variables list operationId: getOrgVariablesList parameters: - type: string description: name of the organization name: org in: path required: true - type: integer description: page number of results to return (1-based) name: page in: query - type: integer description: page size of results name: limit in: query responses: '200': $ref: '#/responses/VariableList' '400': $ref: '#/responses/error' '404': $ref: '#/responses/notFound' /orgs/{org}/actions/variables/{variablename}: get: produces: - application/json tags: - organization summary: Get an org-level variable operationId: getOrgVariable parameters: - type: string description: name of the organization name: org in: path required: true - type: string description: name of the variable name: variablename in: path required: true responses: '200': $ref: '#/responses/ActionVariable' '400': $ref: '#/responses/error' '404': $ref: '#/responses/notFound' put: consumes: - application/json produces: - application/json tags: - organization summary: Update an org-level variable operationId: updateOrgVariable parameters: - type: string description: name of the organization name: org in: path required: true - type: string description: name of the variable name: variablename in: path required: true - name: body in: body schema: $ref: '#/definitions/UpdateVariableOption' responses: '201': description: response when updating an org-level variable '204': description: response when updating an org-level variable '400': $ref: '#/responses/error' '404': $ref: '#/responses/notFound' post: consumes: - application/json produces: - application/json tags: - organization summary: Create an org-level variable operationId: createOrgVariable parameters: - type: string description: name of the organization name: org in: path required: true - type: string description: name of the variable name: variablename in: path required: true - name: body in: body schema: $ref: '#/definitions/CreateVariableOption' responses: '201': description: successfully created the org-level variable '400': $ref: '#/responses/error' '409': description: variable name already exists. '500': $ref: '#/responses/error' delete: produces: - application/json tags: - organization summary: Delete an org-level variable operationId: deleteOrgVariable parameters: - type: string description: name of the organization name: org in: path required: true - type: string description: name of the variable name: variablename in: path required: true responses: '200': $ref: '#/responses/ActionVariable' '201': description: response when deleting a variable '204': description: response when deleting a variable '400': $ref: '#/responses/error' '404': $ref: '#/responses/notFound' /orgs/{org}/activities/feeds: get: produces: - application/json tags: - organization summary: List an organization's activity feeds operationId: orgListActivityFeeds parameters: - type: string description: name of the org name: org in: path required: true - type: string format: date description: the date of the activities to be found name: date in: query - type: integer description: page number of results to return (1-based) name: page in: query - type: integer description: page size of results name: limit in: query responses: '200': $ref: '#/responses/ActivityFeedsList' '404': $ref: '#/responses/notFound' /orgs/{org}/avatar: post: produces: - application/json tags: - organization summary: Update Avatar operationId: orgUpdateAvatar parameters: - type: string description: name of the organization name: org in: path required: true - name: body in: body schema: $ref: '#/definitions/UpdateUserAvatarOption' responses: '204': $ref: '#/responses/empty' '404': $ref: '#/responses/notFound' delete: produces: - application/json tags: - organization summary: Delete Avatar operationId: orgDeleteAvatar parameters: - type: string description: name of the organization name: org in: path required: true responses: '204': $ref: '#/responses/empty' '404': $ref: '#/responses/notFound' /orgs/{org}/blocks: get: produces: - application/json tags: - organization summary: List users blocked by the organization operationId: organizationListBlocks parameters: - type: string description: name of the organization name: org in: path required: true - type: integer description: page number of results to return (1-based) name: page in: query - type: integer description: page size of results name: limit in: query responses: '200': $ref: '#/responses/UserList' /orgs/{org}/blocks/{username}: get: tags: - organization summary: Check if a user is blocked by the organization operationId: organizationCheckUserBlock parameters: - type: string description: name of the organization name: org in: path required: true - type: string description: username of the user to check name: username in: path required: true responses: '204': $ref: '#/responses/empty' '404': $ref: '#/responses/notFound' put: tags: - organization summary: Block a user operationId: organizationBlockUser parameters: - type: string description: name of the organization name: org in: path required: true - type: string description: username of the user to block name: username in: path required: true - type: string description: optional note for the block name: note in: query responses: '204': $ref: '#/responses/empty' '404': $ref: '#/responses/notFound' '422': $ref: '#/responses/validationError' delete: tags: - organization summary: Unblock a user operationId: organizationUnblockUser parameters: - type: string description: name of the organization name: org in: path required: true - type: string description: username of the user to unblock name: username in: path required: true responses: '204': $ref: '#/responses/empty' '404': $ref: '#/responses/notFound' '422': $ref: '#/responses/validationError' /orgs/{org}/hooks: get: produces: - application/json tags: - organization summary: List an organization's webhooks operationId: orgListHooks parameters: - type: string description: name of the organization name: org in: path required: true - type: integer description: page number of results to return (1-based) name: page in: query - type: integer description: page size of results name: limit in: query responses: '200': $ref: '#/responses/HookList' '404': $ref: '#/responses/notFound' post: consumes: - application/json produces: - application/json tags: - organization summary: Create a hook operationId: orgCreateHook parameters: - type: string description: name of the organization name: org in: path required: true - name: body in: body required: true schema: $ref: '#/definitions/CreateHookOption' responses: '201': $ref: '#/responses/Hook' '404': $ref: '#/responses/notFound' /orgs/{org}/hooks/{id}: get: produces: - application/json tags: - organization summary: Get a hook operationId: orgGetHook parameters: - type: string description: name of the organization name: org in: path required: true - type: integer format: int64 description: id of the hook to get name: id in: path required: true responses: '200': $ref: '#/responses/Hook' '404': $ref: '#/responses/notFound' delete: produces: - application/json tags: - organization summary: Delete a hook operationId: orgDeleteHook parameters: - type: string description: name of the organization name: org in: path required: true - type: integer format: int64 description: id of the hook to delete name: id in: path required: true responses: '204': $ref: '#/responses/empty' '404': $ref: '#/responses/notFound' patch: consumes: - application/json produces: - application/json tags: - organization summary: Update a hook operationId: orgEditHook parameters: - type: string description: name of the organization name: org in: path required: true - type: integer format: int64 description: id of the hook to update name: id in: path required: true - name: body in: body schema: $ref: '#/definitions/EditHookOption' responses: '200': $ref: '#/responses/Hook' '404': $ref: '#/responses/notFound' /orgs/{org}/labels: get: produces: - application/json tags: - organization summary: List an organization's labels operationId: orgListLabels parameters: - type: string description: name of the organization name: org in: path required: true - type: integer description: page number of results to return (1-based) name: page in: query - type: integer description: page size of results name: limit in: query responses: '200': $ref: '#/responses/LabelList' '404': $ref: '#/responses/notFound' post: consumes: - application/json produces: - application/json tags: - organization summary: Create a label for an organization operationId: orgCreateLabel parameters: - type: string description: name of the organization name: org in: path required: true - name: body in: body schema: $ref: '#/definitions/CreateLabelOption' responses: '201': $ref: '#/responses/Label' '404': $ref: '#/responses/notFound' '422': $ref: '#/responses/validationError' /orgs/{org}/labels/{id}: get: produces: - application/json tags: - organization summary: Get a single label operationId: orgGetLabel parameters: - type: string description: name of the organization name: org in: path required: true - type: integer format: int64 description: id of the label to get name: id in: path required: true responses: '200': $ref: '#/responses/Label' '404': $ref: '#/responses/notFound' delete: tags: - organization summary: Delete a label operationId: orgDeleteLabel parameters: - type: string description: name of the organization name: org in: path required: true - type: integer format: int64 description: id of the label to delete name: id in: path required: true responses: '204': $ref: '#/responses/empty' '404': $ref: '#/responses/notFound' patch: consumes: - application/json produces: - application/json tags: - organization summary: Update a label operationId: orgEditLabel parameters: - type: string description: name of the organization name: org in: path required: true - type: integer format: int64 description: id of the label to edit name: id in: path required: true - name: body in: body schema: $ref: '#/definitions/EditLabelOption' responses: '200': $ref: '#/responses/Label' '404': $ref: '#/responses/notFound' '422': $ref: '#/responses/validationError' /orgs/{org}/members: get: produces: - application/json tags: - organization summary: List an organization's members operationId: orgListMembers parameters: - type: string description: name of the organization name: org in: path required: true - type: integer description: page number of results to return (1-based) name: page in: query - type: integer description: page size of results name: limit in: query responses: '200': $ref: '#/responses/UserList' '404': $ref: '#/responses/notFound' /orgs/{org}/members/{username}: get: tags: - organization summary: Check if a user is a member of an organization operationId: orgIsMember parameters: - type: string description: name of the organization name: org in: path required: true - type: string description: username of the user to check for an organization membership name: username in: path required: true responses: '204': description: user is a member '303': description: redirection to /orgs/{org}/public_members/{username} '404': description: user is not a member delete: produces: - application/json tags: - organization summary: Remove a member from an organization operationId: orgDeleteMember parameters: - type: string description: name of the organization name: org in: path required: true - type: string description: username of the user to remove from the organization name: username in: path required: true responses: '204': description: member removed '404': $ref: '#/responses/notFound' /orgs/{org}/public_members: get: produces: - application/json tags: - organization summary: List an organization's public members operationId: orgListPublicMembers parameters: - type: string description: name of the organization name: org in: path required: true - type: integer description: page number of results to return (1-based) name: page in: query - type: integer description: page size of results name: limit in: query responses: '200': $ref: '#/responses/UserList' '404': $ref: '#/responses/notFound' /orgs/{org}/public_members/{username}: get: tags: - organization summary: Check if a user is a public member of an organization operationId: orgIsPublicMember parameters: - type: string description: name of the organization name: org in: path required: true - type: string description: username of the user to check for a public organization membership name: username in: path required: true responses: '204': description: user is a public member '404': description: user is not a public member put: produces: - application/json tags: - organization summary: Publicize a user's membership operationId: orgPublicizeMember parameters: - type: string description: name of the organization name: org in: path required: true - type: string description: username of the user whose membership is to be publicized name: username in: path required: true responses: '204': description: membership publicized '403': $ref: '#/responses/forbidden' '404': $ref: '#/responses/notFound' delete: produces: - application/json tags: - organization summary: Conceal a user's membership operationId: orgConcealMember parameters: - type: string description: name of the organization name: org in: path required: true - type: string description: username of the user whose membership is to be concealed name: username in: path required: true responses: '204': $ref: '#/responses/empty' '403': $ref: '#/responses/forbidden' '404': $ref: '#/responses/notFound' /orgs/{org}/rename: post: produces: - application/json tags: - organization summary: Rename an organization operationId: renameOrg parameters: - type: string description: existing org name name: org in: path required: true - name: body in: body required: true schema: $ref: '#/definitions/RenameOrgOption' responses: '204': $ref: '#/responses/empty' '403': $ref: '#/responses/forbidden' '422': $ref: '#/responses/validationError' /orgs/{org}/repos: get: produces: - application/json tags: - organization summary: List an organization's repos operationId: orgListRepos parameters: - type: string description: name of the organization name: org in: path required: true - type: integer description: page number of results to return (1-based) name: page in: query - type: integer description: page size of results name: limit in: query responses: '200': $ref: '#/responses/RepositoryList' '404': $ref: '#/responses/notFound' post: consumes: - application/json produces: - application/json tags: - organization summary: Create a repository in an organization operationId: createOrgRepo parameters: - type: string description: name of organization name: org in: path required: true - name: body in: body schema: $ref: '#/definitions/CreateRepoOption' responses: '201': $ref: '#/responses/Repository' '400': $ref: '#/responses/error' '403': $ref: '#/responses/forbidden' '404': $ref: '#/responses/notFound' delete: produces: - application/json tags: - organization summary: Delete all repositories in an organization operationId: orgDeleteRepos parameters: - type: string description: name of the organization name: org in: path required: true responses: '202': $ref: '#/responses/empty' '204': $ref: '#/responses/empty' '403': $ref: '#/responses/forbidden' '404': $ref: '#/responses/notFound' /orgs/{org}/teams: get: produces: - application/json tags: - organization summary: List an organization's teams operationId: orgListTeams parameters: - type: string description: name of the organization name: org in: path required: true - type: integer description: page number of results to return (1-based) name: page in: query - type: integer description: page size of results name: limit in: query responses: '200': $ref: '#/responses/TeamList' '404': $ref: '#/responses/notFound' post: consumes: - application/json produces: - application/json tags: - organization summary: Create a team operationId: orgCreateTeam parameters: - type: string description: name of the organization name: org in: path required: true - name: body in: body schema: $ref: '#/definitions/CreateTeamOption' responses: '201': $ref: '#/responses/Team' '404': $ref: '#/responses/notFound' '422': $ref: '#/responses/validationError' /orgs/{org}/teams/search: get: produces: - application/json tags: - organization summary: Search for teams within an organization operationId: teamSearch parameters: - type: string description: name of the organization name: org in: path required: true - type: string description: keywords to search name: q in: query - type: boolean description: include search within team description (defaults to true) name: include_desc in: query - type: integer description: page number of results to return (1-based) name: page in: query - type: integer description: page size of results name: limit in: query responses: '200': description: SearchResults of a successful search schema: type: object properties: data: type: array items: $ref: '#/definitions/Team' ok: type: boolean '404': $ref: '#/responses/notFound' /teams/{id}: get: produces: - application/json tags: - organization summary: Get a team operationId: orgGetTeam parameters: - type: integer format: int64 description: id of the team to get name: id in: path required: true responses: '200': $ref: '#/responses/Team' '404': $ref: '#/responses/notFound' delete: tags: - organization summary: Delete a team operationId: orgDeleteTeam parameters: - type: integer format: int64 description: id of the team to delete name: id in: path required: true responses: '204': description: team deleted '404': $ref: '#/responses/notFound' patch: consumes: - application/json produces: - application/json tags: - organization summary: Edit a team operationId: orgEditTeam parameters: - type: integer description: id of the team to edit name: id in: path required: true - name: body in: body schema: $ref: '#/definitions/EditTeamOption' responses: '200': $ref: '#/responses/Team' '404': $ref: '#/responses/notFound' /teams/{id}/activities/feeds: get: produces: - application/json tags: - organization summary: List a team's activity feeds operationId: orgListTeamActivityFeeds parameters: - type: integer format: int64 description: id of the team name: id in: path required: true - type: string format: date description: the date of the activities to be found name: date in: query - type: integer description: page number of results to return (1-based) name: page in: query - type: integer description: page size of results name: limit in: query responses: '200': $ref: '#/responses/ActivityFeedsList' '404': $ref: '#/responses/notFound' /teams/{id}/members: get: produces: - application/json tags: - organization summary: List a team's members operationId: orgListTeamMembers parameters: - type: integer format: int64 description: id of the team name: id in: path required: true - type: integer description: page number of results to return (1-based) name: page in: query - type: integer description: page size of results name: limit in: query responses: '200': $ref: '#/responses/UserList' '404': $ref: '#/responses/notFound' /teams/{id}/members/{username}: get: produces: - application/json tags: - organization summary: List a particular member of team operationId: orgListTeamMember parameters: - type: integer format: int64 description: id of the team name: id in: path required: true - type: string description: username of the user whose data is to be listed name: username in: path required: true responses: '200': $ref: '#/responses/User' '404': $ref: '#/responses/notFound' put: produces: - application/json tags: - organization summary: Add a team member operationId: orgAddTeamMember parameters: - type: integer format: int64 description: id of the team name: id in: path required: true - type: string description: username of the user to add to a team name: username in: path required: true responses: '204': $ref: '#/responses/empty' '403': $ref: '#/responses/forbidden' '404': $ref: '#/responses/notFound' delete: produces: - application/json tags: - organization summary: Remove a team member operationId: orgRemoveTeamMember parameters: - type: integer format: int64 description: id of the team name: id in: path required: true - type: string description: username of the user to remove from a team name: username in: path required: true responses: '204': $ref: '#/responses/empty' '404': $ref: '#/responses/notFound' /teams/{id}/repos: get: produces: - application/json tags: - organization summary: List a team's repos operationId: orgListTeamRepos parameters: - type: integer format: int64 description: id of the team name: id in: path required: true - type: integer description: page number of results to return (1-based) name: page in: query - type: integer description: page size of results name: limit in: query responses: '200': $ref: '#/responses/RepositoryList' '404': $ref: '#/responses/notFound' /teams/{id}/repos/{org}/{repo}: get: produces: - application/json tags: - organization summary: List a particular repo of team operationId: orgListTeamRepo parameters: - type: integer format: int64 description: id of the team name: id in: path required: true - type: string description: organization that owns the repo to list name: org in: path required: true - type: string description: name of the repo to list name: repo in: path required: true responses: '200': $ref: '#/responses/Repository' '404': $ref: '#/responses/notFound' put: produces: - application/json tags: - organization summary: Add a repository to a team operationId: orgAddTeamRepository parameters: - type: integer format: int64 description: id of the team name: id in: path required: true - type: string description: organization that owns the repo to add name: org in: path required: true - type: string description: name of the repo to add name: repo in: path required: true responses: '204': $ref: '#/responses/empty' '403': $ref: '#/responses/forbidden' '404': $ref: '#/responses/notFound' delete: description: This does not delete the repository, it only removes the repository from the team. produces: - application/json tags: - organization summary: Remove a repository from a team operationId: orgRemoveTeamRepository parameters: - type: integer format: int64 description: id of the team name: id in: path required: true - type: string description: organization that owns the repo to remove name: org in: path required: true - type: string description: name of the repo to remove name: repo in: path required: true responses: '204': $ref: '#/responses/empty' '403': $ref: '#/responses/forbidden' '404': $ref: '#/responses/notFound' /user/orgs: get: produces: - application/json tags: - organization summary: List the current user's organizations operationId: orgListCurrentUserOrgs parameters: - type: integer description: page number of results to return (1-based) name: page in: query - type: integer description: page size of results name: limit in: query responses: '200': $ref: '#/responses/OrganizationList' '404': $ref: '#/responses/notFound' /users/{username}/orgs: get: produces: - application/json tags: - organization summary: List a user's organizations operationId: orgListUserOrgs parameters: - type: string description: username of the user whose organizations are to be listed name: username in: path required: true - type: integer description: page number of results to return (1-based) name: page in: query - type: integer description: page size of results name: limit in: query responses: '200': $ref: '#/responses/OrganizationList' '404': $ref: '#/responses/notFound' /users/{username}/orgs/{org}/permissions: get: produces: - application/json tags: - organization summary: Get user permissions in organization operationId: orgGetUserPermissions parameters: - type: string description: username of the user whose permissions are to be obtained name: username in: path required: true - type: string description: name of the organization name: org in: path required: true responses: '200': $ref: '#/responses/OrganizationPermissions' '403': $ref: '#/responses/forbidden' '404': $ref: '#/responses/notFound' definitions: ActionRunnersResponse: description: ActionRunnersResponse returns Runners type: object properties: runners: type: array items: $ref: '#/definitions/ActionRunner' x-go-name: Entries total_count: type: integer format: int64 x-go-name: TotalCount 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 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 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: '#/definitions/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 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 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: '#/definitions/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 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 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 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 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 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 ActionWorkflowJobsResponse: description: ActionWorkflowJobsResponse returns ActionWorkflowJobs type: object properties: jobs: type: array items: $ref: '#/definitions/ActionWorkflowJob' x-go-name: Entries total_count: type: integer format: int64 x-go-name: TotalCount 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 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 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 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 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 RepoTransfer: description: RepoTransfer represents a pending repo transfer type: object properties: doer: $ref: '#/definitions/User' recipient: $ref: '#/definitions/User' teams: type: array items: $ref: '#/definitions/Team' x-go-name: Teams 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 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 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: '#/definitions/User' act_user_id: description: The ID of the user who performed the action type: integer format: int64 x-go-name: ActUserID comment: $ref: '#/definitions/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: '#/definitions/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 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: '#/definitions/ActionWorkflowStep' x-go-name: Steps url: type: string x-go-name: URL 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 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 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: '#/definitions/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 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 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 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 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 ActionWorkflowRunsResponse: description: ActionWorkflowRunsResponse returns ActionWorkflowRuns type: object properties: total_count: type: integer format: int64 x-go-name: TotalCount workflow_runs: type: array items: $ref: '#/definitions/ActionWorkflowRun' x-go-name: Entries 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 ActionWorkflowRun: description: ActionWorkflowRun represents a WorkflowRun type: object properties: actor: $ref: '#/definitions/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: '#/definitions/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: '#/definitions/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: '#/definitions/User' url: type: string x-go-name: URL 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 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 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 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 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 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: '#/definitions/ExternalTracker' external_wiki: $ref: '#/definitions/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: '#/definitions/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: '#/definitions/User' parent: $ref: '#/definitions/Repository' permissions: $ref: '#/definitions/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: '#/definitions/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 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: '#/definitions/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: '#/definitions/User' 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 responses: Repository: description: Repository schema: $ref: '#/definitions/Repository' SecretList: description: SecretList schema: type: array items: $ref: '#/definitions/Secret' Runner: description: Runner schema: $ref: '#/definitions/ActionRunner' OrganizationPermissions: description: OrganizationPermissions schema: $ref: '#/definitions/OrganizationPermissions' error: description: APIError is error format response headers: message: type: string url: type: string validationError: description: APIValidationError is error format response related to input validation headers: message: type: string url: type: string Hook: description: Hook schema: $ref: '#/definitions/Hook' RegistrationToken: description: RegistrationToken is response related to registration token headers: token: type: string Label: description: Label schema: $ref: '#/definitions/Label' RunnerList: description: RunnerList schema: $ref: '#/definitions/ActionRunnersResponse' VariableList: description: VariableList schema: type: array items: $ref: '#/definitions/ActionVariable' RepositoryList: description: RepositoryList schema: type: array items: $ref: '#/definitions/Repository' WorkflowJobsList: description: WorkflowJobsList schema: $ref: '#/definitions/ActionWorkflowJobsResponse' Team: description: Team schema: $ref: '#/definitions/Team' notFound: description: APINotFound is a not found empty response empty: description: APIEmpty is an empty response Organization: description: Organization schema: $ref: '#/definitions/Organization' User: description: User schema: $ref: '#/definitions/User' WorkflowRunsList: description: WorkflowRunsList schema: $ref: '#/definitions/ActionWorkflowRunsResponse' UserList: description: UserList schema: type: array items: $ref: '#/definitions/User' OrganizationList: description: OrganizationList schema: type: array items: $ref: '#/definitions/Organization' ActivityFeedsList: description: ActivityFeedsList schema: type: array items: $ref: '#/definitions/Activity' HookList: description: HookList schema: type: array items: $ref: '#/definitions/Hook' ActionVariable: description: ActionVariable schema: $ref: '#/definitions/ActionVariable' TeamList: description: TeamList schema: type: array items: $ref: '#/definitions/Team' LabelList: description: LabelList schema: type: array items: $ref: '#/definitions/Label' forbidden: description: APIForbiddenError is a forbidden error response headers: message: type: string url: type: string securityDefinitions: AccessToken: description: This authentication option is deprecated for removal in Gitea 1.23. Please use AuthorizationHeaderToken instead. type: apiKey name: access_token in: query AuthorizationHeaderToken: description: API tokens must be prepended with "token" followed by a space. type: apiKey name: Authorization in: header BasicAuth: type: basic SudoHeader: description: Sudo API request as the user provided as the key. Admin privileges are required. type: apiKey name: Sudo in: header SudoParam: description: Sudo API request as the user provided as the key. Admin privileges are required. type: apiKey name: sudo in: query TOTPHeader: description: Must be used in combination with BasicAuth if two-factor authentication is enabled. type: apiKey name: X-GITEA-OTP in: header Token: description: This authentication option is deprecated for removal in Gitea 1.23. Please use AuthorizationHeaderToken instead. type: apiKey name: token in: query