Skip to content

Commit 6dbf34e

Browse files
author
Mauricio Siu
committed
chore: update OpenAPI documentation paths and add openapi.json file
- Copied openapi.json to the docs public folder for easier access. - Updated paths in generated documentation files to reference the new location of openapi.json. - Ensured all references to openapi.json are consistent across documentation files.
1 parent 09053b6 commit 6dbf34e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+21600
-41
lines changed

Dockerfile.docs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ WORKDIR /usr/src/app
1111
# Install dependencies
1212
RUN --mount=type=cache,id=pnpm,target=/pnpm/store pnpm install --filter=./apps/docs --frozen-lockfile
1313

14+
# Copy openapi.json to docs public folder
15+
RUN mkdir -p /usr/src/app/apps/docs/public && \
16+
cp /usr/src/app/public/openapi.json /usr/src/app/apps/docs/public/openapi.json
17+
1418
# Generate OpenAPI documentation
1519
RUN pnpm --filter=./apps/docs run build:docs
1620

apps/docs/content/docs/api/generated/reference-admin.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ _openapi:
1313
contents: []
1414
---
1515

16-
<APIPage document={"../../public/openapi.json"} operations={[{"method":"post","path":"/admin.setupMonitoring"}]} hasHead={true} />
16+
<APIPage document={"./public/openapi.json"} operations={[{"method":"post","path":"/admin.setupMonitoring"}]} hasHead={true} />

apps/docs/content/docs/api/generated/reference-ai.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,4 +53,4 @@ _openapi:
5353
contents: []
5454
---
5555

56-
<APIPage document={"../../public/openapi.json"} operations={[{"method":"get","path":"/ai.one"},{"method":"get","path":"/ai.getModels"},{"method":"post","path":"/ai.create"},{"method":"post","path":"/ai.update"},{"method":"get","path":"/ai.getAll"},{"method":"get","path":"/ai.get"},{"method":"post","path":"/ai.delete"},{"method":"post","path":"/ai.suggest"},{"method":"post","path":"/ai.deploy"}]} hasHead={true} />
56+
<APIPage document={"./public/openapi.json"} operations={[{"method":"get","path":"/ai.one"},{"method":"get","path":"/ai.getModels"},{"method":"post","path":"/ai.create"},{"method":"post","path":"/ai.update"},{"method":"get","path":"/ai.getAll"},{"method":"get","path":"/ai.get"},{"method":"post","path":"/ai.delete"},{"method":"post","path":"/ai.suggest"},{"method":"post","path":"/ai.deploy"}]} hasHead={true} />

apps/docs/content/docs/api/generated/reference-application.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,4 +143,4 @@ _openapi:
143143
contents: []
144144
---
145145

146-
<APIPage document={"../../public/openapi.json"} operations={[{"method":"post","path":"/application.create"},{"method":"get","path":"/application.one"},{"method":"post","path":"/application.reload"},{"method":"post","path":"/application.delete"},{"method":"post","path":"/application.stop"},{"method":"post","path":"/application.start"},{"method":"post","path":"/application.redeploy"},{"method":"post","path":"/application.saveEnvironment"},{"method":"post","path":"/application.saveBuildType"},{"method":"post","path":"/application.saveGithubProvider"},{"method":"post","path":"/application.saveGitlabProvider"},{"method":"post","path":"/application.saveBitbucketProvider"},{"method":"post","path":"/application.saveGiteaProvider"},{"method":"post","path":"/application.saveDockerProvider"},{"method":"post","path":"/application.saveGitProvider"},{"method":"post","path":"/application.disconnectGitProvider"},{"method":"post","path":"/application.markRunning"},{"method":"post","path":"/application.update"},{"method":"post","path":"/application.refreshToken"},{"method":"post","path":"/application.deploy"},{"method":"post","path":"/application.cleanQueues"},{"method":"post","path":"/application.killBuild"},{"method":"get","path":"/application.readTraefikConfig"},{"method":"post","path":"/application.updateTraefikConfig"},{"method":"get","path":"/application.readAppMonitoring"},{"method":"post","path":"/application.move"},{"method":"post","path":"/application.cancelDeployment"}]} hasHead={true} />
146+
<APIPage document={"./public/openapi.json"} operations={[{"method":"post","path":"/application.create"},{"method":"get","path":"/application.one"},{"method":"post","path":"/application.reload"},{"method":"post","path":"/application.delete"},{"method":"post","path":"/application.stop"},{"method":"post","path":"/application.start"},{"method":"post","path":"/application.redeploy"},{"method":"post","path":"/application.saveEnvironment"},{"method":"post","path":"/application.saveBuildType"},{"method":"post","path":"/application.saveGithubProvider"},{"method":"post","path":"/application.saveGitlabProvider"},{"method":"post","path":"/application.saveBitbucketProvider"},{"method":"post","path":"/application.saveGiteaProvider"},{"method":"post","path":"/application.saveDockerProvider"},{"method":"post","path":"/application.saveGitProvider"},{"method":"post","path":"/application.disconnectGitProvider"},{"method":"post","path":"/application.markRunning"},{"method":"post","path":"/application.update"},{"method":"post","path":"/application.refreshToken"},{"method":"post","path":"/application.deploy"},{"method":"post","path":"/application.cleanQueues"},{"method":"post","path":"/application.killBuild"},{"method":"get","path":"/application.readTraefikConfig"},{"method":"post","path":"/application.updateTraefikConfig"},{"method":"get","path":"/application.readAppMonitoring"},{"method":"post","path":"/application.move"},{"method":"post","path":"/application.cancelDeployment"}]} hasHead={true} />

apps/docs/content/docs/api/generated/reference-backup.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,4 +63,4 @@ _openapi:
6363
contents: []
6464
---
6565

66-
<APIPage document={"../../public/openapi.json"} operations={[{"method":"post","path":"/backup.create"},{"method":"get","path":"/backup.one"},{"method":"post","path":"/backup.update"},{"method":"post","path":"/backup.remove"},{"method":"post","path":"/backup.manualBackupPostgres"},{"method":"post","path":"/backup.manualBackupMySql"},{"method":"post","path":"/backup.manualBackupMariadb"},{"method":"post","path":"/backup.manualBackupCompose"},{"method":"post","path":"/backup.manualBackupMongo"},{"method":"post","path":"/backup.manualBackupWebServer"},{"method":"get","path":"/backup.listBackupFiles"}]} hasHead={true} />
66+
<APIPage document={"./public/openapi.json"} operations={[{"method":"post","path":"/backup.create"},{"method":"get","path":"/backup.one"},{"method":"post","path":"/backup.update"},{"method":"post","path":"/backup.remove"},{"method":"post","path":"/backup.manualBackupPostgres"},{"method":"post","path":"/backup.manualBackupMySql"},{"method":"post","path":"/backup.manualBackupMariadb"},{"method":"post","path":"/backup.manualBackupCompose"},{"method":"post","path":"/backup.manualBackupMongo"},{"method":"post","path":"/backup.manualBackupWebServer"},{"method":"get","path":"/backup.listBackupFiles"}]} hasHead={true} />

apps/docs/content/docs/api/generated/reference-bitbucket.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,4 +43,4 @@ _openapi:
4343
contents: []
4444
---
4545

46-
<APIPage document={"../../public/openapi.json"} operations={[{"method":"post","path":"/bitbucket.create"},{"method":"get","path":"/bitbucket.one"},{"method":"get","path":"/bitbucket.bitbucketProviders"},{"method":"get","path":"/bitbucket.getBitbucketRepositories"},{"method":"get","path":"/bitbucket.getBitbucketBranches"},{"method":"post","path":"/bitbucket.testConnection"},{"method":"post","path":"/bitbucket.update"}]} hasHead={true} />
46+
<APIPage document={"./public/openapi.json"} operations={[{"method":"post","path":"/bitbucket.create"},{"method":"get","path":"/bitbucket.one"},{"method":"get","path":"/bitbucket.bitbucketProviders"},{"method":"get","path":"/bitbucket.getBitbucketRepositories"},{"method":"get","path":"/bitbucket.getBitbucketBranches"},{"method":"post","path":"/bitbucket.testConnection"},{"method":"post","path":"/bitbucket.update"}]} hasHead={true} />

apps/docs/content/docs/api/generated/reference-certificates.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@ _openapi:
2828
contents: []
2929
---
3030

31-
<APIPage document={"../../public/openapi.json"} operations={[{"method":"post","path":"/certificates.create"},{"method":"get","path":"/certificates.one"},{"method":"post","path":"/certificates.remove"},{"method":"get","path":"/certificates.all"}]} hasHead={true} />
31+
<APIPage document={"./public/openapi.json"} operations={[{"method":"post","path":"/certificates.create"},{"method":"get","path":"/certificates.one"},{"method":"post","path":"/certificates.remove"},{"method":"get","path":"/certificates.all"}]} hasHead={true} />

apps/docs/content/docs/api/generated/reference-cluster.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@ _openapi:
2828
contents: []
2929
---
3030

31-
<APIPage document={"../../public/openapi.json"} operations={[{"method":"get","path":"/cluster.getNodes"},{"method":"post","path":"/cluster.removeWorker"},{"method":"get","path":"/cluster.addWorker"},{"method":"get","path":"/cluster.addManager"}]} hasHead={true} />
31+
<APIPage document={"./public/openapi.json"} operations={[{"method":"get","path":"/cluster.getNodes"},{"method":"post","path":"/cluster.removeWorker"},{"method":"get","path":"/cluster.addWorker"},{"method":"get","path":"/cluster.addManager"}]} hasHead={true} />

apps/docs/content/docs/api/generated/reference-compose.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,4 +138,4 @@ _openapi:
138138
contents: []
139139
---
140140

141-
<APIPage document={"../../public/openapi.json"} operations={[{"method":"post","path":"/compose.create"},{"method":"get","path":"/compose.one"},{"method":"post","path":"/compose.update"},{"method":"post","path":"/compose.delete"},{"method":"post","path":"/compose.cleanQueues"},{"method":"post","path":"/compose.killBuild"},{"method":"get","path":"/compose.loadServices"},{"method":"get","path":"/compose.loadMountsByService"},{"method":"post","path":"/compose.fetchSourceType"},{"method":"post","path":"/compose.randomizeCompose"},{"method":"post","path":"/compose.isolatedDeployment"},{"method":"get","path":"/compose.getConvertedCompose"},{"method":"post","path":"/compose.deploy"},{"method":"post","path":"/compose.redeploy"},{"method":"post","path":"/compose.stop"},{"method":"post","path":"/compose.start"},{"method":"get","path":"/compose.getDefaultCommand"},{"method":"post","path":"/compose.refreshToken"},{"method":"post","path":"/compose.deployTemplate"},{"method":"get","path":"/compose.templates"},{"method":"get","path":"/compose.getTags"},{"method":"post","path":"/compose.disconnectGitProvider"},{"method":"post","path":"/compose.move"},{"method":"post","path":"/compose.processTemplate"},{"method":"post","path":"/compose.import"},{"method":"post","path":"/compose.cancelDeployment"}]} hasHead={true} />
141+
<APIPage document={"./public/openapi.json"} operations={[{"method":"post","path":"/compose.create"},{"method":"get","path":"/compose.one"},{"method":"post","path":"/compose.update"},{"method":"post","path":"/compose.delete"},{"method":"post","path":"/compose.cleanQueues"},{"method":"post","path":"/compose.killBuild"},{"method":"get","path":"/compose.loadServices"},{"method":"get","path":"/compose.loadMountsByService"},{"method":"post","path":"/compose.fetchSourceType"},{"method":"post","path":"/compose.randomizeCompose"},{"method":"post","path":"/compose.isolatedDeployment"},{"method":"get","path":"/compose.getConvertedCompose"},{"method":"post","path":"/compose.deploy"},{"method":"post","path":"/compose.redeploy"},{"method":"post","path":"/compose.stop"},{"method":"post","path":"/compose.start"},{"method":"get","path":"/compose.getDefaultCommand"},{"method":"post","path":"/compose.refreshToken"},{"method":"post","path":"/compose.deployTemplate"},{"method":"get","path":"/compose.templates"},{"method":"get","path":"/compose.getTags"},{"method":"post","path":"/compose.disconnectGitProvider"},{"method":"post","path":"/compose.move"},{"method":"post","path":"/compose.processTemplate"},{"method":"post","path":"/compose.import"},{"method":"post","path":"/compose.cancelDeployment"}]} hasHead={true} />

apps/docs/content/docs/api/generated/reference-deployment.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,4 @@ _openapi:
3333
contents: []
3434
---
3535

36-
<APIPage document={"../../public/openapi.json"} operations={[{"method":"get","path":"/deployment.all"},{"method":"get","path":"/deployment.allByCompose"},{"method":"get","path":"/deployment.allByServer"},{"method":"get","path":"/deployment.allByType"},{"method":"post","path":"/deployment.killProcess"}]} hasHead={true} />
36+
<APIPage document={"./public/openapi.json"} operations={[{"method":"get","path":"/deployment.all"},{"method":"get","path":"/deployment.allByCompose"},{"method":"get","path":"/deployment.allByServer"},{"method":"get","path":"/deployment.allByType"},{"method":"post","path":"/deployment.killProcess"}]} hasHead={true} />

0 commit comments

Comments
 (0)