API-referens
Alla HTTP-slutpunkter i modulen docs: autentisering, IAM-åtgärd, parametrar, innehåll och statuskoder.
Genererad från modulens kod när dess image byggdes — redigera inte. Sökvägarna är relativa till https://api.example.com.
Docs
GET /docs-hub/errors/{module}/{code}
- Autentisering: krävs
- Operationsnamn:
DocsHubErrorCode
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
module |
sökväg | string |
Ja |
code |
sökväg | string |
Ja |
lang |
frågesträng | string |
Nej |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token |
GET /docs-hub/modules
- Autentisering: krävs
- Operationsnamn:
DocsHubModules
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token |
GET /docs-hub/nav
- Autentisering: krävs
- Operationsnamn:
DocsHubNavigation
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
audience |
frågesträng | string |
Nej |
lang |
frågesträng | string |
Nej |
scope |
frågesträng | string |
Nej |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token |
GET /docs-hub/pages/{module}/{slug}
- Autentisering: krävs
- Operationsnamn:
DocsHubPage
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
module |
sökväg | string |
Ja |
slug |
sökväg | string |
Ja |
lang |
frågesträng | string |
Nej |
scope |
frågesträng | string |
Nej |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token |
GET /docs-hub/resolve
- Autentisering: krävs
- Operationsnamn:
DocsHubResolve
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
lang |
frågesträng | string |
Nej |
ref |
frågesträng | string |
Nej |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token |
GET /docs-hub/search
- Autentisering: krävs
- Operationsnamn:
DocsHubSearch
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
audience |
frågesträng | string |
Nej |
kind |
frågesträng | string |
Nej |
lang |
frågesträng | string |
Nej |
limit |
frågesträng | integer |
Nej |
module |
frågesträng | string |
Nej |
q |
frågesträng | string |
Nej |
scope |
frågesträng | string |
Nej |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token |
GET /docs/docs/manifest.json
- Autentisering: krävs
- Operationsnamn:
DocsManifest_docs
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token |
GET /docs/docs/{path}
- Autentisering: krävs
- Operationsnamn:
DocsFile_docs
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
path |
sökväg | string |
Ja |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token |
Övriga slutpunkter
GET /readyz
- Autentisering: ingen — anonyma anrop accepteras
- Operationsnamn:
StackshipReadiness
Svar
| Status | Betydelse | Innehåll |
|---|