mirror of
https://github.com/Dokploy/dokploy
synced 2025-06-26 18:27:59 +00:00
chore(docs): update api.json endpoints
This commit is contained in:
Mauricio Siu
3114
apps/docs/api.json
3114
apps/docs/api.json
File diff suppressed because it is too large
Load Diff
@@ -28,6 +28,11 @@
|
|||||||
"reference-api/reference-registry",
|
"reference-api/reference-registry",
|
||||||
"reference-api/reference-security",
|
"reference-api/reference-security",
|
||||||
"reference-api/reference-settings",
|
"reference-api/reference-settings",
|
||||||
|
"reference-api/reference-sshKey",
|
||||||
|
"reference-api/reference-gitProvider",
|
||||||
|
"reference-api/reference-bitbucket",
|
||||||
|
"reference-api/reference-github",
|
||||||
|
"reference-api/reference-gitlab",
|
||||||
"reference-api/reference-user"
|
"reference-api/reference-user"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -439,11 +439,11 @@ In: `header`
|
|||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
<Property name={"accesedProjects"} type={"array of string"} required={true} deprecated={undefined}>
|
<Property name={"accesedProjects"} type={"array<string>"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
<Property name={"accesedServices"} type={"array of string"} required={true} deprecated={undefined}>
|
<Property name={"accesedServices"} type={"array<string>"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
@@ -459,6 +459,14 @@ In: `header`
|
|||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"canAccessToSSHKeys"} type={"boolean"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"canAccessToGitProviders"} type={"boolean"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
| Status code | Description |
|
| Status code | Description |
|
||||||
| ----------- | ----------- |
|
| ----------- | ----------- |
|
||||||
| `200` | Successful response |
|
| `200` | Successful response |
|
||||||
@@ -488,7 +496,9 @@ curl -X POST "http://localhost:3000/api/admin.assignPermissions" \
|
|||||||
],
|
],
|
||||||
"canAccessToTraefikFiles": true,
|
"canAccessToTraefikFiles": true,
|
||||||
"canAccessToDocker": true,
|
"canAccessToDocker": true,
|
||||||
"canAccessToAPI": true
|
"canAccessToAPI": true,
|
||||||
|
"canAccessToSSHKeys": true,
|
||||||
|
"canAccessToGitProviders": true
|
||||||
}'
|
}'
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -552,382 +562,4 @@ export interface Response {
|
|||||||
|
|
||||||
</API>
|
</API>
|
||||||
|
|
||||||
<API>
|
|
||||||
|
|
||||||
<APIInfo method={"POST"} route={"/admin.cleanGithubApp"}>
|
|
||||||
|
|
||||||
## admin-cleanGithubApp
|
|
||||||
|
|
||||||
### Authorization
|
|
||||||
|
|
||||||
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
|
||||||
|
|
||||||
In: `header`
|
|
||||||
|
|
||||||
</Property>
|
|
||||||
|
|
||||||
| Status code | Description |
|
|
||||||
| ----------- | ----------- |
|
|
||||||
| `200` | Successful response |
|
|
||||||
| `default` | Error response |
|
|
||||||
|
|
||||||
</APIInfo>
|
|
||||||
|
|
||||||
<APIExample>
|
|
||||||
|
|
||||||
<Requests items={["cURL","JavaScript"]}>
|
|
||||||
|
|
||||||
<Request value={"cURL"}>
|
|
||||||
|
|
||||||
```bash
|
|
||||||
curl -X POST "http://localhost:3000/api/admin.cleanGithubApp"
|
|
||||||
```
|
|
||||||
|
|
||||||
</Request>
|
|
||||||
|
|
||||||
<Request value={"JavaScript"}>
|
|
||||||
|
|
||||||
```js
|
|
||||||
fetch("http://localhost:3000/api/admin.cleanGithubApp", {
|
|
||||||
method: "POST"
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
</Request>
|
|
||||||
|
|
||||||
</Requests>
|
|
||||||
|
|
||||||
<Responses items={["default"]}>
|
|
||||||
|
|
||||||
<Response value={"default"}>
|
|
||||||
|
|
||||||
<ResponseTypes>
|
|
||||||
|
|
||||||
<ExampleResponse>
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"message": "string",
|
|
||||||
"code": "string",
|
|
||||||
"issues": [
|
|
||||||
{
|
|
||||||
"message": "string"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
</ExampleResponse>
|
|
||||||
|
|
||||||
<TypeScriptResponse>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
export interface Response {
|
|
||||||
message: string;
|
|
||||||
code: string;
|
|
||||||
issues?: {
|
|
||||||
message: string;
|
|
||||||
}[];
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
</TypeScriptResponse>
|
|
||||||
|
|
||||||
</ResponseTypes>
|
|
||||||
|
|
||||||
</Response>
|
|
||||||
|
|
||||||
</Responses>
|
|
||||||
|
|
||||||
</APIExample>
|
|
||||||
|
|
||||||
</API>
|
|
||||||
|
|
||||||
<API>
|
|
||||||
|
|
||||||
<APIInfo method={"GET"} route={"/admin.getRepositories"}>
|
|
||||||
|
|
||||||
## admin-getRepositories
|
|
||||||
|
|
||||||
### Authorization
|
|
||||||
|
|
||||||
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
|
||||||
|
|
||||||
In: `header`
|
|
||||||
|
|
||||||
</Property>
|
|
||||||
|
|
||||||
| Status code | Description |
|
|
||||||
| ----------- | ----------- |
|
|
||||||
| `200` | Successful response |
|
|
||||||
| `default` | Error response |
|
|
||||||
|
|
||||||
</APIInfo>
|
|
||||||
|
|
||||||
<APIExample>
|
|
||||||
|
|
||||||
<Requests items={["cURL","JavaScript"]}>
|
|
||||||
|
|
||||||
<Request value={"cURL"}>
|
|
||||||
|
|
||||||
```bash
|
|
||||||
curl -X GET "http://localhost:3000/api/admin.getRepositories"
|
|
||||||
```
|
|
||||||
|
|
||||||
</Request>
|
|
||||||
|
|
||||||
<Request value={"JavaScript"}>
|
|
||||||
|
|
||||||
```js
|
|
||||||
fetch("http://localhost:3000/api/admin.getRepositories", {
|
|
||||||
method: "GET"
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
</Request>
|
|
||||||
|
|
||||||
</Requests>
|
|
||||||
|
|
||||||
<Responses items={["default"]}>
|
|
||||||
|
|
||||||
<Response value={"default"}>
|
|
||||||
|
|
||||||
<ResponseTypes>
|
|
||||||
|
|
||||||
<ExampleResponse>
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"message": "string",
|
|
||||||
"code": "string",
|
|
||||||
"issues": [
|
|
||||||
{
|
|
||||||
"message": "string"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
</ExampleResponse>
|
|
||||||
|
|
||||||
<TypeScriptResponse>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
export interface Response {
|
|
||||||
message: string;
|
|
||||||
code: string;
|
|
||||||
issues?: {
|
|
||||||
message: string;
|
|
||||||
}[];
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
</TypeScriptResponse>
|
|
||||||
|
|
||||||
</ResponseTypes>
|
|
||||||
|
|
||||||
</Response>
|
|
||||||
|
|
||||||
</Responses>
|
|
||||||
|
|
||||||
</APIExample>
|
|
||||||
|
|
||||||
</API>
|
|
||||||
|
|
||||||
<API>
|
|
||||||
|
|
||||||
<APIInfo method={"GET"} route={"/admin.getBranches"}>
|
|
||||||
|
|
||||||
## admin-getBranches
|
|
||||||
|
|
||||||
### Authorization
|
|
||||||
|
|
||||||
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
|
||||||
|
|
||||||
In: `header`
|
|
||||||
|
|
||||||
</Property>
|
|
||||||
|
|
||||||
### Query Parameters
|
|
||||||
|
|
||||||
<Property name={"repo"} type={"string"} required={true} deprecated={false}>
|
|
||||||
|
|
||||||
<span>Minimum length: `1`</span>
|
|
||||||
|
|
||||||
</Property>
|
|
||||||
|
|
||||||
<Property name={"owner"} type={"string"} required={true} deprecated={false}>
|
|
||||||
|
|
||||||
<span>Minimum length: `1`</span>
|
|
||||||
|
|
||||||
</Property>
|
|
||||||
|
|
||||||
| Status code | Description |
|
|
||||||
| ----------- | ----------- |
|
|
||||||
| `200` | Successful response |
|
|
||||||
| `default` | Error response |
|
|
||||||
|
|
||||||
</APIInfo>
|
|
||||||
|
|
||||||
<APIExample>
|
|
||||||
|
|
||||||
<Requests items={["cURL","JavaScript"]}>
|
|
||||||
|
|
||||||
<Request value={"cURL"}>
|
|
||||||
|
|
||||||
```bash
|
|
||||||
curl -X GET "http://localhost:3000/api/admin.getBranches?repo=string&owner=string"
|
|
||||||
```
|
|
||||||
|
|
||||||
</Request>
|
|
||||||
|
|
||||||
<Request value={"JavaScript"}>
|
|
||||||
|
|
||||||
```js
|
|
||||||
fetch("http://localhost:3000/api/admin.getBranches?repo=string&owner=string", {
|
|
||||||
method: "GET"
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
</Request>
|
|
||||||
|
|
||||||
</Requests>
|
|
||||||
|
|
||||||
<Responses items={["default"]}>
|
|
||||||
|
|
||||||
<Response value={"default"}>
|
|
||||||
|
|
||||||
<ResponseTypes>
|
|
||||||
|
|
||||||
<ExampleResponse>
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"message": "string",
|
|
||||||
"code": "string",
|
|
||||||
"issues": [
|
|
||||||
{
|
|
||||||
"message": "string"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
</ExampleResponse>
|
|
||||||
|
|
||||||
<TypeScriptResponse>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
export interface Response {
|
|
||||||
message: string;
|
|
||||||
code: string;
|
|
||||||
issues?: {
|
|
||||||
message: string;
|
|
||||||
}[];
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
</TypeScriptResponse>
|
|
||||||
|
|
||||||
</ResponseTypes>
|
|
||||||
|
|
||||||
</Response>
|
|
||||||
|
|
||||||
</Responses>
|
|
||||||
|
|
||||||
</APIExample>
|
|
||||||
|
|
||||||
</API>
|
|
||||||
|
|
||||||
<API>
|
|
||||||
|
|
||||||
<APIInfo method={"GET"} route={"/admin.haveGithubConfigured"}>
|
|
||||||
|
|
||||||
## admin-haveGithubConfigured
|
|
||||||
|
|
||||||
### Authorization
|
|
||||||
|
|
||||||
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
|
||||||
|
|
||||||
In: `header`
|
|
||||||
|
|
||||||
</Property>
|
|
||||||
|
|
||||||
| Status code | Description |
|
|
||||||
| ----------- | ----------- |
|
|
||||||
| `200` | Successful response |
|
|
||||||
| `default` | Error response |
|
|
||||||
|
|
||||||
</APIInfo>
|
|
||||||
|
|
||||||
<APIExample>
|
|
||||||
|
|
||||||
<Requests items={["cURL","JavaScript"]}>
|
|
||||||
|
|
||||||
<Request value={"cURL"}>
|
|
||||||
|
|
||||||
```bash
|
|
||||||
curl -X GET "http://localhost:3000/api/admin.haveGithubConfigured"
|
|
||||||
```
|
|
||||||
|
|
||||||
</Request>
|
|
||||||
|
|
||||||
<Request value={"JavaScript"}>
|
|
||||||
|
|
||||||
```js
|
|
||||||
fetch("http://localhost:3000/api/admin.haveGithubConfigured", {
|
|
||||||
method: "GET"
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
</Request>
|
|
||||||
|
|
||||||
</Requests>
|
|
||||||
|
|
||||||
<Responses items={["default"]}>
|
|
||||||
|
|
||||||
<Response value={"default"}>
|
|
||||||
|
|
||||||
<ResponseTypes>
|
|
||||||
|
|
||||||
<ExampleResponse>
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"message": "string",
|
|
||||||
"code": "string",
|
|
||||||
"issues": [
|
|
||||||
{
|
|
||||||
"message": "string"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
</ExampleResponse>
|
|
||||||
|
|
||||||
<TypeScriptResponse>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
export interface Response {
|
|
||||||
message: string;
|
|
||||||
code: string;
|
|
||||||
issues?: {
|
|
||||||
message: string;
|
|
||||||
}[];
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
</TypeScriptResponse>
|
|
||||||
|
|
||||||
</ResponseTypes>
|
|
||||||
|
|
||||||
</Response>
|
|
||||||
|
|
||||||
</Responses>
|
|
||||||
|
|
||||||
</APIExample>
|
|
||||||
|
|
||||||
</API>
|
|
||||||
|
|
||||||
</Root>
|
</Root>
|
||||||
@@ -750,6 +750,10 @@ In: `header`
|
|||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"buildArgs"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
| Status code | Description |
|
| Status code | Description |
|
||||||
| ----------- | ----------- |
|
| ----------- | ----------- |
|
||||||
| `200` | Successful response |
|
| `200` | Successful response |
|
||||||
@@ -767,7 +771,8 @@ In: `header`
|
|||||||
curl -X POST "http://localhost:3000/api/application.saveEnvironment" \
|
curl -X POST "http://localhost:3000/api/application.saveEnvironment" \
|
||||||
-d '{
|
-d '{
|
||||||
"applicationId": "string",
|
"applicationId": "string",
|
||||||
"env": "string"
|
"env": "string",
|
||||||
|
"buildArgs": "string"
|
||||||
}'
|
}'
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -853,7 +858,7 @@ In: `header`
|
|||||||
|
|
||||||
<Property name={"buildType"} type={"string"} required={true} deprecated={undefined}>
|
<Property name={"buildType"} type={"string"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
<span>Value in: `"dockerfile" | "heroku_buildpacks" | "paketo_buildpacks" | "nixpacks"`</span>
|
<span>Value in: `"dockerfile" | "heroku_buildpacks" | "paketo_buildpacks" | "nixpacks" | "static"`</span>
|
||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
@@ -861,6 +866,14 @@ In: `header`
|
|||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"dockerContextPath"} type={"string | null"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"publishDirectory"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
| Status code | Description |
|
| Status code | Description |
|
||||||
| ----------- | ----------- |
|
| ----------- | ----------- |
|
||||||
| `200` | Successful response |
|
| `200` | Successful response |
|
||||||
@@ -879,7 +892,9 @@ curl -X POST "http://localhost:3000/api/application.saveBuildType" \
|
|||||||
-d '{
|
-d '{
|
||||||
"applicationId": "string",
|
"applicationId": "string",
|
||||||
"buildType": "dockerfile",
|
"buildType": "dockerfile",
|
||||||
"dockerfile": "string"
|
"dockerfile": "string",
|
||||||
|
"dockerContextPath": "string",
|
||||||
|
"publishDirectory": "string"
|
||||||
}'
|
}'
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -979,6 +994,10 @@ In: `header`
|
|||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"githubId"} type={"string | null"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
| Status code | Description |
|
| Status code | Description |
|
||||||
| ----------- | ----------- |
|
| ----------- | ----------- |
|
||||||
| `200` | Successful response |
|
| `200` | Successful response |
|
||||||
@@ -999,7 +1018,8 @@ curl -X POST "http://localhost:3000/api/application.saveGithubProvider" \
|
|||||||
"repository": "string",
|
"repository": "string",
|
||||||
"branch": "string",
|
"branch": "string",
|
||||||
"owner": "string",
|
"owner": "string",
|
||||||
"buildPath": "string"
|
"buildPath": "string",
|
||||||
|
"githubId": "string"
|
||||||
}'
|
}'
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -1065,6 +1085,266 @@ export interface Response {
|
|||||||
|
|
||||||
<API>
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"POST"} route={"/application.saveGitlabProvider"}>
|
||||||
|
|
||||||
|
## application-saveGitlabProvider
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
### Request Body
|
||||||
|
|
||||||
|
<Property name={"applicationId"} type={"string"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"gitlabBranch"} type={"string | null"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"gitlabBuildPath"} type={"string | null"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"gitlabOwner"} type={"string | null"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"gitlabRepository"} type={"string | null"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"gitlabId"} type={"string | null"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"gitlabProjectId"} type={"number | null"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"gitlabPathNamespace"} type={"string | null"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X POST "http://localhost:3000/api/application.saveGitlabProvider" \
|
||||||
|
-d '{
|
||||||
|
"applicationId": "string",
|
||||||
|
"gitlabBranch": "string",
|
||||||
|
"gitlabBuildPath": "string",
|
||||||
|
"gitlabOwner": "string",
|
||||||
|
"gitlabRepository": "string",
|
||||||
|
"gitlabId": "string",
|
||||||
|
"gitlabProjectId": 0,
|
||||||
|
"gitlabPathNamespace": "string"
|
||||||
|
}'
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/application.saveGitlabProvider", {
|
||||||
|
method: "POST"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"POST"} route={"/application.saveBitbucketProvider"}>
|
||||||
|
|
||||||
|
## application-saveBitbucketProvider
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
### Request Body
|
||||||
|
|
||||||
|
<Property name={"bitbucketBranch"} type={"string | null"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"bitbucketBuildPath"} type={"string | null"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"bitbucketOwner"} type={"string | null"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"bitbucketRepository"} type={"string | null"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"bitbucketId"} type={"string | null"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"applicationId"} type={"string"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X POST "http://localhost:3000/api/application.saveBitbucketProvider" \
|
||||||
|
-d '{
|
||||||
|
"bitbucketBranch": "string",
|
||||||
|
"bitbucketBuildPath": "string",
|
||||||
|
"bitbucketOwner": "string",
|
||||||
|
"bitbucketRepository": "string",
|
||||||
|
"bitbucketId": "string",
|
||||||
|
"applicationId": "string"
|
||||||
|
}'
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/application.saveBitbucketProvider", {
|
||||||
|
method: "POST"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
<APIInfo method={"POST"} route={"/application.saveDockerProvider"}>
|
<APIInfo method={"POST"} route={"/application.saveDockerProvider"}>
|
||||||
|
|
||||||
## application-saveDockerProvider
|
## application-saveDockerProvider
|
||||||
@@ -1210,6 +1490,10 @@ In: `header`
|
|||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"customGitSSHKeyId"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
| Status code | Description |
|
| Status code | Description |
|
||||||
| ----------- | ----------- |
|
| ----------- | ----------- |
|
||||||
| `200` | Successful response |
|
| `200` | Successful response |
|
||||||
@@ -1229,7 +1513,8 @@ curl -X POST "http://localhost:3000/api/application.saveGitProdiver" \
|
|||||||
"customGitBranch": "string",
|
"customGitBranch": "string",
|
||||||
"applicationId": "string",
|
"applicationId": "string",
|
||||||
"customGitBuildPath": "string",
|
"customGitBuildPath": "string",
|
||||||
"customGitUrl": "string"
|
"customGitUrl": "string",
|
||||||
|
"customGitSSHKeyId": "string"
|
||||||
}'
|
}'
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -1295,206 +1580,6 @@ export interface Response {
|
|||||||
|
|
||||||
<API>
|
<API>
|
||||||
|
|
||||||
<APIInfo method={"POST"} route={"/application.generateSSHKey"}>
|
|
||||||
|
|
||||||
## application-generateSSHKey
|
|
||||||
|
|
||||||
### Authorization
|
|
||||||
|
|
||||||
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
|
||||||
|
|
||||||
In: `header`
|
|
||||||
|
|
||||||
</Property>
|
|
||||||
|
|
||||||
### Request Body
|
|
||||||
|
|
||||||
<Property name={"applicationId"} type={"string"} required={true} deprecated={undefined}>
|
|
||||||
|
|
||||||
</Property>
|
|
||||||
|
|
||||||
| Status code | Description |
|
|
||||||
| ----------- | ----------- |
|
|
||||||
| `200` | Successful response |
|
|
||||||
| `default` | Error response |
|
|
||||||
|
|
||||||
</APIInfo>
|
|
||||||
|
|
||||||
<APIExample>
|
|
||||||
|
|
||||||
<Requests items={["cURL","JavaScript"]}>
|
|
||||||
|
|
||||||
<Request value={"cURL"}>
|
|
||||||
|
|
||||||
```bash
|
|
||||||
curl -X POST "http://localhost:3000/api/application.generateSSHKey" \
|
|
||||||
-d '{
|
|
||||||
"applicationId": "string"
|
|
||||||
}'
|
|
||||||
```
|
|
||||||
|
|
||||||
</Request>
|
|
||||||
|
|
||||||
<Request value={"JavaScript"}>
|
|
||||||
|
|
||||||
```js
|
|
||||||
fetch("http://localhost:3000/api/application.generateSSHKey", {
|
|
||||||
method: "POST"
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
</Request>
|
|
||||||
|
|
||||||
</Requests>
|
|
||||||
|
|
||||||
<Responses items={["default"]}>
|
|
||||||
|
|
||||||
<Response value={"default"}>
|
|
||||||
|
|
||||||
<ResponseTypes>
|
|
||||||
|
|
||||||
<ExampleResponse>
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"message": "string",
|
|
||||||
"code": "string",
|
|
||||||
"issues": [
|
|
||||||
{
|
|
||||||
"message": "string"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
</ExampleResponse>
|
|
||||||
|
|
||||||
<TypeScriptResponse>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
export interface Response {
|
|
||||||
message: string;
|
|
||||||
code: string;
|
|
||||||
issues?: {
|
|
||||||
message: string;
|
|
||||||
}[];
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
</TypeScriptResponse>
|
|
||||||
|
|
||||||
</ResponseTypes>
|
|
||||||
|
|
||||||
</Response>
|
|
||||||
|
|
||||||
</Responses>
|
|
||||||
|
|
||||||
</APIExample>
|
|
||||||
|
|
||||||
</API>
|
|
||||||
|
|
||||||
<API>
|
|
||||||
|
|
||||||
<APIInfo method={"POST"} route={"/application.removeSSHKey"}>
|
|
||||||
|
|
||||||
## application-removeSSHKey
|
|
||||||
|
|
||||||
### Authorization
|
|
||||||
|
|
||||||
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
|
||||||
|
|
||||||
In: `header`
|
|
||||||
|
|
||||||
</Property>
|
|
||||||
|
|
||||||
### Request Body
|
|
||||||
|
|
||||||
<Property name={"applicationId"} type={"string"} required={true} deprecated={undefined}>
|
|
||||||
|
|
||||||
</Property>
|
|
||||||
|
|
||||||
| Status code | Description |
|
|
||||||
| ----------- | ----------- |
|
|
||||||
| `200` | Successful response |
|
|
||||||
| `default` | Error response |
|
|
||||||
|
|
||||||
</APIInfo>
|
|
||||||
|
|
||||||
<APIExample>
|
|
||||||
|
|
||||||
<Requests items={["cURL","JavaScript"]}>
|
|
||||||
|
|
||||||
<Request value={"cURL"}>
|
|
||||||
|
|
||||||
```bash
|
|
||||||
curl -X POST "http://localhost:3000/api/application.removeSSHKey" \
|
|
||||||
-d '{
|
|
||||||
"applicationId": "string"
|
|
||||||
}'
|
|
||||||
```
|
|
||||||
|
|
||||||
</Request>
|
|
||||||
|
|
||||||
<Request value={"JavaScript"}>
|
|
||||||
|
|
||||||
```js
|
|
||||||
fetch("http://localhost:3000/api/application.removeSSHKey", {
|
|
||||||
method: "POST"
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
</Request>
|
|
||||||
|
|
||||||
</Requests>
|
|
||||||
|
|
||||||
<Responses items={["default"]}>
|
|
||||||
|
|
||||||
<Response value={"default"}>
|
|
||||||
|
|
||||||
<ResponseTypes>
|
|
||||||
|
|
||||||
<ExampleResponse>
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"message": "string",
|
|
||||||
"code": "string",
|
|
||||||
"issues": [
|
|
||||||
{
|
|
||||||
"message": "string"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
</ExampleResponse>
|
|
||||||
|
|
||||||
<TypeScriptResponse>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
export interface Response {
|
|
||||||
message: string;
|
|
||||||
code: string;
|
|
||||||
issues?: {
|
|
||||||
message: string;
|
|
||||||
}[];
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
</TypeScriptResponse>
|
|
||||||
|
|
||||||
</ResponseTypes>
|
|
||||||
|
|
||||||
</Response>
|
|
||||||
|
|
||||||
</Responses>
|
|
||||||
|
|
||||||
</APIExample>
|
|
||||||
|
|
||||||
</API>
|
|
||||||
|
|
||||||
<API>
|
|
||||||
|
|
||||||
<APIInfo method={"POST"} route={"/application.markRunning"}>
|
<APIInfo method={"POST"} route={"/application.markRunning"}>
|
||||||
|
|
||||||
## application-markRunning
|
## application-markRunning
|
||||||
@@ -1633,6 +1718,10 @@ In: `header`
|
|||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"buildArgs"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
<Property name={"memoryReservation"} type={"number | null"} required={false} deprecated={undefined}>
|
<Property name={"memoryReservation"} type={"number | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
@@ -1695,6 +1784,46 @@ In: `header`
|
|||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"gitlabProjectId"} type={"number | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"gitlabRepository"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"gitlabOwner"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"gitlabBranch"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"gitlabBuildPath"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"gitlabPathNamespace"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"bitbucketRepository"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"bitbucketOwner"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"bitbucketBranch"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"bitbucketBuildPath"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
<Property name={"username"} type={"string | null"} required={false} deprecated={undefined}>
|
<Property name={"username"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
@@ -1719,7 +1848,7 @@ In: `header`
|
|||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
<Property name={"customGitSSHKey"} type={"string | null"} required={false} deprecated={undefined}>
|
<Property name={"customGitSSHKeyId"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
@@ -1727,11 +1856,19 @@ In: `header`
|
|||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"dockerContextPath"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"dropBuildPath"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
<Property name={"healthCheckSwarm"} type={"object | null"} required={false} deprecated={undefined}>
|
<Property name={"healthCheckSwarm"} type={"object | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
<ObjectCollapsible name={"healthCheckSwarm"}>
|
<ObjectCollapsible name={"healthCheckSwarm"}>
|
||||||
|
|
||||||
<Property name={"Test"} type={"array of string"} required={false} deprecated={undefined}>
|
<Property name={"Test"} type={"array<string>"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
@@ -1783,13 +1920,13 @@ In: `header`
|
|||||||
|
|
||||||
<ObjectCollapsible name={"placementSwarm"}>
|
<ObjectCollapsible name={"placementSwarm"}>
|
||||||
|
|
||||||
<Property name={"Constraints"} type={"array of string"} required={false} deprecated={undefined}>
|
<Property name={"Constraints"} type={"array<string>"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
<Property name={"Preferences"} type={"array of object"} required={false} deprecated={undefined}>
|
<Property name={"Preferences"} type={"array<object>"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
<ObjectCollapsible name={"Preferences"}>
|
<ObjectCollapsible name={"Object 1"}>
|
||||||
|
|
||||||
<Property name={"Spread"} type={"object"} required={true} deprecated={undefined}>
|
<Property name={"Spread"} type={"object"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
@@ -1811,9 +1948,9 @@ In: `header`
|
|||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
<Property name={"Platforms"} type={"array of object"} required={false} deprecated={undefined}>
|
<Property name={"Platforms"} type={"array<object>"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
<ObjectCollapsible name={"Platforms"}>
|
<ObjectCollapsible name={"Object 1"}>
|
||||||
|
|
||||||
<Property name={"Architecture"} type={"string"} required={true} deprecated={undefined}>
|
<Property name={"Architecture"} type={"string"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
@@ -1959,15 +2096,15 @@ In: `header`
|
|||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
<Property name={"networkSwarm"} type={"array of object | null"} required={false} deprecated={undefined}>
|
<Property name={"networkSwarm"} type={"array<object> | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
<ObjectCollapsible name={"networkSwarm"}>
|
<ObjectCollapsible name={"Object 1"}>
|
||||||
|
|
||||||
<Property name={"Target"} type={"string"} required={false} deprecated={undefined}>
|
<Property name={"Target"} type={"string"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
<Property name={"Aliases"} type={"array of string"} required={false} deprecated={undefined}>
|
<Property name={"Aliases"} type={"array<string>"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
@@ -1995,7 +2132,11 @@ In: `header`
|
|||||||
|
|
||||||
<Property name={"buildType"} type={"string"} required={false} deprecated={undefined}>
|
<Property name={"buildType"} type={"string"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
<span>Value in: `"dockerfile" | "heroku_buildpacks" | "paketo_buildpacks" | "nixpacks"`</span>
|
<span>Value in: `"dockerfile" | "heroku_buildpacks" | "paketo_buildpacks" | "nixpacks" | "static"`</span>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"publishDirectory"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
@@ -2011,6 +2152,18 @@ In: `header`
|
|||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"githubId"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"gitlabId"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"bitbucketId"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
| Status code | Description |
|
| Status code | Description |
|
||||||
| ----------- | ----------- |
|
| ----------- | ----------- |
|
||||||
| `200` | Successful response |
|
| `200` | Successful response |
|
||||||
@@ -2032,6 +2185,7 @@ curl -X POST "http://localhost:3000/api/application.update" \
|
|||||||
"appName": "string",
|
"appName": "string",
|
||||||
"description": "string",
|
"description": "string",
|
||||||
"env": "string",
|
"env": "string",
|
||||||
|
"buildArgs": "string",
|
||||||
"memoryReservation": 0,
|
"memoryReservation": 0,
|
||||||
"memoryLimit": 0,
|
"memoryLimit": 0,
|
||||||
"cpuReservation": 0,
|
"cpuReservation": 0,
|
||||||
@@ -2047,14 +2201,26 @@ curl -X POST "http://localhost:3000/api/application.update" \
|
|||||||
"branch": "string",
|
"branch": "string",
|
||||||
"buildPath": "string",
|
"buildPath": "string",
|
||||||
"autoDeploy": true,
|
"autoDeploy": true,
|
||||||
|
"gitlabProjectId": 0,
|
||||||
|
"gitlabRepository": "string",
|
||||||
|
"gitlabOwner": "string",
|
||||||
|
"gitlabBranch": "string",
|
||||||
|
"gitlabBuildPath": "string",
|
||||||
|
"gitlabPathNamespace": "string",
|
||||||
|
"bitbucketRepository": "string",
|
||||||
|
"bitbucketOwner": "string",
|
||||||
|
"bitbucketBranch": "string",
|
||||||
|
"bitbucketBuildPath": "string",
|
||||||
"username": "string",
|
"username": "string",
|
||||||
"password": "string",
|
"password": "string",
|
||||||
"dockerImage": "string",
|
"dockerImage": "string",
|
||||||
"customGitUrl": "string",
|
"customGitUrl": "string",
|
||||||
"customGitBranch": "string",
|
"customGitBranch": "string",
|
||||||
"customGitBuildPath": "string",
|
"customGitBuildPath": "string",
|
||||||
"customGitSSHKey": "string",
|
"customGitSSHKeyId": "string",
|
||||||
"dockerfile": "string",
|
"dockerfile": "string",
|
||||||
|
"dockerContextPath": "string",
|
||||||
|
"dropBuildPath": "string",
|
||||||
"healthCheckSwarm": {
|
"healthCheckSwarm": {
|
||||||
"Test": [
|
"Test": [
|
||||||
"string"
|
"string"
|
||||||
@@ -2132,9 +2298,13 @@ curl -X POST "http://localhost:3000/api/application.update" \
|
|||||||
"replicas": 0,
|
"replicas": 0,
|
||||||
"applicationStatus": "idle",
|
"applicationStatus": "idle",
|
||||||
"buildType": "dockerfile",
|
"buildType": "dockerfile",
|
||||||
|
"publishDirectory": "string",
|
||||||
"createdAt": "string",
|
"createdAt": "string",
|
||||||
"registryId": "string",
|
"registryId": "string",
|
||||||
"projectId": "string"
|
"projectId": "string",
|
||||||
|
"githubId": "string",
|
||||||
|
"gitlabId": "string",
|
||||||
|
"bitbucketId": "string"
|
||||||
}'
|
}'
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
779
apps/docs/content/docs/api/reference-api/reference-bitbucket.mdx
Normal file
779
apps/docs/content/docs/api/reference-api/reference-bitbucket.mdx
Normal file
@@ -0,0 +1,779 @@
|
|||||||
|
---
|
||||||
|
title: bitbucket
|
||||||
|
full: true
|
||||||
|
---
|
||||||
|
|
||||||
|
import { Root, API, APIInfo, APIExample, Responses, Response, ResponseTypes, ExampleResponse, TypeScriptResponse, Property, ObjectCollapsible, Requests, Request } from "fumadocs-ui/components/api";
|
||||||
|
|
||||||
|
<Root>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"POST"} route={"/bitbucket.create"}>
|
||||||
|
|
||||||
|
## bitbucket-create
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
### Request Body
|
||||||
|
|
||||||
|
<Property name={"bitbucketId"} type={"string"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"bitbucketUsername"} type={"string"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"appPassword"} type={"string"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"bitbucketWorkspaceName"} type={"string"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"gitProviderId"} type={"string"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"authId"} type={"string"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
<span>Minimum length: `1`</span>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"name"} type={"string"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
<span>Minimum length: `1`</span>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X POST "http://localhost:3000/api/bitbucket.create" \
|
||||||
|
-d '{
|
||||||
|
"bitbucketId": "string",
|
||||||
|
"bitbucketUsername": "string",
|
||||||
|
"appPassword": "string",
|
||||||
|
"bitbucketWorkspaceName": "string",
|
||||||
|
"gitProviderId": "string",
|
||||||
|
"authId": "string",
|
||||||
|
"name": "string"
|
||||||
|
}'
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/bitbucket.create", {
|
||||||
|
method: "POST"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"GET"} route={"/bitbucket.one"}>
|
||||||
|
|
||||||
|
## bitbucket-one
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
### Query Parameters
|
||||||
|
|
||||||
|
<Property name={"bitbucketId"} type={"string"} required={true} deprecated={false}>
|
||||||
|
|
||||||
|
<span>Minimum length: `1`</span>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X GET "http://localhost:3000/api/bitbucket.one?bitbucketId=string"
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/bitbucket.one?bitbucketId=string", {
|
||||||
|
method: "GET"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"GET"} route={"/bitbucket.bitbucketProviders"}>
|
||||||
|
|
||||||
|
## bitbucket-bitbucketProviders
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X GET "http://localhost:3000/api/bitbucket.bitbucketProviders"
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/bitbucket.bitbucketProviders", {
|
||||||
|
method: "GET"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"GET"} route={"/bitbucket.getBitbucketRepositories"}>
|
||||||
|
|
||||||
|
## bitbucket-getBitbucketRepositories
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
### Query Parameters
|
||||||
|
|
||||||
|
<Property name={"bitbucketId"} type={"string"} required={true} deprecated={false}>
|
||||||
|
|
||||||
|
<span>Minimum length: `1`</span>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X GET "http://localhost:3000/api/bitbucket.getBitbucketRepositories?bitbucketId=string"
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/bitbucket.getBitbucketRepositories?bitbucketId=string", {
|
||||||
|
method: "GET"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"GET"} route={"/bitbucket.getBitbucketBranches"}>
|
||||||
|
|
||||||
|
## bitbucket-getBitbucketBranches
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
### Query Parameters
|
||||||
|
|
||||||
|
<Property name={"owner"} type={"string"} required={true} deprecated={false}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"repo"} type={"string"} required={true} deprecated={false}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"bitbucketId"} type={"string"} required={false} deprecated={false}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X GET "http://localhost:3000/api/bitbucket.getBitbucketBranches?owner=string&repo=string&bitbucketId=string"
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/bitbucket.getBitbucketBranches?owner=string&repo=string&bitbucketId=string", {
|
||||||
|
method: "GET"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"POST"} route={"/bitbucket.testConnection"}>
|
||||||
|
|
||||||
|
## bitbucket-testConnection
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
### Request Body
|
||||||
|
|
||||||
|
<Property name={"bitbucketId"} type={"string"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
<span>Minimum length: `1`</span>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"bitbucketUsername"} type={"string"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"workspaceName"} type={"string"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X POST "http://localhost:3000/api/bitbucket.testConnection" \
|
||||||
|
-d '{
|
||||||
|
"bitbucketId": "string",
|
||||||
|
"bitbucketUsername": "string",
|
||||||
|
"workspaceName": "string"
|
||||||
|
}'
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/bitbucket.testConnection", {
|
||||||
|
method: "POST"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"POST"} route={"/bitbucket.update"}>
|
||||||
|
|
||||||
|
## bitbucket-update
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
### Request Body
|
||||||
|
|
||||||
|
<Property name={"bitbucketId"} type={"string"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
<span>Minimum length: `1`</span>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"bitbucketUsername"} type={"string"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"appPassword"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"bitbucketWorkspaceName"} type={"string"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"gitProviderId"} type={"string"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"name"} type={"string"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
<span>Minimum length: `1`</span>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X POST "http://localhost:3000/api/bitbucket.update" \
|
||||||
|
-d '{
|
||||||
|
"bitbucketId": "string",
|
||||||
|
"bitbucketUsername": "string",
|
||||||
|
"appPassword": "string",
|
||||||
|
"bitbucketWorkspaceName": "string",
|
||||||
|
"gitProviderId": "string",
|
||||||
|
"name": "string"
|
||||||
|
}'
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/bitbucket.update", {
|
||||||
|
method: "POST"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
</Root>
|
||||||
@@ -278,7 +278,7 @@ In: `header`
|
|||||||
|
|
||||||
<Property name={"sourceType"} type={"string"} required={false} deprecated={undefined}>
|
<Property name={"sourceType"} type={"string"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
<span>Value in: `"git" | "github" | "raw"`</span>
|
<span>Value in: `"git" | "github" | "gitlab" | "bitbucket" | "raw"`</span>
|
||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
@@ -304,6 +304,38 @@ In: `header`
|
|||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"gitlabProjectId"} type={"number | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"gitlabRepository"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"gitlabOwner"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"gitlabBranch"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"gitlabPathNamespace"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"bitbucketRepository"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"bitbucketOwner"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"bitbucketBranch"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
<Property name={"customGitUrl"} type={"string | null"} required={false} deprecated={undefined}>
|
<Property name={"customGitUrl"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
@@ -312,7 +344,7 @@ In: `header`
|
|||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
<Property name={"customGitSSHKey"} type={"string | null"} required={false} deprecated={undefined}>
|
<Property name={"customGitSSHKeyId"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
@@ -340,6 +372,18 @@ In: `header`
|
|||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"githubId"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"gitlabId"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"bitbucketId"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
| Status code | Description |
|
| Status code | Description |
|
||||||
| ----------- | ----------- |
|
| ----------- | ----------- |
|
||||||
| `200` | Successful response |
|
| `200` | Successful response |
|
||||||
@@ -369,14 +413,25 @@ curl -X POST "http://localhost:3000/api/compose.update" \
|
|||||||
"owner": "string",
|
"owner": "string",
|
||||||
"branch": "string",
|
"branch": "string",
|
||||||
"autoDeploy": true,
|
"autoDeploy": true,
|
||||||
|
"gitlabProjectId": 0,
|
||||||
|
"gitlabRepository": "string",
|
||||||
|
"gitlabOwner": "string",
|
||||||
|
"gitlabBranch": "string",
|
||||||
|
"gitlabPathNamespace": "string",
|
||||||
|
"bitbucketRepository": "string",
|
||||||
|
"bitbucketOwner": "string",
|
||||||
|
"bitbucketBranch": "string",
|
||||||
"customGitUrl": "string",
|
"customGitUrl": "string",
|
||||||
"customGitBranch": "string",
|
"customGitBranch": "string",
|
||||||
"customGitSSHKey": "string",
|
"customGitSSHKeyId": "string",
|
||||||
"command": "string",
|
"command": "string",
|
||||||
"composePath": "string",
|
"composePath": "string",
|
||||||
"composeStatus": "idle",
|
"composeStatus": "idle",
|
||||||
"projectId": "string",
|
"projectId": "string",
|
||||||
"createdAt": "string"
|
"createdAt": "string",
|
||||||
|
"githubId": "string",
|
||||||
|
"gitlabId": "string",
|
||||||
|
"bitbucketId": "string"
|
||||||
}'
|
}'
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -646,9 +701,9 @@ export interface Response {
|
|||||||
|
|
||||||
<API>
|
<API>
|
||||||
|
|
||||||
<APIInfo method={"GET"} route={"/compose.allServices"}>
|
<APIInfo method={"GET"} route={"/compose.loadServices"}>
|
||||||
|
|
||||||
## compose-allServices
|
## compose-loadServices
|
||||||
|
|
||||||
### Authorization
|
### Authorization
|
||||||
|
|
||||||
@@ -666,6 +721,111 @@ In: `header`
|
|||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"type"} type={"Any properties in not unknown, string"} required={false} deprecated={false}>
|
||||||
|
|
||||||
|
<span>Default: `"cache"`</span>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X GET "http://localhost:3000/api/compose.loadServices?composeId=string&type=cache"
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/compose.loadServices?composeId=string&type=cache", {
|
||||||
|
method: "GET"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"POST"} route={"/compose.fetchSourceType"}>
|
||||||
|
|
||||||
|
## compose-fetchSourceType
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
### Request Body
|
||||||
|
|
||||||
|
<Property name={"composeId"} type={"string"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
<span>Minimum length: `1`</span>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
| Status code | Description |
|
| Status code | Description |
|
||||||
| ----------- | ----------- |
|
| ----------- | ----------- |
|
||||||
| `200` | Successful response |
|
| `200` | Successful response |
|
||||||
@@ -680,7 +840,10 @@ In: `header`
|
|||||||
<Request value={"cURL"}>
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
curl -X GET "http://localhost:3000/api/compose.allServices?composeId=string"
|
curl -X POST "http://localhost:3000/api/compose.fetchSourceType" \
|
||||||
|
-d '{
|
||||||
|
"composeId": "string"
|
||||||
|
}'
|
||||||
```
|
```
|
||||||
|
|
||||||
</Request>
|
</Request>
|
||||||
@@ -688,8 +851,8 @@ curl -X GET "http://localhost:3000/api/compose.allServices?composeId=string"
|
|||||||
<Request value={"JavaScript"}>
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
```js
|
```js
|
||||||
fetch("http://localhost:3000/api/compose.allServices?composeId=string", {
|
fetch("http://localhost:3000/api/compose.fetchSourceType", {
|
||||||
method: "GET"
|
method: "POST"
|
||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -852,6 +1015,105 @@ export interface Response {
|
|||||||
|
|
||||||
<API>
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"GET"} route={"/compose.getConvertedCompose"}>
|
||||||
|
|
||||||
|
## compose-getConvertedCompose
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
### Query Parameters
|
||||||
|
|
||||||
|
<Property name={"composeId"} type={"string"} required={true} deprecated={false}>
|
||||||
|
|
||||||
|
<span>Minimum length: `1`</span>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X GET "http://localhost:3000/api/compose.getConvertedCompose?composeId=string"
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/compose.getConvertedCompose?composeId=string", {
|
||||||
|
method: "GET"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
<APIInfo method={"POST"} route={"/compose.deploy"}>
|
<APIInfo method={"POST"} route={"/compose.deploy"}>
|
||||||
|
|
||||||
## compose-deploy
|
## compose-deploy
|
||||||
@@ -1257,108 +1519,6 @@ export interface Response {
|
|||||||
|
|
||||||
<API>
|
<API>
|
||||||
|
|
||||||
<APIInfo method={"POST"} route={"/compose.generateSSHKey"}>
|
|
||||||
|
|
||||||
## compose-generateSSHKey
|
|
||||||
|
|
||||||
### Authorization
|
|
||||||
|
|
||||||
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
|
||||||
|
|
||||||
In: `header`
|
|
||||||
|
|
||||||
</Property>
|
|
||||||
|
|
||||||
### Request Body
|
|
||||||
|
|
||||||
<Property name={"composeId"} type={"string"} required={true} deprecated={undefined}>
|
|
||||||
|
|
||||||
<span>Minimum length: `1`</span>
|
|
||||||
|
|
||||||
</Property>
|
|
||||||
|
|
||||||
| Status code | Description |
|
|
||||||
| ----------- | ----------- |
|
|
||||||
| `200` | Successful response |
|
|
||||||
| `default` | Error response |
|
|
||||||
|
|
||||||
</APIInfo>
|
|
||||||
|
|
||||||
<APIExample>
|
|
||||||
|
|
||||||
<Requests items={["cURL","JavaScript"]}>
|
|
||||||
|
|
||||||
<Request value={"cURL"}>
|
|
||||||
|
|
||||||
```bash
|
|
||||||
curl -X POST "http://localhost:3000/api/compose.generateSSHKey" \
|
|
||||||
-d '{
|
|
||||||
"composeId": "string"
|
|
||||||
}'
|
|
||||||
```
|
|
||||||
|
|
||||||
</Request>
|
|
||||||
|
|
||||||
<Request value={"JavaScript"}>
|
|
||||||
|
|
||||||
```js
|
|
||||||
fetch("http://localhost:3000/api/compose.generateSSHKey", {
|
|
||||||
method: "POST"
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
</Request>
|
|
||||||
|
|
||||||
</Requests>
|
|
||||||
|
|
||||||
<Responses items={["default"]}>
|
|
||||||
|
|
||||||
<Response value={"default"}>
|
|
||||||
|
|
||||||
<ResponseTypes>
|
|
||||||
|
|
||||||
<ExampleResponse>
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"message": "string",
|
|
||||||
"code": "string",
|
|
||||||
"issues": [
|
|
||||||
{
|
|
||||||
"message": "string"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
</ExampleResponse>
|
|
||||||
|
|
||||||
<TypeScriptResponse>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
export interface Response {
|
|
||||||
message: string;
|
|
||||||
code: string;
|
|
||||||
issues?: {
|
|
||||||
message: string;
|
|
||||||
}[];
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
</TypeScriptResponse>
|
|
||||||
|
|
||||||
</ResponseTypes>
|
|
||||||
|
|
||||||
</Response>
|
|
||||||
|
|
||||||
</Responses>
|
|
||||||
|
|
||||||
</APIExample>
|
|
||||||
|
|
||||||
</API>
|
|
||||||
|
|
||||||
<API>
|
|
||||||
|
|
||||||
<APIInfo method={"POST"} route={"/compose.refreshToken"}>
|
<APIInfo method={"POST"} route={"/compose.refreshToken"}>
|
||||||
|
|
||||||
## compose-refreshToken
|
## compose-refreshToken
|
||||||
@@ -1461,108 +1621,6 @@ export interface Response {
|
|||||||
|
|
||||||
<API>
|
<API>
|
||||||
|
|
||||||
<APIInfo method={"POST"} route={"/compose.removeSSHKey"}>
|
|
||||||
|
|
||||||
## compose-removeSSHKey
|
|
||||||
|
|
||||||
### Authorization
|
|
||||||
|
|
||||||
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
|
||||||
|
|
||||||
In: `header`
|
|
||||||
|
|
||||||
</Property>
|
|
||||||
|
|
||||||
### Request Body
|
|
||||||
|
|
||||||
<Property name={"composeId"} type={"string"} required={true} deprecated={undefined}>
|
|
||||||
|
|
||||||
<span>Minimum length: `1`</span>
|
|
||||||
|
|
||||||
</Property>
|
|
||||||
|
|
||||||
| Status code | Description |
|
|
||||||
| ----------- | ----------- |
|
|
||||||
| `200` | Successful response |
|
|
||||||
| `default` | Error response |
|
|
||||||
|
|
||||||
</APIInfo>
|
|
||||||
|
|
||||||
<APIExample>
|
|
||||||
|
|
||||||
<Requests items={["cURL","JavaScript"]}>
|
|
||||||
|
|
||||||
<Request value={"cURL"}>
|
|
||||||
|
|
||||||
```bash
|
|
||||||
curl -X POST "http://localhost:3000/api/compose.removeSSHKey" \
|
|
||||||
-d '{
|
|
||||||
"composeId": "string"
|
|
||||||
}'
|
|
||||||
```
|
|
||||||
|
|
||||||
</Request>
|
|
||||||
|
|
||||||
<Request value={"JavaScript"}>
|
|
||||||
|
|
||||||
```js
|
|
||||||
fetch("http://localhost:3000/api/compose.removeSSHKey", {
|
|
||||||
method: "POST"
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
</Request>
|
|
||||||
|
|
||||||
</Requests>
|
|
||||||
|
|
||||||
<Responses items={["default"]}>
|
|
||||||
|
|
||||||
<Response value={"default"}>
|
|
||||||
|
|
||||||
<ResponseTypes>
|
|
||||||
|
|
||||||
<ExampleResponse>
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"message": "string",
|
|
||||||
"code": "string",
|
|
||||||
"issues": [
|
|
||||||
{
|
|
||||||
"message": "string"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
</ExampleResponse>
|
|
||||||
|
|
||||||
<TypeScriptResponse>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
export interface Response {
|
|
||||||
message: string;
|
|
||||||
code: string;
|
|
||||||
issues?: {
|
|
||||||
message: string;
|
|
||||||
}[];
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
</TypeScriptResponse>
|
|
||||||
|
|
||||||
</ResponseTypes>
|
|
||||||
|
|
||||||
</Response>
|
|
||||||
|
|
||||||
</Responses>
|
|
||||||
|
|
||||||
</APIExample>
|
|
||||||
|
|
||||||
</API>
|
|
||||||
|
|
||||||
<API>
|
|
||||||
|
|
||||||
<APIInfo method={"POST"} route={"/compose.deployTemplate"}>
|
<APIInfo method={"POST"} route={"/compose.deployTemplate"}>
|
||||||
|
|
||||||
## compose-deployTemplate
|
## compose-deployTemplate
|
||||||
@@ -1759,4 +1817,95 @@ export interface Response {
|
|||||||
|
|
||||||
</API>
|
</API>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"GET"} route={"/compose.getTags"}>
|
||||||
|
|
||||||
|
## compose-getTags
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X GET "http://localhost:3000/api/compose.getTags"
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/compose.getTags", {
|
||||||
|
method: "GET"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
</Root>
|
</Root>
|
||||||
@@ -213,6 +213,10 @@ In: `header`
|
|||||||
|
|
||||||
### Query Parameters
|
### Query Parameters
|
||||||
|
|
||||||
|
<Property name={"appType"} type={"Any properties in string, string"} required={false} deprecated={false}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
<Property name={"appName"} type={"string"} required={true} deprecated={false}>
|
<Property name={"appName"} type={"string"} required={true} deprecated={false}>
|
||||||
|
|
||||||
<span>Minimum length: `1`</span>
|
<span>Minimum length: `1`</span>
|
||||||
@@ -233,7 +237,7 @@ In: `header`
|
|||||||
<Request value={"cURL"}>
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
curl -X GET "http://localhost:3000/api/docker.getContainersByAppNameMatch?appName=string"
|
curl -X GET "http://localhost:3000/api/docker.getContainersByAppNameMatch?appType=stack&appName=string"
|
||||||
```
|
```
|
||||||
|
|
||||||
</Request>
|
</Request>
|
||||||
@@ -241,7 +245,7 @@ curl -X GET "http://localhost:3000/api/docker.getContainersByAppNameMatch?appNam
|
|||||||
<Request value={"JavaScript"}>
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
```js
|
```js
|
||||||
fetch("http://localhost:3000/api/docker.getContainersByAppNameMatch?appName=string", {
|
fetch("http://localhost:3000/api/docker.getContainersByAppNameMatch?appType=stack&appName=string", {
|
||||||
method: "GET"
|
method: "GET"
|
||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -29,30 +29,48 @@ In: `header`
|
|||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
<Property name={"path"} type={"string | null"} required={true} deprecated={undefined}>
|
<Property name={"path"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
<span>Minimum length: `1`</span>
|
<span>Minimum length: `1`</span>
|
||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
<Property name={"port"} type={"number | null"} required={true} deprecated={undefined}>
|
<Property name={"port"} type={"number | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
<span>Minimum: `1`</span>
|
||||||
|
|
||||||
|
<span>Maximum: `65535`</span>
|
||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
<Property name={"https"} type={"boolean"} required={true} deprecated={undefined}>
|
<Property name={"https"} type={"boolean"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
<Property name={"applicationId"} type={"string"} required={true} deprecated={undefined}>
|
<Property name={"applicationId"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
<Property name={"certificateType"} type={"string"} required={true} deprecated={undefined}>
|
<Property name={"certificateType"} type={"string"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
<span>Value in: `"letsencrypt" | "none"`</span>
|
<span>Value in: `"letsencrypt" | "none"`</span>
|
||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"composeId"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"serviceName"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"domainType"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
<span>Value in: `"compose" | "application"`</span>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
| Status code | Description |
|
| Status code | Description |
|
||||||
| ----------- | ----------- |
|
| ----------- | ----------- |
|
||||||
| `200` | Successful response |
|
| `200` | Successful response |
|
||||||
@@ -71,10 +89,13 @@ curl -X POST "http://localhost:3000/api/domain.create" \
|
|||||||
-d '{
|
-d '{
|
||||||
"host": "string",
|
"host": "string",
|
||||||
"path": "string",
|
"path": "string",
|
||||||
"port": 0,
|
"port": 1,
|
||||||
"https": true,
|
"https": true,
|
||||||
"applicationId": "string",
|
"applicationId": "string",
|
||||||
"certificateType": "letsencrypt"
|
"certificateType": "letsencrypt",
|
||||||
|
"composeId": "string",
|
||||||
|
"serviceName": "string",
|
||||||
|
"domainType": "compose"
|
||||||
}'
|
}'
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -237,9 +258,9 @@ export interface Response {
|
|||||||
|
|
||||||
<API>
|
<API>
|
||||||
|
|
||||||
<APIInfo method={"POST"} route={"/domain.generateDomain"}>
|
<APIInfo method={"GET"} route={"/domain.byComposeId"}>
|
||||||
|
|
||||||
## domain-generateDomain
|
## domain-byComposeId
|
||||||
|
|
||||||
### Authorization
|
### Authorization
|
||||||
|
|
||||||
@@ -249,9 +270,11 @@ In: `header`
|
|||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
### Request Body
|
### Query Parameters
|
||||||
|
|
||||||
<Property name={"applicationId"} type={"string"} required={true} deprecated={undefined}>
|
<Property name={"composeId"} type={"string"} required={true} deprecated={false}>
|
||||||
|
|
||||||
|
<span>Minimum length: `1`</span>
|
||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
@@ -269,10 +292,7 @@ In: `header`
|
|||||||
<Request value={"cURL"}>
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
curl -X POST "http://localhost:3000/api/domain.generateDomain" \
|
curl -X GET "http://localhost:3000/api/domain.byComposeId?composeId=string"
|
||||||
-d '{
|
|
||||||
"applicationId": "string"
|
|
||||||
}'
|
|
||||||
```
|
```
|
||||||
|
|
||||||
</Request>
|
</Request>
|
||||||
@@ -280,8 +300,8 @@ curl -X POST "http://localhost:3000/api/domain.generateDomain" \
|
|||||||
<Request value={"JavaScript"}>
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
```js
|
```js
|
||||||
fetch("http://localhost:3000/api/domain.generateDomain", {
|
fetch("http://localhost:3000/api/domain.byComposeId?composeId=string", {
|
||||||
method: "POST"
|
method: "GET"
|
||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -337,9 +357,9 @@ export interface Response {
|
|||||||
|
|
||||||
<API>
|
<API>
|
||||||
|
|
||||||
<APIInfo method={"POST"} route={"/domain.generateWildcard"}>
|
<APIInfo method={"POST"} route={"/domain.generateDomain"}>
|
||||||
|
|
||||||
## domain-generateWildcard
|
## domain-generateDomain
|
||||||
|
|
||||||
### Authorization
|
### Authorization
|
||||||
|
|
||||||
@@ -351,7 +371,9 @@ In: `header`
|
|||||||
|
|
||||||
### Request Body
|
### Request Body
|
||||||
|
|
||||||
<Property name={"applicationId"} type={"string"} required={true} deprecated={undefined}>
|
<Property name={"appName"} type={"string"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
<span>Minimum length: `1`</span>
|
||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
@@ -369,9 +391,9 @@ In: `header`
|
|||||||
<Request value={"cURL"}>
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
curl -X POST "http://localhost:3000/api/domain.generateWildcard" \
|
curl -X POST "http://localhost:3000/api/domain.generateDomain" \
|
||||||
-d '{
|
-d '{
|
||||||
"applicationId": "string"
|
"appName": "string"
|
||||||
}'
|
}'
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -380,7 +402,7 @@ curl -X POST "http://localhost:3000/api/domain.generateWildcard" \
|
|||||||
<Request value={"JavaScript"}>
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
```js
|
```js
|
||||||
fetch("http://localhost:3000/api/domain.generateWildcard", {
|
fetch("http://localhost:3000/api/domain.generateDomain", {
|
||||||
method: "POST"
|
method: "POST"
|
||||||
});
|
});
|
||||||
```
|
```
|
||||||
@@ -451,38 +473,50 @@ In: `header`
|
|||||||
|
|
||||||
### Request Body
|
### Request Body
|
||||||
|
|
||||||
<Property name={"domainId"} type={"string"} required={true} deprecated={undefined}>
|
|
||||||
|
|
||||||
<span>Minimum length: `1`</span>
|
|
||||||
|
|
||||||
</Property>
|
|
||||||
|
|
||||||
<Property name={"host"} type={"string"} required={true} deprecated={undefined}>
|
<Property name={"host"} type={"string"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
<span>Minimum length: `1`</span>
|
<span>Minimum length: `1`</span>
|
||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
<Property name={"path"} type={"string | null"} required={true} deprecated={undefined}>
|
<Property name={"path"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
<span>Minimum length: `1`</span>
|
<span>Minimum length: `1`</span>
|
||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
<Property name={"port"} type={"number | null"} required={true} deprecated={undefined}>
|
<Property name={"port"} type={"number | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
<span>Minimum: `1`</span>
|
||||||
|
|
||||||
|
<span>Maximum: `65535`</span>
|
||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
<Property name={"https"} type={"boolean"} required={true} deprecated={undefined}>
|
<Property name={"https"} type={"boolean"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
<Property name={"certificateType"} type={"string"} required={true} deprecated={undefined}>
|
<Property name={"certificateType"} type={"string"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
<span>Value in: `"letsencrypt" | "none"`</span>
|
<span>Value in: `"letsencrypt" | "none"`</span>
|
||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"serviceName"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"domainType"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
<span>Value in: `"compose" | "application"`</span>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"domainId"} type={"string"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
| Status code | Description |
|
| Status code | Description |
|
||||||
| ----------- | ----------- |
|
| ----------- | ----------- |
|
||||||
| `200` | Successful response |
|
| `200` | Successful response |
|
||||||
@@ -499,12 +533,14 @@ In: `header`
|
|||||||
```bash
|
```bash
|
||||||
curl -X POST "http://localhost:3000/api/domain.update" \
|
curl -X POST "http://localhost:3000/api/domain.update" \
|
||||||
-d '{
|
-d '{
|
||||||
"domainId": "string",
|
|
||||||
"host": "string",
|
"host": "string",
|
||||||
"path": "string",
|
"path": "string",
|
||||||
"port": 0,
|
"port": 1,
|
||||||
"https": true,
|
"https": true,
|
||||||
"certificateType": "letsencrypt"
|
"certificateType": "letsencrypt",
|
||||||
|
"serviceName": "string",
|
||||||
|
"domainType": "compose",
|
||||||
|
"domainId": "string"
|
||||||
}'
|
}'
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -586,8 +622,6 @@ In: `header`
|
|||||||
|
|
||||||
<Property name={"domainId"} type={"string"} required={true} deprecated={false}>
|
<Property name={"domainId"} type={"string"} required={true} deprecated={false}>
|
||||||
|
|
||||||
<span>Minimum length: `1`</span>
|
|
||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
| Status code | Description |
|
| Status code | Description |
|
||||||
@@ -685,8 +719,6 @@ In: `header`
|
|||||||
|
|
||||||
<Property name={"domainId"} type={"string"} required={true} deprecated={undefined}>
|
<Property name={"domainId"} type={"string"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
<span>Minimum length: `1`</span>
|
|
||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
| Status code | Description |
|
| Status code | Description |
|
||||||
|
|||||||
@@ -0,0 +1,203 @@
|
|||||||
|
---
|
||||||
|
title: gitProvider
|
||||||
|
full: true
|
||||||
|
---
|
||||||
|
|
||||||
|
import { Root, API, APIInfo, APIExample, Responses, Response, ResponseTypes, ExampleResponse, TypeScriptResponse, Property, ObjectCollapsible, Requests, Request } from "fumadocs-ui/components/api";
|
||||||
|
|
||||||
|
<Root>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"GET"} route={"/gitProvider.getAll"}>
|
||||||
|
|
||||||
|
## gitProvider-getAll
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X GET "http://localhost:3000/api/gitProvider.getAll"
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/gitProvider.getAll", {
|
||||||
|
method: "GET"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"POST"} route={"/gitProvider.remove"}>
|
||||||
|
|
||||||
|
## gitProvider-remove
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
### Request Body
|
||||||
|
|
||||||
|
<Property name={"gitProviderId"} type={"string"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
<span>Minimum length: `1`</span>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X POST "http://localhost:3000/api/gitProvider.remove" \
|
||||||
|
-d '{
|
||||||
|
"gitProviderId": "string"
|
||||||
|
}'
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/gitProvider.remove", {
|
||||||
|
method: "POST"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
</Root>
|
||||||
661
apps/docs/content/docs/api/reference-api/reference-github.mdx
Normal file
661
apps/docs/content/docs/api/reference-api/reference-github.mdx
Normal file
@@ -0,0 +1,661 @@
|
|||||||
|
---
|
||||||
|
title: github
|
||||||
|
full: true
|
||||||
|
---
|
||||||
|
|
||||||
|
import { Root, API, APIInfo, APIExample, Responses, Response, ResponseTypes, ExampleResponse, TypeScriptResponse, Property, ObjectCollapsible, Requests, Request } from "fumadocs-ui/components/api";
|
||||||
|
|
||||||
|
<Root>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"GET"} route={"/github.one"}>
|
||||||
|
|
||||||
|
## github-one
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
### Query Parameters
|
||||||
|
|
||||||
|
<Property name={"githubId"} type={"string"} required={true} deprecated={false}>
|
||||||
|
|
||||||
|
<span>Minimum length: `1`</span>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X GET "http://localhost:3000/api/github.one?githubId=string"
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/github.one?githubId=string", {
|
||||||
|
method: "GET"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"GET"} route={"/github.getGithubRepositories"}>
|
||||||
|
|
||||||
|
## github-getGithubRepositories
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
### Query Parameters
|
||||||
|
|
||||||
|
<Property name={"githubId"} type={"string"} required={true} deprecated={false}>
|
||||||
|
|
||||||
|
<span>Minimum length: `1`</span>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X GET "http://localhost:3000/api/github.getGithubRepositories?githubId=string"
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/github.getGithubRepositories?githubId=string", {
|
||||||
|
method: "GET"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"GET"} route={"/github.getGithubBranches"}>
|
||||||
|
|
||||||
|
## github-getGithubBranches
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
### Query Parameters
|
||||||
|
|
||||||
|
<Property name={"repo"} type={"string"} required={true} deprecated={false}>
|
||||||
|
|
||||||
|
<span>Minimum length: `1`</span>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"owner"} type={"string"} required={true} deprecated={false}>
|
||||||
|
|
||||||
|
<span>Minimum length: `1`</span>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"githubId"} type={"string"} required={false} deprecated={false}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X GET "http://localhost:3000/api/github.getGithubBranches?repo=string&owner=string&githubId=string"
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/github.getGithubBranches?repo=string&owner=string&githubId=string", {
|
||||||
|
method: "GET"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"GET"} route={"/github.githubProviders"}>
|
||||||
|
|
||||||
|
## github-githubProviders
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X GET "http://localhost:3000/api/github.githubProviders"
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/github.githubProviders", {
|
||||||
|
method: "GET"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"POST"} route={"/github.testConnection"}>
|
||||||
|
|
||||||
|
## github-testConnection
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
### Request Body
|
||||||
|
|
||||||
|
<Property name={"githubId"} type={"string"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
<span>Minimum length: `1`</span>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X POST "http://localhost:3000/api/github.testConnection" \
|
||||||
|
-d '{
|
||||||
|
"githubId": "string"
|
||||||
|
}'
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/github.testConnection", {
|
||||||
|
method: "POST"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"POST"} route={"/github.update"}>
|
||||||
|
|
||||||
|
## github-update
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
### Request Body
|
||||||
|
|
||||||
|
<Property name={"githubId"} type={"string"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
<span>Minimum length: `1`</span>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"githubAppName"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"githubAppId"} type={"number | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"githubClientId"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"githubClientSecret"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"githubInstallationId"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"githubPrivateKey"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"githubWebhookSecret"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"gitProviderId"} type={"string"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
<span>Minimum length: `1`</span>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"name"} type={"string"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
<span>Minimum length: `1`</span>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X POST "http://localhost:3000/api/github.update" \
|
||||||
|
-d '{
|
||||||
|
"githubId": "string",
|
||||||
|
"githubAppName": "string",
|
||||||
|
"githubAppId": 0,
|
||||||
|
"githubClientId": "string",
|
||||||
|
"githubClientSecret": "string",
|
||||||
|
"githubInstallationId": "string",
|
||||||
|
"githubPrivateKey": "string",
|
||||||
|
"githubWebhookSecret": "string",
|
||||||
|
"gitProviderId": "string",
|
||||||
|
"name": "string"
|
||||||
|
}'
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/github.update", {
|
||||||
|
method: "POST"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
</Root>
|
||||||
816
apps/docs/content/docs/api/reference-api/reference-gitlab.mdx
Normal file
816
apps/docs/content/docs/api/reference-api/reference-gitlab.mdx
Normal file
@@ -0,0 +1,816 @@
|
|||||||
|
---
|
||||||
|
title: gitlab
|
||||||
|
full: true
|
||||||
|
---
|
||||||
|
|
||||||
|
import { Root, API, APIInfo, APIExample, Responses, Response, ResponseTypes, ExampleResponse, TypeScriptResponse, Property, ObjectCollapsible, Requests, Request } from "fumadocs-ui/components/api";
|
||||||
|
|
||||||
|
<Root>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"POST"} route={"/gitlab.create"}>
|
||||||
|
|
||||||
|
## gitlab-create
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
### Request Body
|
||||||
|
|
||||||
|
<Property name={"gitlabId"} type={"string"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"applicationId"} type={"string"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"redirectUri"} type={"string"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"secret"} type={"string"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"accessToken"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"refreshToken"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"groupName"} type={"string"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"expiresAt"} type={"number | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"gitProviderId"} type={"string"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"authId"} type={"string"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
<span>Minimum length: `1`</span>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"name"} type={"string"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
<span>Minimum length: `1`</span>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X POST "http://localhost:3000/api/gitlab.create" \
|
||||||
|
-d '{
|
||||||
|
"gitlabId": "string",
|
||||||
|
"applicationId": "string",
|
||||||
|
"redirectUri": "string",
|
||||||
|
"secret": "string",
|
||||||
|
"accessToken": "string",
|
||||||
|
"refreshToken": "string",
|
||||||
|
"groupName": "string",
|
||||||
|
"expiresAt": 0,
|
||||||
|
"gitProviderId": "string",
|
||||||
|
"authId": "string",
|
||||||
|
"name": "string"
|
||||||
|
}'
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/gitlab.create", {
|
||||||
|
method: "POST"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"GET"} route={"/gitlab.one"}>
|
||||||
|
|
||||||
|
## gitlab-one
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
### Query Parameters
|
||||||
|
|
||||||
|
<Property name={"gitlabId"} type={"string"} required={true} deprecated={false}>
|
||||||
|
|
||||||
|
<span>Minimum length: `1`</span>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X GET "http://localhost:3000/api/gitlab.one?gitlabId=string"
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/gitlab.one?gitlabId=string", {
|
||||||
|
method: "GET"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"GET"} route={"/gitlab.gitlabProviders"}>
|
||||||
|
|
||||||
|
## gitlab-gitlabProviders
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X GET "http://localhost:3000/api/gitlab.gitlabProviders"
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/gitlab.gitlabProviders", {
|
||||||
|
method: "GET"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"GET"} route={"/gitlab.getGitlabRepositories"}>
|
||||||
|
|
||||||
|
## gitlab-getGitlabRepositories
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
### Query Parameters
|
||||||
|
|
||||||
|
<Property name={"gitlabId"} type={"string"} required={true} deprecated={false}>
|
||||||
|
|
||||||
|
<span>Minimum length: `1`</span>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X GET "http://localhost:3000/api/gitlab.getGitlabRepositories?gitlabId=string"
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/gitlab.getGitlabRepositories?gitlabId=string", {
|
||||||
|
method: "GET"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"GET"} route={"/gitlab.getGitlabBranches"}>
|
||||||
|
|
||||||
|
## gitlab-getGitlabBranches
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
### Query Parameters
|
||||||
|
|
||||||
|
<Property name={"id"} type={"number"} required={false} deprecated={false}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"owner"} type={"string"} required={true} deprecated={false}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"repo"} type={"string"} required={true} deprecated={false}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"gitlabId"} type={"string"} required={false} deprecated={false}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X GET "http://localhost:3000/api/gitlab.getGitlabBranches?id=0&owner=string&repo=string&gitlabId=string"
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/gitlab.getGitlabBranches?id=0&owner=string&repo=string&gitlabId=string", {
|
||||||
|
method: "GET"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"POST"} route={"/gitlab.testConnection"}>
|
||||||
|
|
||||||
|
## gitlab-testConnection
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
### Request Body
|
||||||
|
|
||||||
|
<Property name={"gitlabId"} type={"string"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"groupName"} type={"string"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X POST "http://localhost:3000/api/gitlab.testConnection" \
|
||||||
|
-d '{
|
||||||
|
"gitlabId": "string",
|
||||||
|
"groupName": "string"
|
||||||
|
}'
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/gitlab.testConnection", {
|
||||||
|
method: "POST"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"POST"} route={"/gitlab.update"}>
|
||||||
|
|
||||||
|
## gitlab-update
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
### Request Body
|
||||||
|
|
||||||
|
<Property name={"gitlabId"} type={"string"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
<span>Minimum length: `1`</span>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"applicationId"} type={"string"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"redirectUri"} type={"string"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"secret"} type={"string"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"accessToken"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"refreshToken"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"groupName"} type={"string"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"expiresAt"} type={"number | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"gitProviderId"} type={"string"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"name"} type={"string"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
<span>Minimum length: `1`</span>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X POST "http://localhost:3000/api/gitlab.update" \
|
||||||
|
-d '{
|
||||||
|
"gitlabId": "string",
|
||||||
|
"applicationId": "string",
|
||||||
|
"redirectUri": "string",
|
||||||
|
"secret": "string",
|
||||||
|
"accessToken": "string",
|
||||||
|
"refreshToken": "string",
|
||||||
|
"groupName": "string",
|
||||||
|
"expiresAt": 0,
|
||||||
|
"gitProviderId": "string",
|
||||||
|
"name": "string"
|
||||||
|
}'
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/gitlab.update", {
|
||||||
|
method: "POST"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
</Root>
|
||||||
@@ -55,6 +55,10 @@ In: `header`
|
|||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"filePath"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
<Property name={"serviceId"} type={"string"} required={true} deprecated={undefined}>
|
<Property name={"serviceId"} type={"string"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
<span>Minimum length: `1`</span>
|
<span>Minimum length: `1`</span>
|
||||||
@@ -83,6 +87,7 @@ curl -X POST "http://localhost:3000/api/mounts.create" \
|
|||||||
"content": "string",
|
"content": "string",
|
||||||
"mountPath": "string",
|
"mountPath": "string",
|
||||||
"serviceType": "application",
|
"serviceType": "application",
|
||||||
|
"filePath": "string",
|
||||||
"serviceId": "string"
|
"serviceId": "string"
|
||||||
}'
|
}'
|
||||||
```
|
```
|
||||||
@@ -380,6 +385,10 @@ In: `header`
|
|||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"filePath"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
<Property name={"content"} type={"string | null"} required={false} deprecated={undefined}>
|
<Property name={"content"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
</Property>
|
</Property>
|
||||||
@@ -446,6 +455,7 @@ curl -X POST "http://localhost:3000/api/mounts.update" \
|
|||||||
"type": "bind",
|
"type": "bind",
|
||||||
"hostPath": "string",
|
"hostPath": "string",
|
||||||
"volumeName": "string",
|
"volumeName": "string",
|
||||||
|
"filePath": "string",
|
||||||
"content": "string",
|
"content": "string",
|
||||||
"serviceType": "application",
|
"serviceType": "application",
|
||||||
"mountPath": "string",
|
"mountPath": "string",
|
||||||
|
|||||||
1957
apps/docs/content/docs/api/reference-api/reference-notification.mdx
Normal file
1957
apps/docs/content/docs/api/reference-api/reference-notification.mdx
Normal file
File diff suppressed because it is too large
Load Diff
@@ -191,6 +191,106 @@ export interface Response {
|
|||||||
|
|
||||||
<API>
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"POST"} route={"/settings.toggleDashboard"}>
|
||||||
|
|
||||||
|
## settings-toggleDashboard
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
### Request Body
|
||||||
|
|
||||||
|
<Property name={"enableDashboard"} type={"boolean"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X POST "http://localhost:3000/api/settings.toggleDashboard" \
|
||||||
|
-d '{
|
||||||
|
"enableDashboard": true
|
||||||
|
}'
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/settings.toggleDashboard", {
|
||||||
|
method: "POST"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
<APIInfo method={"POST"} route={"/settings.cleanUnusedImages"}>
|
<APIInfo method={"POST"} route={"/settings.cleanUnusedImages"}>
|
||||||
|
|
||||||
## settings-cleanUnusedImages
|
## settings-cleanUnusedImages
|
||||||
@@ -2384,6 +2484,97 @@ export interface Response {
|
|||||||
|
|
||||||
<API>
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"GET"} route={"/settings.getIp"}>
|
||||||
|
|
||||||
|
## settings-getIp
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X GET "http://localhost:3000/api/settings.getIp"
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/settings.getIp", {
|
||||||
|
method: "GET"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
<APIInfo method={"GET"} route={"/settings.getOpenApiDocument"}>
|
<APIInfo method={"GET"} route={"/settings.getOpenApiDocument"}>
|
||||||
|
|
||||||
## settings-getOpenApiDocument
|
## settings-getOpenApiDocument
|
||||||
@@ -2473,4 +2664,286 @@ export interface Response {
|
|||||||
|
|
||||||
</API>
|
</API>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"GET"} route={"/settings.readTraefikEnv"}>
|
||||||
|
|
||||||
|
## settings-readTraefikEnv
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X GET "http://localhost:3000/api/settings.readTraefikEnv"
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/settings.readTraefikEnv", {
|
||||||
|
method: "GET"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"POST"} route={"/settings.writeTraefikEnv"}>
|
||||||
|
|
||||||
|
## settings-writeTraefikEnv
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
### Request Body
|
||||||
|
|
||||||
|
<Property name={"env"} type={"string"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X POST "http://localhost:3000/api/settings.writeTraefikEnv" \
|
||||||
|
-d '{
|
||||||
|
"env": "string"
|
||||||
|
}'
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/settings.writeTraefikEnv", {
|
||||||
|
method: "POST"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"GET"} route={"/settings.haveTraefikDashboardPortEnabled"}>
|
||||||
|
|
||||||
|
## settings-haveTraefikDashboardPortEnabled
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X GET "http://localhost:3000/api/settings.haveTraefikDashboardPortEnabled"
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/settings.haveTraefikDashboardPortEnabled", {
|
||||||
|
method: "GET"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
</Root>
|
</Root>
|
||||||
634
apps/docs/content/docs/api/reference-api/reference-sshKey.mdx
Normal file
634
apps/docs/content/docs/api/reference-api/reference-sshKey.mdx
Normal file
@@ -0,0 +1,634 @@
|
|||||||
|
---
|
||||||
|
title: sshKey
|
||||||
|
full: true
|
||||||
|
---
|
||||||
|
|
||||||
|
import { Root, API, APIInfo, APIExample, Responses, Response, ResponseTypes, ExampleResponse, TypeScriptResponse, Property, ObjectCollapsible, Requests, Request } from "fumadocs-ui/components/api";
|
||||||
|
|
||||||
|
<Root>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"POST"} route={"/sshKey.create"}>
|
||||||
|
|
||||||
|
## sshKey-create
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
### Request Body
|
||||||
|
|
||||||
|
<Property name={"name"} type={"string"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
<span>Minimum length: `1`</span>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"description"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"publicKey"} type={"string"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"privateKey"} type={"string"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X POST "http://localhost:3000/api/sshKey.create" \
|
||||||
|
-d '{
|
||||||
|
"name": "string",
|
||||||
|
"description": "string",
|
||||||
|
"publicKey": "string",
|
||||||
|
"privateKey": "string"
|
||||||
|
}'
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/sshKey.create", {
|
||||||
|
method: "POST"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"POST"} route={"/sshKey.remove"}>
|
||||||
|
|
||||||
|
## sshKey-remove
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
### Request Body
|
||||||
|
|
||||||
|
<Property name={"sshKeyId"} type={"string"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X POST "http://localhost:3000/api/sshKey.remove" \
|
||||||
|
-d '{
|
||||||
|
"sshKeyId": "string"
|
||||||
|
}'
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/sshKey.remove", {
|
||||||
|
method: "POST"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"GET"} route={"/sshKey.one"}>
|
||||||
|
|
||||||
|
## sshKey-one
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
### Query Parameters
|
||||||
|
|
||||||
|
<Property name={"sshKeyId"} type={"string"} required={true} deprecated={false}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X GET "http://localhost:3000/api/sshKey.one?sshKeyId=string"
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/sshKey.one?sshKeyId=string", {
|
||||||
|
method: "GET"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"GET"} route={"/sshKey.all"}>
|
||||||
|
|
||||||
|
## sshKey-all
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X GET "http://localhost:3000/api/sshKey.all"
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/sshKey.all", {
|
||||||
|
method: "GET"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"POST"} route={"/sshKey.generate"}>
|
||||||
|
|
||||||
|
## sshKey-generate
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
### Request Body
|
||||||
|
|
||||||
|
<Property name={"type"} type={"string"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
<span>Value in: `"rsa" | "ed25519"`</span>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X POST "http://localhost:3000/api/sshKey.generate" \
|
||||||
|
-d '{
|
||||||
|
"type": "rsa"
|
||||||
|
}'
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/sshKey.generate", {
|
||||||
|
method: "POST"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
<API>
|
||||||
|
|
||||||
|
<APIInfo method={"POST"} route={"/sshKey.update"}>
|
||||||
|
|
||||||
|
## sshKey-update
|
||||||
|
|
||||||
|
### Authorization
|
||||||
|
|
||||||
|
<Property name={"Authorization"} type={"Bearer <token>"} required={true}>
|
||||||
|
|
||||||
|
In: `header`
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
### Request Body
|
||||||
|
|
||||||
|
<Property name={"name"} type={"string"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
<span>Minimum length: `1`</span>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"description"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"lastUsedAt"} type={"string | null"} required={false} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name={"sshKeyId"} type={"string"} required={true} deprecated={undefined}>
|
||||||
|
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
| Status code | Description |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `200` | Successful response |
|
||||||
|
| `default` | Error response |
|
||||||
|
|
||||||
|
</APIInfo>
|
||||||
|
|
||||||
|
<APIExample>
|
||||||
|
|
||||||
|
<Requests items={["cURL","JavaScript"]}>
|
||||||
|
|
||||||
|
<Request value={"cURL"}>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X POST "http://localhost:3000/api/sshKey.update" \
|
||||||
|
-d '{
|
||||||
|
"name": "string",
|
||||||
|
"description": "string",
|
||||||
|
"lastUsedAt": "string",
|
||||||
|
"sshKeyId": "string"
|
||||||
|
}'
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
<Request value={"JavaScript"}>
|
||||||
|
|
||||||
|
```js
|
||||||
|
fetch("http://localhost:3000/api/sshKey.update", {
|
||||||
|
method: "POST"
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</Request>
|
||||||
|
|
||||||
|
</Requests>
|
||||||
|
|
||||||
|
<Responses items={["default"]}>
|
||||||
|
|
||||||
|
<Response value={"default"}>
|
||||||
|
|
||||||
|
<ResponseTypes>
|
||||||
|
|
||||||
|
<ExampleResponse>
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"message": "string",
|
||||||
|
"code": "string",
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"message": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</ExampleResponse>
|
||||||
|
|
||||||
|
<TypeScriptResponse>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export interface Response {
|
||||||
|
message: string;
|
||||||
|
code: string;
|
||||||
|
issues?: {
|
||||||
|
message: string;
|
||||||
|
}[];
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</TypeScriptResponse>
|
||||||
|
|
||||||
|
</ResponseTypes>
|
||||||
|
|
||||||
|
</Response>
|
||||||
|
|
||||||
|
</Responses>
|
||||||
|
|
||||||
|
</APIExample>
|
||||||
|
|
||||||
|
</API>
|
||||||
|
|
||||||
|
</Root>
|
||||||
@@ -104,7 +104,7 @@ export const SaveGitlabProvider = ({ applicationId }: Props) => {
|
|||||||
{
|
{
|
||||||
owner: repository?.owner,
|
owner: repository?.owner,
|
||||||
repo: repository?.repo,
|
repo: repository?.repo,
|
||||||
id: repository?.id,
|
id: repository?.id || 0,
|
||||||
gitlabId: gitlabId,
|
gitlabId: gitlabId,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -60,7 +60,9 @@ export const EditTraefikEnv = ({ children }: Props) => {
|
|||||||
}, [form, form.reset, data]);
|
}, [form, form.reset, data]);
|
||||||
|
|
||||||
const onSubmit = async (data: Schema) => {
|
const onSubmit = async (data: Schema) => {
|
||||||
await mutateAsync(data.env)
|
await mutateAsync({
|
||||||
|
env: data.env,
|
||||||
|
})
|
||||||
.then(async () => {
|
.then(async () => {
|
||||||
toast.success("Traefik Env Updated");
|
toast.success("Traefik Env Updated");
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -301,6 +301,10 @@ export const settingsRouter = createTRPCRouter({
|
|||||||
"mongo",
|
"mongo",
|
||||||
"mariadb",
|
"mariadb",
|
||||||
"sshRouter",
|
"sshRouter",
|
||||||
|
"gitProvider",
|
||||||
|
"bitbucket",
|
||||||
|
"github",
|
||||||
|
"gitlab",
|
||||||
],
|
],
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -322,9 +326,9 @@ export const settingsRouter = createTRPCRouter({
|
|||||||
}),
|
}),
|
||||||
|
|
||||||
writeTraefikEnv: adminProcedure
|
writeTraefikEnv: adminProcedure
|
||||||
.input(z.string())
|
.input(z.object({ env: z.string() }))
|
||||||
.mutation(async ({ input }) => {
|
.mutation(async ({ input }) => {
|
||||||
const envs = prepareEnvironmentVariables(input);
|
const envs = prepareEnvironmentVariables(input.env);
|
||||||
await initializeTraefik({
|
await initializeTraefik({
|
||||||
env: envs,
|
env: envs,
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -54,7 +54,7 @@ export const apiGitlabTestConnection = createSchema
|
|||||||
.pick({ gitlabId: true, groupName: true });
|
.pick({ gitlabId: true, groupName: true });
|
||||||
|
|
||||||
export const apiFindGitlabBranches = z.object({
|
export const apiFindGitlabBranches = z.object({
|
||||||
id: z.number().nullable(),
|
id: z.number().optional(),
|
||||||
owner: z.string(),
|
owner: z.string(),
|
||||||
repo: z.string(),
|
repo: z.string(),
|
||||||
gitlabId: z.string().optional(),
|
gitlabId: z.string().optional(),
|
||||||
|
|||||||
@@ -208,12 +208,12 @@ export const getGitlabRepositories = async (gitlabId?: string) => {
|
|||||||
};
|
};
|
||||||
|
|
||||||
export const getGitlabBranches = async (input: {
|
export const getGitlabBranches = async (input: {
|
||||||
id: number | null;
|
id?: number;
|
||||||
gitlabId?: string;
|
gitlabId?: string;
|
||||||
owner: string;
|
owner: string;
|
||||||
repo: string;
|
repo: string;
|
||||||
}) => {
|
}) => {
|
||||||
if (!input.gitlabId || !input.id) {
|
if (!input.gitlabId || !input.id || input.id === 0) {
|
||||||
return [];
|
return [];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user