mirror of
https://github.com/Unleash/unleash.git
synced 2025-06-04 01:18:20 +02:00
chore(docs): Add link to Open API specifications
This commit is contained in:
parent
f9d09cf871
commit
f2e4b69562
10
docs/api/open-api.md
Normal file
10
docs/api/open-api.md
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
---
|
||||||
|
id: open_api
|
||||||
|
title: Open API Specification
|
||||||
|
---
|
||||||
|
|
||||||
|
> The Unleash Open API Specifications are still considered a beta functionality. We have (for now) manually written all the specifications for all API endpoints. We are testing this functinality, and the ultimate goal will be to auto-generate these specifications from the code itself.
|
||||||
|
|
||||||
|
The Open API Specifcation is hosted as part of the online demo: http://unleash.herokuapp.com/oas/
|
||||||
|
|
||||||
|
You can also allow your own Unleash instance to serve the Open API specification by setting the `ENABLE_OAS` environment variable to true: `ENABLE_OAS=true`
|
@ -41,6 +41,9 @@
|
|||||||
"api/internal": {
|
"api/internal": {
|
||||||
"title": "/internal-backstage/prometheus"
|
"title": "/internal-backstage/prometheus"
|
||||||
},
|
},
|
||||||
|
"api/open_api": {
|
||||||
|
"title": "Open API Specification"
|
||||||
|
},
|
||||||
"client_sdk": {
|
"client_sdk": {
|
||||||
"title": "Client SDK"
|
"title": "Client SDK"
|
||||||
},
|
},
|
||||||
@ -107,7 +110,8 @@
|
|||||||
"Guides": "Guides",
|
"Guides": "Guides",
|
||||||
"Client": "Client",
|
"Client": "Client",
|
||||||
"Admin": "Admin",
|
"Admin": "Admin",
|
||||||
"Internal": "Internal"
|
"Internal": "Internal",
|
||||||
|
"Specification": "Specification"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"pages-strings": {
|
"pages-strings": {
|
||||||
|
@ -38,6 +38,7 @@
|
|||||||
"api/admin/state",
|
"api/admin/state",
|
||||||
"api/admin/feature-types"
|
"api/admin/feature-types"
|
||||||
],
|
],
|
||||||
"Internal": ["api/internal"]
|
"Internal": ["api/internal"],
|
||||||
|
"Specification": ["api/open_api"]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
Loading…
Reference in New Issue
Block a user