/gitee/issues

POST /api/gitee/issues

Price: 20 credits

Get a Gitee issue by repository and issue number, with its comments

How to use it

Gitee issue numbers are strings such as `IKGSZP`; take them from gitee/repos/issues or the issue link. Set `comments_limit` to 0 when you only need the issue itself.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• repo string required — Gitee repository (examples: "chinabugotech/hutool", "https://gitee.com/mindspore/mindspore"; minLength: 1)
• number string required — Issue number (examples: "IKGSZP"; minLength: 1)
• comments_limit integer — Max number of comments to include (default: 100; examples: 100; min: 0; max: 1000)

Response

• @type string (default: "GiteeIssue")
• id integer required
• number string required
• issue_title string nullable
• text string nullable
• state string nullable
• state_label string nullable
• issue_type string nullable
• priority integer nullable
• author object nullable
  • @type string (default: "GiteeUserStub")
  • id integer required
  • alias string required
  • name string nullable
  • image string nullable
  • url string nullable
  • user_type string nullable
• assignee object nullable
  • @type string (default: "GiteeUserStub")
  • id integer required
  • alias string required
  • name string nullable
  • image string nullable
  • url string nullable
  • user_type string nullable
• collaborators array (default: [])
  • @type string (default: "GiteeUserStub")
  • id integer required
  • alias string required
  • name string nullable
  • image string nullable
  • url string nullable
  • user_type string nullable
• labels array (default: [])
  • @type string (default: "GiteeLabel")
  • id integer required
  • name string required
  • color string nullable
• milestone object nullable
  • @type string (default: "GiteeMilestone")
  • number integer required
  • milestone_title string nullable
  • state string nullable
  • description string nullable
  • open_issue_count integer nullable
  • closed_issue_count integer nullable
  • url string nullable
  • due_at integer nullable
  • created_at integer nullable
  • updated_at integer nullable
• program_name string nullable
• branch string nullable
• cve_id string nullable
• is_private boolean nullable
• comment_count integer nullable
• estimated_duration integer nullable
• parent_issue_id integer nullable
• depth integer nullable
• repo_id integer nullable
• repo_alias string nullable
• url string nullable
• created_at integer nullable
• updated_at integer nullable
• plan_started_at integer nullable
• deadline_at integer nullable
• finished_at integer nullable
• comments array nullable
  • @type string (default: "GiteeIssueComment")
  • id integer required
  • text string nullable
  • author object nullable
    • @type string (default: "GiteeUserStub")
    • id integer required
    • alias string required
    • name string nullable
    • image string nullable
    • url string nullable
    • user_type string nullable
  • created_at integer nullable
  • updated_at integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No issue with that number in that repository Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.