/gitee/repos

POST /api/gitee/repos

Price: 1 credit

Get a Gitee repository by owner/name or link, with its language breakdown

How to use it

A renamed or transferred repository resolves to its current home, so compare the returned `alias` with what you passed before assuming it is the same path.

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)

Response

• @type string (default: "GiteeRepo")
• id integer nullable
• alias string required
• name string nullable
• path string nullable
• display_name string nullable
• description string nullable
• homepage string nullable
• language string nullable
• languages array (default: [])
  • @type string (default: "GiteeRepoLanguage")
  • language string required
  • color string nullable
  • percent number nullable
  • byte_count integer nullable
• license string nullable
• status string nullable
• star_count integer nullable
• fork_count integer nullable
• watcher_count integer nullable
• open_issue_count integer nullable
• is_fork boolean nullable
• is_private boolean nullable
• is_public boolean nullable
• is_internal boolean nullable
• is_recommended boolean nullable
• is_gvp boolean nullable
• is_outsourced boolean nullable
• is_enterprise boolean nullable
• has_issues boolean nullable
• has_wiki boolean nullable
• has_page boolean nullable
• has_issue_comments boolean nullable
• has_comments boolean nullable
• has_pull_requests boolean nullable
• default_branch string nullable
• owner 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
• namespace object nullable
  • @type string (default: "GiteeNamespace")
  • id integer required
  • alias string required
  • name string nullable
  • namespace_type string nullable
  • enterprise_id integer nullable
  • url string nullable
• enterprise object nullable
  • @type string (default: "GiteeNamespace")
  • id integer required
  • alias string required
  • name string nullable
  • namespace_type string nullable
  • enterprise_id integer nullable
  • url string nullable
• parent_alias string nullable
• creator_alias string nullable
• member_aliases array (default: [])
• maintainer 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
• reviewers 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
• testers 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
• required_reviewer_count integer nullable
• required_tester_count integer nullable
• topics array (default: [])
  • @type string (default: "GiteeRepoTopic")
  • id integer required
  • name string required
  • ident string nullable
• programs array (default: [])
  • @type string (default: "GiteeRepoProgram")
  • id integer required
  • program_name string required
  • description 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
  • 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
• issue_template_source string nullable
• url string nullable
• clone_url string nullable
• ssh_url string nullable
• created_at integer nullable
• updated_at integer nullable
• pushed_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 public Gitee repository under that owner/name 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.