Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
Code Issues Projects Releases Wiki Activity

docs: not on latest unleash with openapi enabeld (#4024)

Browse Source
This commit is contained in:
Mateusz Kwasniewski 2023-07-03 13:48:46 +02:00 committed by GitHub
parent aa7627bc0b
commit d3b3652984
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
website/docs/how-to/how-to-enable-openapi.mdx
View File

@ -9,6 +9,7 @@ import TabItem from '@theme/TabItem';
:::info Availability :::info Availability
OpenAPI schemas were introduced in v4.13.0 of Unleash and v0.10.0 of the Unleash proxy. OpenAPI schemas were introduced in v4.13.0 of Unleash and v0.10.0 of the Unleash proxy.
Since v5.2.0 Unleash has OpenAPI enabled by default.
::: :::
@ -34,6 +35,8 @@ Similarly, if you're running the Unleash proxy locally at `http://localhost:3000
The OpenAPI spec and the Swagger UI can be turned on either via environment variables or via configuration options. Configuration options take precedence over environment variables. The OpenAPI spec and the Swagger UI can be turned on either via environment variables or via configuration options. Configuration options take precedence over environment variables.
If you are using Unleash v5.2.0, OpenAPI is enabled by default. You still need to enable it for Unleash proxy.
### Enable OpenAPI via environment variables ### Enable OpenAPI via environment variables
To turn on OpenAPI via environment variables, set the `ENABLE_OAS` to `true` in the environment you're running the server in. To turn on OpenAPI via environment variables, set the `ENABLE_OAS` to `true` in the environment you're running the server in.