Better note for /config

This commit is contained in:
Will Hunt 2018-06-28 17:23:57 +01:00 committed by GitHub
parent 1820df02d9
commit 21e957edfb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -276,9 +276,11 @@ paths:
All values are intentionally left optional. Clients SHOULD follow
the advice given in the field description when the field is not available.
**NOTE:** The /config endpoint is a guide. Other middleware such as
reverse proxies may apply their own configuration not described on this
endpoint.
**NOTE:** Both clients and server administrators should be aware that proxies
between the client and the server may affect the apparent behaviour of content
repository APIs, for example, proxies may enforce a lower upload size limit
than is advertised by the server on this endpoint. Clients should handle such
situations gracefully.
operationId: getConfig
produces: ["application/json"]
security: