From d9bb05109187b354ae643d9580e586ce48b16e49 Mon Sep 17 00:00:00 2001 From: Altan Stalker Date: Wed, 3 Apr 2024 15:15:49 -0400 Subject: [PATCH] docs(nx-cloud): remove server api reference (#22654) --- docs/generated/manifests/ci.json | 22 ------------------- docs/generated/manifests/menus.json | 16 -------------- docs/map.json | 5 ----- docs/nx-cloud/reference/server-api.md | 21 ------------------ docs/shared/reference/sitemap.md | 1 - .../src/nx-cloud-documentation.spec.ts | 4 ---- 6 files changed, 69 deletions(-) delete mode 100644 docs/nx-cloud/reference/server-api.md diff --git a/docs/generated/manifests/ci.json b/docs/generated/manifests/ci.json index 26e3d72490..36cb5b5882 100644 --- a/docs/generated/manifests/ci.json +++ b/docs/generated/manifests/ci.json @@ -1867,17 +1867,6 @@ "path": "/ci/reference/env-vars", "tags": [] }, - { - "id": "server-api", - "name": "Server API Reference", - "description": "", - "mediaImage": "", - "file": "nx-cloud/reference/server-api", - "itemList": [], - "isExternal": false, - "path": "/ci/reference/server-api", - "tags": [] - }, { "id": "release-notes", "name": "Release Notes", @@ -1938,17 +1927,6 @@ "path": "/ci/reference/env-vars", "tags": [] }, - "/ci/reference/server-api": { - "id": "server-api", - "name": "Server API Reference", - "description": "", - "mediaImage": "", - "file": "nx-cloud/reference/server-api", - "itemList": [], - "isExternal": false, - "path": "/ci/reference/server-api", - "tags": [] - }, "/ci/reference/release-notes": { "id": "release-notes", "name": "Release Notes", diff --git a/docs/generated/manifests/menus.json b/docs/generated/manifests/menus.json index 77d3103e4e..70861a461d 100644 --- a/docs/generated/manifests/menus.json +++ b/docs/generated/manifests/menus.json @@ -7037,14 +7037,6 @@ "children": [], "disableCollapsible": false }, - { - "name": "Server API Reference", - "path": "/ci/reference/server-api", - "id": "server-api", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, { "name": "Release Notes", "path": "/ci/reference/release-notes", @@ -7088,14 +7080,6 @@ "children": [], "disableCollapsible": false }, - { - "name": "Server API Reference", - "path": "/ci/reference/server-api", - "id": "server-api", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, { "name": "Release Notes", "path": "/ci/reference/release-notes", diff --git a/docs/map.json b/docs/map.json index 606c78aa35..218c0b394e 100644 --- a/docs/map.json +++ b/docs/map.json @@ -2030,11 +2030,6 @@ "id": "env-vars", "file": "nx-cloud/reference/env-vars" }, - { - "name": "Server API Reference", - "id": "server-api", - "file": "nx-cloud/reference/server-api" - }, { "name": "Release Notes", "id": "release-notes", diff --git a/docs/nx-cloud/reference/server-api.md b/docs/nx-cloud/reference/server-api.md deleted file mode 100644 index 26366a132f..0000000000 --- a/docs/nx-cloud/reference/server-api.md +++ /dev/null @@ -1,21 +0,0 @@ -# Nx Cloud Server API Reference - -## OpenAPI - -The nx-api has an OpenAPI `3.0.3` spec definition available at: - -[https://cloud.nx.app/nx-cloud/api/definition.json](https://cloud.nx.app/nx-cloud/api/definition.json) - -## Authenticating - -To authenticate, you may use your tokens (accessible from Nx Cloud): - -![Access tokens](/nx-cloud/reference/access-tokens.webp) - -Per the spec, you use this token in the `Authentication` header. - -## Swagger - -You may use swagger to preview the spec and make requests. We do not serve our own swagger instance publicly, but you may use [the example swagger ui](https://petstore.swagger.io/?url=https://cloud.nx.app/nx-cloud/api/definition.json), and paste in the url to the Nx API definitions (https://cloud.nx.app/nx-cloud/api/definition.json). - -![Access tokens](/nx-cloud/reference/swagger-preview.png) diff --git a/docs/shared/reference/sitemap.md b/docs/shared/reference/sitemap.md index 32f0ccf5fb..f388089013 100644 --- a/docs/shared/reference/sitemap.md +++ b/docs/shared/reference/sitemap.md @@ -326,7 +326,6 @@ - [nx-cloud CLI](/ci/reference/nx-cloud-cli) - [Launch Templates](/ci/reference/launch-templates) - [Environment Variables](/ci/reference/env-vars) - - [Server API Reference](/ci/reference/server-api) - [Release Notes](/ci/reference/release-notes) - Nx-api diff --git a/nx-dev/nx-dev-e2e/src/nx-cloud-documentation.spec.ts b/nx-dev/nx-dev-e2e/src/nx-cloud-documentation.spec.ts index f47120d22f..699972e85f 100644 --- a/nx-dev/nx-dev-e2e/src/nx-cloud-documentation.spec.ts +++ b/nx-dev/nx-dev-e2e/src/nx-cloud-documentation.spec.ts @@ -70,10 +70,6 @@ const pages: Array<{ title: string; path: string }> = [ title: 'Environment Variables', path: '/ci/reference/env-vars', }, - { - title: 'Nx Cloud Server API Reference', - path: '/ci/reference/server-api', - }, { title: 'Enterprise Release Notes', path: '/ci/reference/release-notes',