diff --git a/docs/api/open-api.md b/docs/api/open-api.md new file mode 100644 index 0000000000..1083e8478d --- /dev/null +++ b/docs/api/open-api.md @@ -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` diff --git a/website/i18n/en.json b/website/i18n/en.json index b686c9a475..3ac9ba7e84 100644 --- a/website/i18n/en.json +++ b/website/i18n/en.json @@ -41,6 +41,9 @@ "api/internal": { "title": "/internal-backstage/prometheus" }, + "api/open_api": { + "title": "Open API Specification" + }, "client_sdk": { "title": "Client SDK" }, @@ -107,7 +110,8 @@ "Guides": "Guides", "Client": "Client", "Admin": "Admin", - "Internal": "Internal" + "Internal": "Internal", + "Specification": "Specification" } }, "pages-strings": { diff --git a/website/sidebars.json b/website/sidebars.json index c91de15239..e7d9f27f5e 100644 --- a/website/sidebars.json +++ b/website/sidebars.json @@ -38,6 +38,7 @@ "api/admin/state", "api/admin/feature-types" ], - "Internal": ["api/internal"] + "Internal": ["api/internal"], + "Specification": ["api/open_api"] } }