1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00

Docs: update unleash proxy API img (#2478)

This change updates the proxy API illustration with the correct payload. It also adds a caption to better explain what is going on (and to make it more accessible).

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
This commit is contained in:
NicolaeUnleash 2022-11-23 14:27:59 +02:00 committed by GitHub
parent 98a9a770d2
commit bf13009a00
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 2 additions and 1 deletions

View File

@ -2,6 +2,7 @@
id: unleash-proxy id: unleash-proxy
title: Unleash Proxy title: Unleash Proxy
--- ---
import Figure from '@site/src/components/Figure/Figure.tsx'
> The unleash-proxy is compatible with all Unleash Enterprise versions and Unleash Open-Source v4. You should reach out to **support@getunleash.io** if you want the Unleash Team to host the Unleash Proxy for you. > The unleash-proxy is compatible with all Unleash Enterprise versions and Unleash Open-Source v4. You should reach out to **support@getunleash.io** if you want the Unleash Team to host the Unleash Proxy for you.
@ -138,7 +139,7 @@ Refer the [custom activation strategy documentation](../reference/custom-activat
The Unleash Proxy has a very simple API. It takes the [Unleash Context](../reference/unleash-context) as input and will return the feature toggles relevant for that specific context. The Unleash Proxy has a very simple API. It takes the [Unleash Context](../reference/unleash-context) as input and will return the feature toggles relevant for that specific context.
![The Unleash Proxy](/img/The-Unleash-Proxy-API.png) <Figure img="/img/The-Unleash-Proxy-API.png" caption="When sending requests to the Unleash proxy's /proxy endpoint, the request should contain the current Unleash context as the payload. The proxy will return all enabled toggles for the provided context."/>
### OpenAPI integration and API documentation {#openapi} ### OpenAPI integration and API documentation {#openapi}

Binary file not shown.

Before

Width:  |  Height:  |  Size: 65 KiB

After

Width:  |  Height:  |  Size: 65 KiB