docs(nx-cloud): remove server api reference (#22654)

This commit is contained in:
Altan Stalker 2024-04-03 15:15:49 -04:00 committed by GitHub
parent 7f00927655
commit d9bb051091
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 0 additions and 69 deletions

View File

@ -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",

View File

@ -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",

View File

@ -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",

View File

@ -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)

View File

@ -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

View File

@ -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',