mirror of
https://github.com/Unleash/unleash.git
synced 2024-12-28 00:06:53 +01:00
9448461aaa
* Docs: start experimenting with OpenAPI and docusaurus * Docs: add docusaurus-theme-openapi-docs pkg * Wip: current status * Docs: Add 'docusaurus-plugin-api-docs' * Move openapi into own sidebar; generate from localhost * Chore: Update docusaurus plugin for OpenAPI * Add website/yarn.lock to git * Fix: fix CSS warning by using flex-end instead of end * docs: make openapi generated code work again * docs: make tags work properly with openapi sidebar * Docs/chore: update OpenAPI tag scheme. Add a whole bunch of new tags to make it easier to understand available tags in OpenAPI. * docs: point to new openapi docs from old api docs * docs: typo * Docs: link restructure * docs: add operation indicators to openapi docs * docs: change badge color for operations * docs: update openapi-docs package It now sorts tags the same as the schema * docs: pluralize APIs in slug * docs: update links to generated api docs * docs: update openapi snapshot tests with new tags * docs: conditionally load spec from localhost or from file * docs: Remove changes relating to immediate switchover * refactor: rename types; extract into separate file * docs: fix api doc links
1.3 KiB
1.3 KiB
| id | title | slug |
|---|---|---|
| index | API Documentation | /api |
Client API
This describes the API provided to unleash-clients.
Since v4.0.0 all operations require an API token with Client level access.
With versions earlier than v4.0.0 and insecure authentication no authentication is required.
Admin API (internal)
The internal API used by the Admin UI (unleash-frontend). Since v4.0.0 all operations require an API token with Admin level access:
With versions earlier than v4.0.0 and insecure authentication Basic Auth (with curl -u myemail@test.com:) is enough.
System API's
Content-Type
All endpoints require application/json as content type, so if you're using curl remember to add
-H "Content-Type: application/json"