Skip to content

Commit 449c2ab

Browse files
2024052802 - API v5.0 (#58)
Updated JSON schema for Developer Portal definition
1 parent 18f82b1 commit 449c2ab

6 files changed

+42
-14
lines changed

USAGE-v5.0.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,8 @@ Declaration path `.declaration.http.servers[].locations[].apigateway` defines th
111111
- `api_gateway.strip_uri` - removes the `.declaration.http.servers[].locations[].uri` part of the URI before forwarding requests to the upstream
112112
- `api_gateway.server_url` - the base URL of the upstream server
113113
- `developer_portal.enabled` - enable/disable Developer portal provisioning
114-
- `developer_portal.uri` - the trailing part of the Developer portal URI, this is appended to `.declaration.http.servers[].locations[].uri`. If omitted it defaults to `devportal.html`
114+
- `developer_portal.type` - developer portal type. Currently supported are: `redocly`
115+
- `developer_portal.redocly.uri` - the trailing part of the Developer portal URI, this is appended to `.declaration.http.servers[].locations[].uri`. If omitted it defaults to `devportal.html`
115116
- `authentication` - optional, used to enforce authentication at the API Gateway level
116117
- `authentication.client[]` - authentication profile names
117118
- `authentication.enforceOnPaths` - if set to `true` authentication is enforced on all API endpoints listed under `authentication.paths`. if set to `false` authentication is enforced on all API endpoints but those listed under `authentication.paths`

0 commit comments

Comments
 (0)