Skip to content

Commit 7b09abd

Browse files
authored
Revert "chore(docs): update API Documentation Aggregator documentation (#1988)" (#1991)
This reverts commit d30ef2c.
1 parent d30ef2c commit 7b09abd

File tree

1 file changed

+1
-64
lines changed
  • docs/runtime_suite_applications/api-documentation-aggregator

1 file changed

+1
-64
lines changed

docs/runtime_suite_applications/api-documentation-aggregator/30_faqs.md

Lines changed: 1 addition & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ For example:
136136
The following information are applicable to a Swagger Aggregator version greater or equal than `3.8.0` and an API Portal version greater or equal than `2.1.0`.
137137
:::
138138

139-
To enable OAuth 2.0 authentication you need to edit the Swagger Aggregator [configuration](/development_suite/api-console/advanced-section/swagger-aggregator/configuration.md) by adding at the first level the `oauthConfig` object containing the desired [swagger-ui OAuth 2.0 configuration](https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/oauth2.md).
139+
To enable OAuth 2.0 authentication you need to edit the Swagger Aggregator [configuration](/development_suite/api-console/advanced-section/swagger-aggregator/configuration.md) by adding at first level the `oauthConfig` object containing the desired [swagger-ui OAuth 2.0 configuration](https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/oauth2.md).
140140

141141
For example:
142142
```json
@@ -167,66 +167,3 @@ For example:
167167
}
168168
}
169169
```
170-
171-
### How can I change the API Portal logo and favicon?
172-
173-
:::info
174-
A `Swagger Aggregator v3.9.0` or above and an `API Portal v2.2.0` or above are required for this feature
175-
:::
176-
177-
To customize the `API Portal` logo and favicon, you have to simply edit the Swagger Aggregator [configuration](/development_suite/api-console/advanced-section/swagger-aggregator/configuration.md) by adding at the first level the `apiPortalConfig` object, and setting the `logoUrl` and `faviconUrl`. You should write something like this:
178-
```
179-
{
180-
...
181-
"apiPortalConfig": {
182-
"logoUrl": "/your-logo-url",
183-
"faviconUrl": "/your-favicon-url"
184-
},
185-
}
186-
```
187-
188-
### How can I change the prefix of API Portal endpoints?
189-
190-
:::info
191-
A `Swagger Aggregator v3.9.0` or above and an `API Portal v2.2.0` or above are required for this feature
192-
:::
193-
194-
By default, `API Portal` endpoints have the `/api` prefix but you can change it by:
195-
1. Set the custom prefix in the Swagger Aggregator [configuration](/development_suite/api-console/advanced-section/swagger-aggregator/configuration.md)
196-
```json
197-
{
198-
...
199-
"apiPortalConfig": {
200-
"apiPrefix": "/custom-prefix",
201-
}
202-
}
203-
```
204-
2. Follow the [guide](/runtime_suite/api-portal/configuration#reroute-endpoints-on-a-custom-endpoint) on the API Portal
205-
206-
### How can I add the global servers options in the API Portal?
207-
208-
:::info
209-
A `Swagger Aggregator v3.9.0` or above and an `API Portal v2.2.0` or above are required for this feature
210-
:::
211-
212-
To add the global servers options, you have to add them in the `baseSwagger` object of the Swagger Aggregator [configuration](/development_suite/api-console/advanced-section/swagger-aggregator/configuration.md).
213-
The `servers` list comes from [OpenApi 2.0](https://swagger.io/specification/v2/).
214-
215-
You should write something like this:
216-
```json
217-
{
218-
...
219-
"baseSwagger": {
220-
"version": "2.0",
221-
"servers:" [
222-
{
223-
"url": "http://your-first-server"
224-
},
225-
{
226-
"url": "http://your-second-server",
227-
"description": "A nice description"
228-
}
229-
]
230-
}
231-
}
232-
```

0 commit comments

Comments
 (0)