docs: migrate to Mintlify (#8154)

docs/api-reference/administration/add-or-update-team-repository.mdx

@@ -0,0 +1,4 @@
+---
+title: "Add or update team repository"
+openapi: "PUT /admin/teams/{teamid}/repos/{reponame}"
+---

docs/api-reference/administration/add-team-membership.mdx

@@ -0,0 +1,4 @@
+---
+title: "Add team membership"
+openapi: "PUT /admin/teams/{teamid}/members/{username}"
+---

docs/api-reference/administration/create-a-new-user.mdx

@@ -0,0 +1,4 @@
+---
+title: "Create a new user"
+openapi: "POST /admin/users"
+---

docs/api-reference/administration/create-a-public-key-for-a-user.mdx

@@ -0,0 +1,4 @@
+---
+title: "Create a public key for a user"
+openapi: "POST /admin/users/{username}/keys"
+---

docs/api-reference/administration/create-a-repository-for-a-user.mdx

@@ -0,0 +1,4 @@
+---
+title: "Create a repository for a user"
+openapi: "POST /admin/users/{username}/repos"
+---

docs/api-reference/administration/create-a-team.mdx

@@ -0,0 +1,4 @@
+---
+title: "Create a team"
+openapi: "POST /admin/orgs/{orgname}/teams"
+---

docs/api-reference/administration/create-an-organization.mdx

@@ -0,0 +1,4 @@
+---
+title: "Create an organization"
+openapi: "POST /admin/users/{username}/orgs"
+---

docs/api-reference/administration/delete-a-user.mdx

@@ -0,0 +1,4 @@
+---
+title: "Delete a user"
+openapi: "DELETE /admin/users/{username}"
+---

docs/api-reference/administration/edit-an-existing-user.mdx

@@ -0,0 +1,4 @@
+---
+title: "Edit an existing user"
+openapi: "PATCH /admin/users/{username}"
+---

docs/api-reference/administration/list-all-members-of-a-team.mdx

@@ -0,0 +1,4 @@
+---
+title: "List all members of a team"
+openapi: "GET /admin/teams/{teamid}/members"
+---

docs/api-reference/administration/remove-team-membership.mdx

@@ -0,0 +1,4 @@
+---
+title: "Remove team membership"
+openapi: "DELETE /admin/teams/{teamid}/members/{username}"
+---

docs/api-reference/administration/remove-team-repository.mdx

@@ -0,0 +1,4 @@
+---
+title: "Remove team repository"
+openapi: "DELETE /admin/teams/{teamid}/repos/{reponame}"
+---

docs/api-reference/collaborators-and-deploy-keys/add-a-collaborator.mdx

@@ -0,0 +1,4 @@
+---
+title: "Add a collaborator"
+openapi: "PUT /repos/{owner}/{repo}/collaborators/{collaborator}"
+---

docs/api-reference/collaborators-and-deploy-keys/add-a-deploy-key.mdx

@@ -0,0 +1,4 @@
+---
+title: "Add a deploy key"
+openapi: "POST /repos/{owner}/{repo}/keys"
+---

docs/api-reference/collaborators-and-deploy-keys/check-if-user-is-collaborator.mdx

@@ -0,0 +1,4 @@
+---
+title: "Check if a user is a collaborator"
+openapi: "GET /repos/{owner}/{repo}/collaborators/{collaborator}"
+---

docs/api-reference/collaborators-and-deploy-keys/get-a-deploy-key.mdx

@@ -0,0 +1,4 @@
+---
+title: "Get a deploy key"
+openapi: "GET /repos/{owner}/{repo}/keys/{id}"
+---

docs/api-reference/collaborators-and-deploy-keys/list-collaborators.mdx

@@ -0,0 +1,4 @@
+---
+title: "List collaborators"
+openapi: "GET /repos/{owner}/{repo}/collaborators"
+---

docs/api-reference/collaborators-and-deploy-keys/list-deploy-keys.mdx

@@ -0,0 +1,4 @@
+---
+title: "List deploy keys"
+openapi: "GET /repos/{owner}/{repo}/keys"
+---

docs/api-reference/collaborators-and-deploy-keys/remove-a-collaborator.mdx

@@ -0,0 +1,4 @@
+---
+title: "Remove a collaborator"
+openapi: "DELETE /repos/{owner}/{repo}/collaborators/{collaborator}"
+---

docs/api-reference/collaborators-and-deploy-keys/remove-a-deploy-key.mdx

@@ -0,0 +1,4 @@
+---
+title: "Remove a deploy key"
+openapi: "DELETE /repos/{owner}/{repo}/keys/{id}"
+---

docs/api-reference/introduction.mdx

@@ -0,0 +1,116 @@
+---
+title: "Introduction"
+sidebarTitle: "Introduction"
+description: "Overview of the Gogs API including authentication, pagination, and schema"
+---
+
+The Gogs API provides a RESTful interface for interacting with your Gogs instance programmatically. It aims to follow a format similar to the [GitHub REST API v3](https://developer.github.com/v3/).
+
+<Info>
+  The API is bundled with every Gogs installation. No additional setup is required.
+</Info>
+
+<Warning>
+  The API is still in its early stages. Content and endpoints are subject to change.
+</Warning>
+
+## Current version
+
+All Gogs APIs are under **v1** using the request path prefix `/api/v1`.
+
+```
+https://gogs.example.com/api/v1
+```
+
+## Schema
+
+All data is sent and received as **JSON** unless specified otherwise.
+
+```http
+HTTP/2 200
+Content-Type: application/json; charset=UTF-8
+```
+
+All timestamps are returned in **RFC 3339** format:
+
+```
+YYYY-MM-DDTHH:MM:SSZ
+2006-01-02T15:04:05Z07:00
+```
+
+## Authentication
+
+There are two ways to authenticate through the Gogs API. Requests that require authentication will return `404 Not Found` instead of `403 Forbidden` in some places. This is to prevent the accidental leakage of private resources to unauthorized users.
+
+<Tabs>
+  <Tab title="Basic authentication">
+    Basic authentication is used to obtain access tokens. Supply your username (you will be prompted for your password):
+
+    ```bash
+    curl -u "alice" https://gogs.example.com/api/v1/users/alice/tokens
+    ```
+
+    <Warning>
+      Basic authentication should only be used to generate access tokens. Do not use it for regular API requests.
+    </Warning>
+  </Tab>
+  <Tab title="Access token">
+    Personal access tokens are the recommended way to authenticate. They can be sent via a request **header** or a **URL query parameter**.
+
+    **Using a header:**
+
+    ```bash
+    curl -H "Authorization: token {YOUR_ACCESS_TOKEN}" https://gogs.example.com/api/v1/user/repos
+    ```
+
+    **Using a query parameter:**
+
+    ```bash
+    curl https://gogs.example.com/api/v1/user/repos?token={YOUR_ACCESS_TOKEN}
+    ```
+
+    <Tip>
+      Using the `Authorization` header is preferred over the query parameter, as URLs may be logged by proxies and servers.
+    </Tip>
+  </Tab>
+</Tabs>
+
+## Pagination
+
+API responses that return multiple items are paginated. You can specify further pages with the `?page` query parameter.
+
+```bash
+curl https://gogs.example.com/api/v1/repos/alice/hello/issues?page=1
+```
+
+Page numbering is **1-based**. Omitting the `?page` parameter returns the first page.
+
+### Link header
+
+Pagination info is included in the [Link header](http://tools.ietf.org/html/rfc5988) of each response. Use this to navigate between pages programmatically.
+
+```http
+Link: <https://gogs.example.com/api/v1/repos/alice/hello/issues?page=3>; rel="next",
+  <https://gogs.example.com/api/v1/repos/alice/hello/issues?page=50>; rel="last"
+```
+
+The possible `rel` values are:
+
+| Name | Description |
+|---|---|
+| `next` | The link relation for the immediate next page of results. |
+| `last` | The link relation for the last page of results. |
+| `first` | The link relation for the first page of results. |
+| `prev` | The link relation for the immediate previous page of results. |
+
+<Tip>
+  Always use the Link header values to navigate between pages rather than constructing URLs manually.
+</Tip>
+
+## SDKs
+
+The following best-effort-maintained SDKs are available:
+
+| Language | Repository |
+|---|---|
+| Go | [gogs/go-gogs-client](https://github.com/gogs/go-gogs-client) |

docs/api-reference/issues/add-labels-to-an-issue.mdx

@@ -0,0 +1,4 @@
+---
+title: "Add labels to an issue"
+openapi: "POST /repos/{owner}/{repo}/issues/{index}/labels"
+---

docs/api-reference/issues/create-a-comment.mdx

@@ -0,0 +1,4 @@
+---
+title: "Create a comment"
+openapi: "POST /repos/{owner}/{repo}/issues/{index}/comments"
+---

docs/api-reference/issues/create-a-label.mdx

@@ -0,0 +1,4 @@
+---
+title: "Create a label"
+openapi: "POST /repos/{owner}/{repo}/labels"
+---

docs/api-reference/issues/create-a-milestone.mdx

@@ -0,0 +1,4 @@
+---
+title: "Create a milestone"
+openapi: "POST /repos/{owner}/{repo}/milestones"
+---

docs/api-reference/issues/create-an-issue.mdx

@@ -0,0 +1,4 @@
+---
+title: "Create an issue"
+openapi: "POST /repos/{owner}/{repo}/issues"
+---

docs/api-reference/issues/delete-a-comment.mdx

@@ -0,0 +1,4 @@
+---
+title: "Delete a comment"
+openapi: "DELETE /repos/{owner}/{repo}/issues/{index}/comments/{id}"
+---

docs/api-reference/issues/delete-a-label.mdx

@@ -0,0 +1,4 @@
+---
+title: "Delete a label"
+openapi: "DELETE /repos/{owner}/{repo}/labels/{id}"
+---

docs/api-reference/issues/delete-a-milestone.mdx

@@ -0,0 +1,4 @@
+---
+title: "Delete a milestone"
+openapi: "DELETE /repos/{owner}/{repo}/milestones/{id}"
+---

docs/api-reference/issues/edit-a-comment.mdx

@@ -0,0 +1,4 @@
+---
+title: "Edit a comment"
+openapi: "PATCH /repos/{owner}/{repo}/issues/{index}/comments/{id}"
+---

docs/api-reference/issues/edit-a-milestone.mdx

@@ -0,0 +1,4 @@
+---
+title: "Edit a milestone"
+openapi: "PATCH /repos/{owner}/{repo}/milestones/{id}"
+---

docs/api-reference/issues/edit-an-issue.mdx

@@ -0,0 +1,4 @@
+---
+title: "Edit an issue"
+openapi: "PATCH /repos/{owner}/{repo}/issues/{index}"
+---

docs/api-reference/issues/get-a-single-issue.mdx

@@ -0,0 +1,4 @@
+---
+title: "Get a single issue"
+openapi: "GET /repos/{owner}/{repo}/issues/{index}"
+---

docs/api-reference/issues/get-a-single-label.mdx

@@ -0,0 +1,4 @@
+---
+title: "Get a single label"
+openapi: "GET /repos/{owner}/{repo}/labels/{id}"
+---

docs/api-reference/issues/get-a-single-milestone.mdx

@@ -0,0 +1,4 @@
+---
+title: "Get a single milestone"
+openapi: "GET /repos/{owner}/{repo}/milestones/{id}"
+---

docs/api-reference/issues/list-all-labels-for-a-repository.mdx

@@ -0,0 +1,4 @@
+---
+title: "List all labels for a repository"
+openapi: "GET /repos/{owner}/{repo}/labels"
+---

docs/api-reference/issues/list-comments-in-a-repository.mdx

@@ -0,0 +1,4 @@
+---
+title: "List comments in a repository"
+openapi: "GET /repos/{owner}/{repo}/issues/comments"
+---

docs/api-reference/issues/list-comments-on-an-issue.mdx

@@ -0,0 +1,4 @@
+---
+title: "List comments on an issue"
+openapi: "GET /repos/{owner}/{repo}/issues/{index}/comments"
+---

docs/api-reference/issues/list-issues-for-a-repository.mdx

@@ -0,0 +1,4 @@
+---
+title: "List issues for a repository"
+openapi: "GET /repos/{owner}/{repo}/issues"
+---

docs/api-reference/issues/list-labels-on-an-issue.mdx

@@ -0,0 +1,4 @@
+---
+title: "List labels on an issue"
+openapi: "GET /repos/{owner}/{repo}/issues/{index}/labels"
+---

docs/api-reference/issues/list-milestones-for-a-repository.mdx

@@ -0,0 +1,4 @@
+---
+title: "List milestones for a repository"
+openapi: "GET /repos/{owner}/{repo}/milestones"
+---

docs/api-reference/issues/list-user-issues.mdx

@@ -0,0 +1,4 @@
+---
+title: "List user issues"
+openapi: "GET /user/issues"
+---

docs/api-reference/issues/remove-a-label-from-an-issue.mdx

@@ -0,0 +1,4 @@
+---
+title: "Remove a label from an issue"
+openapi: "DELETE /repos/{owner}/{repo}/issues/{index}/labels/{id}"
+---

docs/api-reference/issues/remove-all-labels-from-an-issue.mdx

@@ -0,0 +1,4 @@
+---
+title: "Remove all labels from an issue"
+openapi: "DELETE /repos/{owner}/{repo}/issues/{index}/labels"
+---

docs/api-reference/issues/replace-all-labels-for-an-issue.mdx

@@ -0,0 +1,4 @@
+---
+title: "Replace all labels for an issue"
+openapi: "PUT /repos/{owner}/{repo}/issues/{index}/labels"
+---

docs/api-reference/issues/update-a-label.mdx

@@ -0,0 +1,4 @@
+---
+title: "Update a label"
+openapi: "PATCH /repos/{owner}/{repo}/labels/{id}"
+---

docs/api-reference/miscellaneous/get-a-git-blob.mdx

@@ -0,0 +1,4 @@
+---
+title: "Get a git blob"
+openapi: "GET /repos/{owner}/{repo}/git/blobs/{sha}"
+---

docs/api-reference/miscellaneous/get-a-tree.mdx

@@ -0,0 +1,4 @@
+---
+title: "Get a tree"
+openapi: "GET /repos/{owner}/{repo}/git/trees/{sha}"
+---

docs/api-reference/miscellaneous/render-a-markdown-document-in-raw-mode.mdx

@@ -0,0 +1,4 @@
+---
+title: "Render a Markdown document in raw mode"
+openapi: "POST /markdown/raw"
+---

docs/api-reference/miscellaneous/render-a-markdown-document.mdx

@@ -0,0 +1,4 @@
+---
+title: "Render a Markdown document"
+openapi: "POST /markdown"
+---

docs/api-reference/organizations/create-an-organization-for-user.mdx

@@ -0,0 +1,4 @@
+---
+title: "Create an organization"
+openapi: "POST /user/orgs"
+---

docs/api-reference/organizations/edit-an-organization.mdx

@@ -0,0 +1,4 @@
+---
+title: "Edit an organization"
+openapi: "PATCH /orgs/{orgname}"
+---

docs/api-reference/organizations/get-an-organization.mdx

@@ -0,0 +1,4 @@
+---
+title: "Get an organization"
+openapi: "GET /orgs/{orgname}"
+---

docs/api-reference/organizations/list-teams-of-an-organization.mdx

@@ -0,0 +1,4 @@
+---
+title: "List teams of an organization"
+openapi: "GET /orgs/{orgname}/teams"
+---

docs/api-reference/organizations/list-user-organizations.mdx

@@ -0,0 +1,4 @@
+---
+title: "List user organizations"
+openapi: "GET /users/{username}/orgs"
+---

docs/api-reference/organizations/list-your-organizations.mdx

@@ -0,0 +1,4 @@
+---
+title: "List your organizations"
+openapi: "GET /user/orgs"
+---

docs/api-reference/releases/list-releases.mdx

@@ -0,0 +1,4 @@
+---
+title: "List releases"
+openapi: "GET /repos/{owner}/{repo}/releases"
+---

docs/api-reference/repositories/create-a-repository-in-an-organization.mdx

@@ -0,0 +1,4 @@
+---
+title: "Create a repository in an organization"
+openapi: "POST /org/{org}/repos"
+---

docs/api-reference/repositories/create-a-repository.mdx

@@ -0,0 +1,4 @@
+---
+title: "Create a repository"
+openapi: "POST /user/repos"
+---

docs/api-reference/repositories/create-or-update-a-file.mdx

@@ -0,0 +1,4 @@
+---
+title: "Create or update a file"
+openapi: "PUT /repos/{owner}/{repo}/contents/{path}"
+---

docs/api-reference/repositories/delete-a-repository.mdx

@@ -0,0 +1,4 @@
+---
+title: "Delete a repository"
+openapi: "DELETE /repos/{owner}/{repo}"
+---

docs/api-reference/repositories/download-archive.mdx

@@ -0,0 +1,4 @@
+---
+title: "Download archive"
+openapi: "GET /repos/{owner}/{repo}/archive/{archive}"
+---

docs/api-reference/repositories/download-raw-content.mdx

@@ -0,0 +1,4 @@
+---
+title: "Download raw content"
+openapi: "GET /repos/{owner}/{repo}/raw/{ref}/{filepath}"
+---

docs/api-reference/repositories/edit-issue-tracker-settings.mdx

@@ -0,0 +1,4 @@
+---
+title: "Edit issue tracker settings"
+openapi: "PATCH /repos/{owner}/{repo}/issue-tracker"
+---

docs/api-reference/repositories/edit-wiki-settings.mdx

@@ -0,0 +1,4 @@
+---
+title: "Edit wiki settings"
+openapi: "PATCH /repos/{owner}/{repo}/wiki"
+---

docs/api-reference/repositories/get-a-branch.mdx

@@ -0,0 +1,4 @@
+---
+title: "Get a branch"
+openapi: "GET /repos/{owner}/{repo}/branches/{branch}"
+---

docs/api-reference/repositories/get-a-repository.mdx

@@ -0,0 +1,4 @@
+---
+title: "Get a repository"
+openapi: "GET /repos/{owner}/{repo}"
+---

docs/api-reference/repositories/get-a-single-commit.mdx

@@ -0,0 +1,4 @@
+---
+title: "Get a single commit"
+openapi: "GET /repos/{owner}/{repo}/commits/{sha}"
+---

docs/api-reference/repositories/get-contents.mdx

@@ -0,0 +1,4 @@
+---
+title: "Get contents"
+openapi: "GET /repos/{owner}/{repo}/contents/{path}"
+---

docs/api-reference/repositories/get-editorconfig-definition.mdx

@@ -0,0 +1,4 @@
+---
+title: "Get editorconfig definition"
+openapi: "GET /repos/{owner}/{repo}/editorconfig/{filename}"
+---

docs/api-reference/repositories/list-all-commits.mdx

@@ -0,0 +1,4 @@
+---
+title: "List all commits"
+openapi: "GET /repos/{owner}/{repo}/commits"
+---

docs/api-reference/repositories/list-branches.mdx

@@ -0,0 +1,4 @@
+---
+title: "List branches"
+openapi: "GET /repos/{owner}/{repo}/branches"
+---

docs/api-reference/repositories/list-forks.mdx

@@ -0,0 +1,4 @@
+---
+title: "List forks"
+openapi: "GET /repos/{owner}/{repo}/forks"
+---

docs/api-reference/repositories/list-organization-repositories.mdx

@@ -0,0 +1,4 @@
+---
+title: "List organization repositories"
+openapi: "GET /orgs/{orgname}/repos"
+---

docs/api-reference/repositories/list-tags.mdx

@@ -0,0 +1,4 @@
+---
+title: "List tags"
+openapi: "GET /repos/{owner}/{repo}/tags"
+---

docs/api-reference/repositories/list-user-repositories.mdx

@@ -0,0 +1,4 @@
+---
+title: "List user repositories"
+openapi: "GET /users/{username}/repos"
+---

docs/api-reference/repositories/list-your-repositories.mdx

@@ -0,0 +1,4 @@
+---
+title: "List your repositories"
+openapi: "GET /user/repos"
+---

docs/api-reference/repositories/migrate-a-repository.mdx

@@ -0,0 +1,4 @@
+---
+title: "Migrate a repository"
+openapi: "POST /repos/migrate"
+---

docs/api-reference/repositories/mirror-sync.mdx

@@ -0,0 +1,4 @@
+---
+title: "Mirror sync"
+openapi: "POST /repos/{owner}/{repo}/mirror-sync"
+---

docs/api-reference/repositories/search-repositories.mdx

@@ -0,0 +1,4 @@
+---
+title: "Search repositories"
+openapi: "GET /repos/search"
+---

docs/api-reference/users/add-email-addresses.mdx

@@ -0,0 +1,4 @@
+---
+title: "Add email addresses"
+openapi: "POST /user/emails"
+---

docs/api-reference/users/check-if-a-user-follows-another.mdx

@@ -0,0 +1,4 @@
+---
+title: "Check if a user follows another"
+openapi: "GET /users/{username}/following/{target}"
+---

docs/api-reference/users/check-if-you-follow-a-user.mdx

@@ -0,0 +1,4 @@
+---
+title: "Check if you follow a user"
+openapi: "GET /user/following/{target}"
+---

docs/api-reference/users/create-a-public-key.mdx

@@ -0,0 +1,4 @@
+---
+title: "Create a public key"
+openapi: "POST /user/keys"
+---

docs/api-reference/users/create-an-access-token.mdx

@@ -0,0 +1,4 @@
+---
+title: "Create an access token"
+openapi: "POST /users/{username}/tokens"
+---

docs/api-reference/users/delete-a-public-key.mdx

@@ -0,0 +1,4 @@
+---
+title: "Delete a public key"
+openapi: "DELETE /user/keys/{id}"
+---

docs/api-reference/users/delete-email-addresses.mdx

@@ -0,0 +1,4 @@
+---
+title: "Delete email addresses"
+openapi: "DELETE /user/emails"
+---

docs/api-reference/users/follow-a-user.mdx

@@ -0,0 +1,4 @@
+---
+title: "Follow a user"
+openapi: "PUT /user/following/{target}"
+---

docs/api-reference/users/get-a-single-public-key.mdx

@@ -0,0 +1,4 @@
+---
+title: "Get a single public key"
+openapi: "GET /user/keys/{id}"
+---

docs/api-reference/users/get-a-single-user.mdx

@@ -0,0 +1,4 @@
+---
+title: "Get a single user"
+openapi: "GET /users/{username}"
+---

docs/api-reference/users/get-the-authenticated-user.mdx

@@ -0,0 +1,4 @@
+---
+title: "Get the authenticated user"
+openapi: "GET /user"
+---

docs/api-reference/users/list-access-tokens.mdx

@@ -0,0 +1,4 @@
+---
+title: "List access tokens"
+openapi: "GET /users/{username}/tokens"
+---

docs/api-reference/users/list-email-addresses.mdx

@@ -0,0 +1,4 @@
+---
+title: "List email addresses"
+openapi: "GET /user/emails"
+---

docs/api-reference/users/list-followers-of-a-user.mdx

@@ -0,0 +1,4 @@
+---
+title: "List followers of a user"
+openapi: "GET /users/{username}/followers"
+---

docs/api-reference/users/list-public-keys-for-a-user.mdx

@@ -0,0 +1,4 @@
+---
+title: "List public keys for a user"
+openapi: "GET /users/{username}/keys"
+---

docs/api-reference/users/list-users-followed-by-a-user.mdx

@@ -0,0 +1,4 @@
+---
+title: "List users followed by a user"
+openapi: "GET /users/{username}/following"
+---

docs/api-reference/users/list-who-you-are-following.mdx

@@ -0,0 +1,4 @@
+---
+title: "List who you are following"
+openapi: "GET /user/following"
+---

docs/api-reference/users/list-your-followers.mdx

@@ -0,0 +1,4 @@
+---
+title: "List your followers"
+openapi: "GET /user/followers"
+---

docs/api-reference/users/list-your-public-keys.mdx

@@ -0,0 +1,4 @@
+---
+title: "List your public keys"
+openapi: "GET /user/keys"
+---