docs(nx-cloud): remove server api reference (#22654)
This commit is contained in:
parent
7f00927655
commit
d9bb051091
@ -1867,17 +1867,6 @@
|
|||||||
"path": "/ci/reference/env-vars",
|
"path": "/ci/reference/env-vars",
|
||||||
"tags": []
|
"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",
|
"id": "release-notes",
|
||||||
"name": "Release Notes",
|
"name": "Release Notes",
|
||||||
@ -1938,17 +1927,6 @@
|
|||||||
"path": "/ci/reference/env-vars",
|
"path": "/ci/reference/env-vars",
|
||||||
"tags": []
|
"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": {
|
"/ci/reference/release-notes": {
|
||||||
"id": "release-notes",
|
"id": "release-notes",
|
||||||
"name": "Release Notes",
|
"name": "Release Notes",
|
||||||
|
|||||||
@ -7037,14 +7037,6 @@
|
|||||||
"children": [],
|
"children": [],
|
||||||
"disableCollapsible": false
|
"disableCollapsible": false
|
||||||
},
|
},
|
||||||
{
|
|
||||||
"name": "Server API Reference",
|
|
||||||
"path": "/ci/reference/server-api",
|
|
||||||
"id": "server-api",
|
|
||||||
"isExternal": false,
|
|
||||||
"children": [],
|
|
||||||
"disableCollapsible": false
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
"name": "Release Notes",
|
"name": "Release Notes",
|
||||||
"path": "/ci/reference/release-notes",
|
"path": "/ci/reference/release-notes",
|
||||||
@ -7088,14 +7080,6 @@
|
|||||||
"children": [],
|
"children": [],
|
||||||
"disableCollapsible": false
|
"disableCollapsible": false
|
||||||
},
|
},
|
||||||
{
|
|
||||||
"name": "Server API Reference",
|
|
||||||
"path": "/ci/reference/server-api",
|
|
||||||
"id": "server-api",
|
|
||||||
"isExternal": false,
|
|
||||||
"children": [],
|
|
||||||
"disableCollapsible": false
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
"name": "Release Notes",
|
"name": "Release Notes",
|
||||||
"path": "/ci/reference/release-notes",
|
"path": "/ci/reference/release-notes",
|
||||||
|
|||||||
@ -2030,11 +2030,6 @@
|
|||||||
"id": "env-vars",
|
"id": "env-vars",
|
||||||
"file": "nx-cloud/reference/env-vars"
|
"file": "nx-cloud/reference/env-vars"
|
||||||
},
|
},
|
||||||
{
|
|
||||||
"name": "Server API Reference",
|
|
||||||
"id": "server-api",
|
|
||||||
"file": "nx-cloud/reference/server-api"
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
"name": "Release Notes",
|
"name": "Release Notes",
|
||||||
"id": "release-notes",
|
"id": "release-notes",
|
||||||
|
|||||||
@ -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):
|
|
||||||
|
|
||||||

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

|
|
||||||
@ -326,7 +326,6 @@
|
|||||||
- [nx-cloud CLI](/ci/reference/nx-cloud-cli)
|
- [nx-cloud CLI](/ci/reference/nx-cloud-cli)
|
||||||
- [Launch Templates](/ci/reference/launch-templates)
|
- [Launch Templates](/ci/reference/launch-templates)
|
||||||
- [Environment Variables](/ci/reference/env-vars)
|
- [Environment Variables](/ci/reference/env-vars)
|
||||||
- [Server API Reference](/ci/reference/server-api)
|
|
||||||
- [Release Notes](/ci/reference/release-notes)
|
- [Release Notes](/ci/reference/release-notes)
|
||||||
|
|
||||||
- Nx-api
|
- Nx-api
|
||||||
|
|||||||
@ -70,10 +70,6 @@ const pages: Array<{ title: string; path: string }> = [
|
|||||||
title: 'Environment Variables',
|
title: 'Environment Variables',
|
||||||
path: '/ci/reference/env-vars',
|
path: '/ci/reference/env-vars',
|
||||||
},
|
},
|
||||||
{
|
|
||||||
title: 'Nx Cloud Server API Reference',
|
|
||||||
path: '/ci/reference/server-api',
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
title: 'Enterprise Release Notes',
|
title: 'Enterprise Release Notes',
|
||||||
path: '/ci/reference/release-notes',
|
path: '/ci/reference/release-notes',
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user