aboutsummaryrefslogtreecommitdiff
path: root/docs_src/API/v1/repos.md
diff options
context:
space:
mode:
authorHampusM <hampus@hampusmat.com>2021-08-04 16:18:44 +0200
committerHampusM <hampus@hampusmat.com>2021-08-04 16:18:44 +0200
commit9f7c9103ae6ca7c3127b44a966300a8ea62b3454 (patch)
tree895768db7b82ba41937d47d362216817840842a4 /docs_src/API/v1/repos.md
parenteaf6ac44e7d38ff6cc71ca72bdaceed59b86c550 (diff)
Renamed the documentation folder to docs_src
Diffstat (limited to 'docs_src/API/v1/repos.md')
-rw-r--r--docs_src/API/v1/repos.md165
1 files changed, 165 insertions, 0 deletions
diff --git a/docs_src/API/v1/repos.md b/docs_src/API/v1/repos.md
new file mode 100644
index 0000000..483676e
--- /dev/null
+++ b/docs_src/API/v1/repos.md
@@ -0,0 +1,165 @@
+## /repos
+**Method:** GET
+
+**Description:**<br>
+Retrieves a list of available repositories.
+
+**Parameters:**<br>
+None
+
+**Response:**<br>
+
+| Code | Description | Schema |
+|---------|------------------------|---------------------------------------------------------------------|
+| 200 | A list of repositories | [\[Repository summary\]](/docs/interfaces/api.RepositorySummary.html) |
+| 400-599 | An error | [Error](/docs/modules/api.html#Error) |
+
+<br>
+
+## /repos/:repo
+**Method:** GET
+
+**Description:**<br>
+Retrieves a repository.
+
+**Parameters:**<br>
+
+| Name | Location | Description | Required | Schema |
+|------|----------|----------------|----------|--------|
+| repo | path | The repository | true | string |
+
+**Response:**<br>
+
+| Code | Description | Schema |
+|---------|--------------|----------------------------------------------------|
+| 200 | A repository | [Repository](/docs/interfaces/api.Repository.html) |
+| 400-599 | An error | [Error](/docs/modules/api.html#Error) |
+
+<br>
+
+## /repos/:repo/tree
+**Method:** GET
+
+**Description:**<br>
+Retrieves a repository tree.
+
+**Parameters:**<br>
+
+| Name | Location | Description | Required | Schema |
+|------|----------|------------------|----------|--------|
+| repo | path | The repository | true | string |
+| path | query | Path in the tree | false | string |
+
+**Response:**<br>
+
+| Code | Description | Schema |
+|---------|-------------|---------------------------------------|
+| 200 | A tree | [Tree](/docs/modules/api.html#Tree) |
+| 400-599 | An error | [Error](/docs/modules/api.html#Error) |
+
+<br>
+
+## /repos/:repo/tags
+**Method:** GET
+
+**Description:**<br>
+Retrieves a repository tag.
+
+**Parameters:**<br>
+
+| Name | Location | Description | Required | Schema |
+|------|----------|----------------|----------|--------|
+| repo | path | The repository | true | string |
+
+**Response:**<br>
+
+| Code | Description | Schema |
+|---------|-------------|---------------------------------------|
+| 200 | A tag | [\[Tag\]](/docs/modules/api.html#Tag) |
+| 400-599 | An error | [Error](/docs/modules/api.html#Error) |
+
+<br>
+
+## /repos/:repo/log
+**Method:** GET
+
+**Description:**<br>
+Retrieves a repository's log.
+
+**Parameters:**<br>
+
+| Name | Location | Description | Required | Schema |
+|------|----------|----------------|----------|--------|
+| repo | path | The repository | true | string |
+
+**Response:**<br>
+
+| Code | Description | Schema |
+|---------|--------------|----------------------------------------------------|
+| 200 | A log commit | [\[Log commit\]](/docs/modules/api.html#LogCommit) |
+| 400-599 | An error | [Error](/docs/modules/api.html#Error) |
+
+<br>
+
+## /repos/:repo/log/:commit
+**Method:** GET
+
+**Description:**<br>
+Retrieves a commit from a repository.
+
+**Parameters:**<br>
+
+| Name | Location | Description | Required | Schema |
+|--------|----------|----------------|----------|--------|
+| repo | path | The repository | true | string |
+| commit | path | A commit SHA | true | string |
+
+**Response:**<br>
+
+| Code | Description | Schema |
+|---------|-------------|--------------------------------------------|
+| 200 | A commit | [Commit](/docs/interfaces/api.Commit.html) |
+| 400-599 | An error | [Error](/docs/modules/api.html#Error) |
+
+<br>
+
+## /repos/:repo/branches
+**Method:** GET
+
+**Description:**<br>
+Retrieves a repository's branches.
+
+**Parameters:**<br>
+
+| Name | Location | Description | Required | Schema |
+|--------|----------|----------------|----------|--------|
+| repo | path | The repository | true | string |
+
+**Response:**<br>
+
+| Code | Description | Schema |
+|---------|-------------|---------------------------------------------------------------|
+| 200 | A branch | [\[Branch summary\]](/docs/interfaces/api.BranchSummary.html) |
+| 400-599 | An error | [Error](/docs/modules/api.html#Error) |
+
+<br>
+
+## /repos/:repo/branches/:branch
+**Method:** GET
+
+**Description:**<br>
+Retrieves a branch from a repository.
+
+**Parameters:**<br>
+
+| Name | Location | Description | Required | Schema |
+|--------|----------|----------------|----------|--------|
+| repo | path | The repository | true | string |
+| branch | path | A branch | true | string |
+
+**Response:**<br>
+
+| Code | Description | Schema |
+|---------|-------------|--------------------------------------------|
+| 200 | A branch | [Branch](/docs/interfaces/api.Branch.html) |
+| 400-599 | An error | [Error](/docs/modules/api.html#Error) | \ No newline at end of file