Gitea issue API

openapi: 3.2.0
info:
  description: This documentation describes the Gitea API.
  title: Gitea admin Issue API
  license:
    name: MIT
    url: http://opensource.org/licenses/MIT
  version: 1.27.0+dev-89-gf52b6f3315
servers:
- url: /api/v1
security:
- BasicAuth: []
- Token: []
- AccessToken: []
- AuthorizationHeaderToken: []
- SudoParam: []
- SudoHeader: []
- TOTPHeader: []
tags:
- name: issue
paths:
  /repos/issues/search:
    get:
      tags:
      - issue
      summary: Search for issues across the repositories that the user has access to
      operationId: issueSearchIssues
      parameters:
      - description: State of the issue
        name: state
        in: query
        schema:
          type: string
          enum:
          - open
          - closed
          - all
          default: open
      - description: Comma-separated list of label names. Fetch only issues that have any of these labels. Non existent labels are discarded.
        name: labels
        in: query
        schema:
          type: string
      - description: Comma-separated list of milestone names. Fetch only issues that have any of these milestones. Non existent milestones are discarded.
        name: milestones
        in: query
        schema:
          type: string
      - description: Search string
        name: q
        in: query
        schema:
          type: string
      - description: Filter by issue type
        name: type
        in: query
        schema:
          type: string
          enum:
          - issues
          - pulls
      - description: Only show issues updated after the given time (RFC 3339 format)
        name: since
        in: query
        schema:
          type: string
          format: date-time
      - description: Only show issues updated before the given time (RFC 3339 format)
        name: before
        in: query
        schema:
          type: string
          format: date-time
      - description: Filter issues or pulls assigned to the authenticated user
        name: assigned
        in: query
        schema:
          type: boolean
          default: false
      - description: Filter issues or pulls created by the authenticated user
        name: created
        in: query
        schema:
          type: boolean
          default: false
      - description: Filter issues or pulls mentioning the authenticated user
        name: mentioned
        in: query
        schema:
          type: boolean
          default: false
      - description: Filter pull requests where the authenticated user's review was requested
        name: review_requested
        in: query
        schema:
          type: boolean
          default: false
      - description: Filter pull requests reviewed by the authenticated user
        name: reviewed
        in: query
        schema:
          type: boolean
          default: false
      - description: Filter by repository owner
        name: owner
        in: query
        schema:
          type: string
      - description: Only show items which were created by the given user
        name: created_by
        in: query
        schema:
          type: string
      - description: Filter by team (requires organization owner parameter)
        name: team
        in: query
        schema:
          type: string
      - description: Page number of results to return (1-based)
        name: page
        in: query
        schema:
          type: integer
          default: 1
          minimum: 1
      - description: Number of items per page
        name: limit
        in: query
        schema:
          type: integer
          minimum: 0
      responses:
        '200':
          $ref: '#/components/responses/IssueList'
        '400':
          $ref: '#/components/responses/error'
        '422':
          $ref: '#/components/responses/validationError'
  /repos/{owner}/{repo}/issues:
    get:
      tags:
      - issue
      summary: List a repository's issues
      operationId: issueListIssues
      parameters:
      - description: owner of the repo
        name: owner
        in: path
        required: true
        schema:
          type: string
      - description: name of the repo
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: whether issue is open or closed
        name: state
        in: query
        schema:
          type: string
          enum:
          - closed
          - open
          - all
      - description: comma separated list of label names. Fetch only issues that have any of this label names. Non existent labels are discarded.
        name: labels
        in: query
        schema:
          type: string
      - description: search string
        name: q
        in: query
        schema:
          type: string
      - description: filter by type (issues / pulls) if set
        name: type
        in: query
        schema:
          type: string
          enum:
          - issues
          - pulls
      - 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
        name: milestones
        in: query
        schema:
          type: string
      - description: Only show items updated after the given time. This is a timestamp in RFC 3339 format
        name: since
        in: query
        schema:
          type: string
          format: date-time
      - description: Only show items updated before the given time. This is a timestamp in RFC 3339 format
        name: before
        in: query
        schema:
          type: string
          format: date-time
      - description: Only show items which were created by the given user
        name: created_by
        in: query
        schema:
          type: string
      - description: Only show items for which the given user is assigned
        name: assigned_by
        in: query
        schema:
          type: string
      - description: Only show items in which the given user was mentioned
        name: mentioned_by
        in: query
        schema:
          type: string
      - description: page number of results to return (1-based)
        name: page
        in: query
        schema:
          type: integer
      - description: page size of results
        name: limit
        in: query
        schema:
          type: integer
      responses:
        '200':
          $ref: '#/components/responses/IssueList'
        '404':
          $ref: '#/components/responses/notFound'
    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:
      - description: owner of the repo
        name: owner
        in: path
        required: true
        schema:
          type: string
      - description: name of the repo
        name: repo
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          $ref: '#/components/responses/Issue'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/notFound'
        '412':
          $ref: '#/components/responses/error'
        '422':
          $ref: '#/components/responses/validationError'
        '423':
          $ref: '#/components/responses/repoArchivedError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateIssueOption'
  /repos/{owner}/{repo}/issues/comments:
    get:
      tags:
      - issue
      summary: List all comments in a repository
      operationId: issueGetRepoComments
      parameters:
      - description: owner of the repo
        name: owner
        in: path
        required: true
        schema:
          type: string
      - description: name of the repo
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: if provided, only comments updated since the provided time are returned.
        name: since
        in: query
        schema:
          type: string
          format: date-time
      - description: if provided, only comments updated before the provided time are returned.
        name: before
        in: query
        schema:
          type: string
          format: date-time
      - description: page number of results to return (1-based)
        name: page
        in: query
        schema:
          type: integer
      - description: page size of results
        name: limit
        in: query
        schema:
          type: integer
      responses:
        '200':
          $ref: '#/components/responses/CommentList'
        '404':
          $ref: '#/components/responses/notFound'
  /repos/{owner}/{repo}/issues/comments/{id}:
    get:
      tags:
      - issue
      summary: Get a comment
      operationId: issueGetComment
      parameters:
      - description: owner of the repo
        name: owner
        in: path
        required: true
        schema:
          type: string
      - description: name of the repo
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: id of the comment
        name: id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          $ref: '#/components/responses/Comment'
        '204':
          $ref: '#/components/responses/empty'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/notFound'
    delete:
      tags:
      - issue
      summary: Delete a comment
      operationId: issueDeleteComment
      parameters:
      - description: owner of the repo
        name: owner
        in: path
        required: true
        schema:
          type: string
      - description: name of the repo
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: id of comment to delete
        name: id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '204':
          $ref: '#/components/responses/empty'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/notFound'
    patch:
      tags:
      - issue
      summary: Edit a comment
      operationId: issueEditComment
      parameters:
      - description: owner of the repo
        name: owner
        in: path
        required: true
        schema:
          type: string
      - description: name of the repo
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: id of the comment to edit
        name: id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          $ref: '#/components/responses/Comment'
        '204':
          $ref: '#/components/responses/empty'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/notFound'
        '423':
          $ref: '#/components/responses/repoArchivedError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditIssueCommentOption'
  /repos/{owner}/{repo}/issues/comments/{id}/assets:
    get:
      tags:
      - issue
      summary: List comment's attachments
      operationId: issueListIssueCommentAttachments
      parameters:
      - description: owner of the repo
        name: owner
        in: path
        required: true
        schema:
          type: string
      - description: name of the repo
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: id of the comment
        name: id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          $ref: '#/components/responses/AttachmentList'
        '404':
          $ref: '#/components/responses/error'
    post:
      tags:
      - issue
      summary: Create a comment attachment
      operationId: issueCreateIssueCommentAttachment
      parameters:
      - description: owner of the repo
        name: owner
        in: path
        required: true
        schema:
          type: string
      - description: name of the repo
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: id of the comment
        name: id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - description: name of the attachment
        name: name
        in: query
        schema:
          type: string
      responses:
        '201':
          $ref: '#/components/responses/Attachment'
        '400':
          $ref: '#/components/responses/error'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/error'
        '413':
          $ref: '#/components/responses/error'
        '422':
          $ref: '#/components/responses/validationError'
        '423':
          $ref: '#/components/responses/repoArchivedError'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                attachment:
                  type: string
                  description: attachment to upload
                  format: binary
              required:
              - attachment
  /repos/{owner}/{repo}/issues/comments/{id}/assets/{attachment_id}:
    get:
      tags:
      - issue
      summary: Get a comment attachment
      operationId: issueGetIssueCommentAttachment
      parameters:
      - description: owner of the repo
        name: owner
        in: path
        required: true
        schema:
          type: string
      - description: name of the repo
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: id of the comment
        name: id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - description: id of the attachment to get
        name: attachment_id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          $ref: '#/components/responses/Attachment'
        '404':
          $ref: '#/components/responses/error'
    delete:
      tags:
      - issue
      summary: Delete a comment attachment
      operationId: issueDeleteIssueCommentAttachment
      parameters:
      - description: owner of the repo
        name: owner
        in: path
        required: true
        schema:
          type: string
      - description: name of the repo
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: id of the comment
        name: id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - description: id of the attachment to delete
        name: attachment_id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '204':
          $ref: '#/components/responses/empty'
        '404':
          $ref: '#/components/responses/error'
        '423':
          $ref: '#/components/responses/repoArchivedError'
    patch:
      tags:
      - issue
      summary: Edit a comment attachment
      operationId: issueEditIssueCommentAttachment
      parameters:
      - description: owner of the repo
        name: owner
        in: path
        required: true
        schema:
          type: string
      - description: name of the repo
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: id of the comment
        name: id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - description: id of the attachment to edit
        name: attachment_id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '201':
          $ref: '#/components/responses/Attachment'
        '404':
          $ref: '#/components/responses/error'
        '422':
          $ref: '#/components/responses/validationError'
        '423':
          $ref: '#/components/responses/repoArchivedError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditAttachmentOptions'
  /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:
      - description: owner of the repo
        name: owner
        in: path
        required: true
        schema:
          type: string
      - description: name of the repo
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: id of the comment to edit
        name: id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          $ref: '#/components/responses/ReactionList'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/notFound'
    post:
      tags:
      - issue
      summary: Add a reaction to a comment of an issue
      operationId: issuePostCommentReaction
      parameters:
      - description: owner of the repo
        name: owner
        in: path
        required: true
        schema:
          type: string
      - description: name of the repo
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: id of the comment to edit
        name: id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          $ref: '#/components/responses/Reaction'
        '201':
          $ref: '#/components/responses/Reaction'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/notFound'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditReactionOption'
    delete:
      tags:
      - issue
      summary: Remove a reaction from a comment of an issue
      operationId: issueDeleteCommentReaction
      parameters:
      - description: owner of the repo
        name: owner
        in: path
        required: true
        schema:
          type: string
      - description: name of the repo
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: id of the comment to edit
        name: id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '204':
          $ref: '#/components/responses/empty'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/notFound'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditReactionOption'
  /repos/{owner}/{repo}/issues/{index}:
    get:
      tags:
      - issue
      summary: Get an issue
      operationId: issueGetIssue
      parameters:
      - description: owner of the repo
        name: owner
        in: path
        required: true
        schema:
          type: string
      - description: name of the repo
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: index of the issue to get
        name: index
        in: path
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          $ref: '#/components/responses/Issue'
        '404':
          $ref: '#/components/responses/notFound'
    delete:
      tags:
      - issue
      summary: Delete an issue
      operationId: issueDelete
      parameters:
      - description: owner of the repo
        name: owner
        in: path
        required: true
        schema:
          type: string
      - description: name of the repo
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: index of issue to delete
        name: index
        in: path
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '204':
          $ref: '#/components/responses/empty'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/notFound'
    patch:
      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.

        '
      tags:
      - issue
      summary: Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.
      operationId: issueEditIssue
      parameters:
      - description: owner of the repo
        name: owner
        in: path
        required: true
        schema:
          type: string
      - description: name of the repo
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: index of the issue to edit
        name: index
        in: path
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '201':
          $ref: '#/components/responses/Issue'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/notFound'
        '412':
          $ref: '#/components/responses/error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditIssueOption'
  /repos/{owner}/{repo}/issues/{index}/assets:
    get:
      tags:
      - issue
      summary: List issue's attachments
      operationId: issueListIssueAttachments
      parameters:
      - description: owner of the repo
        name: owner
        in: path
        required: true
        schema:
          type: string
      - description: name of the repo
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: index of the issue
        name: index
        in: path
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          $ref: '#/components/responses/AttachmentList'
        '404':
          $ref: '#/components/responses/error'
    post:
      tags:
      - issue
      summary: Create an issue attachment
      operationId: issueCreateIssueAttachment
      parameters:
      - description: owner of the repo
        name: owner
        in: path
        required: true
        schema:
          type: string
      - description: name of the repo
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: index of the issue
        name: index
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - description: name of the attachment
        name: name
        in: query
        schema:
          type: string
      responses:
        '201':
          $ref: '#/components/responses/Attachment'
        '400':
          $ref: '#/components/responses/error'
        '404':
          $ref: '#/components/responses/error'
        '413':
          $ref: '#/components/responses/error'
        '422':
          $ref: '#/components/responses/validationError'
        '423':
          $ref: '#/components/responses/repoArchivedError'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                attachment:
                  type: string
                  description: attachment to upload
                  format: binary
              required:
              - attachment
  /repos/{owner}/{repo}/issues/{index}/assets/{attachment_id}:
    get:
      tags:
      - issue
      summary: Get an issue attachment
      operationId: issueGetIssueAttachment
      parameters:
      - description: owner of the repo
        name: owner
        in: path
        required: true
        schema:
          type: string
      - description: name of the repo
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: index of the issue
        name: index
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - description: id of the attachment to get
        name: attachment_id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          $ref: '#/components/responses/Attachment'
        '404':
          $ref: '#/components/responses/error'
    delete:
      tags:
      - issue
      summary: Delete an issue attachment
      operationId: issueDeleteIssueAttachment
      parameters:
      - description: owner of the repo
        name: owner
        in: path
        required: true
        schema:
          type: string
      - description: name of the repo
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: index of the issue
        name: index
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - description: id of the attachment to delete
        name: attachment_id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '204':
          $ref: '#/components/responses/empty'
        '404':
          $ref: '#/components/responses/error'
        '423':
          $ref: '#/components/responses/repoArchivedError'
    patch:
      tags:
      - issue
      summary: Edit an issue attachment
      operationId: issueEditIssueAttachment
      parameters:
      - description: owner of the repo
        name: owner
        in: path
        required: true
        schema:
          type: string
      - description: name of the repo
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: index of the issue
        name: index
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - description: id of the attachment to edit
        name: attachment_id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '201':
          $ref: '#/components/responses/Attachment'
        '404':
          $ref: '#/components/responses/error'
        '422':
          $ref: '#/components/responses/validationError'
        '423':
          $ref: '#/components/responses/repoArchivedError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditAttachmentOptions'
  /repos/{owner}/{repo}/issues/{index}/blocks:
    get:
      tags:
      - issue
      summary: List issues that are blocked by this issue
      operationId: issueListBlocks
      parameters:
      - description: owner of the repo
        name: owner
        in: path
        required: true
        schema:
          type: string
      - description: name of the repo
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: index of the issue
        name: index
        in: path
        required: true
        schema:
          type: string
      - description: page number of results to return (1-based)
        name: page
        in: query
        schema:
          type: integer
      - description: page size of results
        name: limit
        in: query
        schema:
          type: integer
      responses:
        '200':
          $ref: '#/components/responses/IssueList'
        '404':
          $ref: '#/components/responses/notFound'
    post:
      tags:
      - issue
      summary: Block the issue given in the body by the issue in path
      operationId: issueCreateIssueBlocking
      parameters:
      - description: owner of the repo
        name: owner
        in: path
        required: true
        schema:
          type: string
      - description: name of the repo
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: index of the issue
        name: index
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          $ref: '#/components/responses/Issue'
        '404':
          description: the issue does not exist
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IssueMeta'
    delete:
      tags:
      - issue
      summary: Unblock the issue given in the body by the issue in path
      operationId: issueRemoveIssueBlocking
      parameters:
      - description: owner of the repo
        name: owner
        in: path
        required: true
        schema:
          type: string
      - description: name of the repo
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: index of the issue
        name: index
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          $ref: '#/components/responses/Issue'
        '404':
          $ref: '#/components/responses/notFound'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IssueMeta'
  /repos/{owner}/{repo}/issues/{index}/comments:
    get:
      tags:
      - issue
      summary: List all comments on an issue
      operationId: issueGetComments
      parameters:
      - description: owner of the repo
        name: owner
        in: path
        required: true
        schema:
          type: string
      - description: name of the repo
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: index of the issue
        name: index
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - description: if provided, only comments updated since the specified time are returned.
        name: since
        in: query
        schema:
          type: string
          format: date-time
      - description: if provided, only comments updated before the provided time are returned.
        name: before
        in: query
        schema:
          type: string
          format: date-time
      responses:
        '200':
          $ref: '#/components/responses/CommentList'
        '404':
          $ref: '#/components/responses/notFound'
    post:
      tags:
      - issue
      summary: Add a comment to an issue
      operationId: issueCreateComment
      parameters:
      - description: owner of the repo
        name: owner
        in: path
        required: true
        schema:
          type: string
      - description: name of the repo
        name: repo
        in: path
        required: true
        schema:
          type: string
      - description: index of the issue
        name: index
        in: path
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '201':
          $ref: '#/components/responses/Comment'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/notFound

# --- truncated at 32 KB (105 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/gitea/refs/heads/main/openapi/gitea-issue-api-openapi.yml