Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): update Swagger Aggregator documentation #1805

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/runtime_suite/swagger-aggregator/20_configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,3 +222,30 @@ Please be sure to validate the configuration with the following <a download targ
:::info
For additional information about more advanced properties that can be defined in the swagger-aggregator configuration (e.g., `subSwaggers` property) visit [this page](../../development_suite/api-console/advanced-section/swagger-aggregator/configuration).
:::

### Security
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


In order to change the default security method edit the items `baseSwagger.securityDefinitions` and `baseSwagger.security` in the configuration file.

Here is an example of how to enable bearer token authorization according to the [official OpenAPI documentation](https://swagger.io/docs/specification/authentication/bearer-authentication)

```
"baseSwagger": {
"securityDefinitions": {
"BearerToken": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
}
},
"security": [
{
"BearerToken": []
}
]
}
```

## FAQs

You can find some FAQs about Swagger Aggregator and API Portal at [this](../../runtime_suite_applications/api-documentation-aggregator/faqs) link.
13 changes: 13 additions & 0 deletions docs/runtime_suite/swagger-aggregator/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,19 @@ DO NOT MODIFY IT BY HAND.
Instead, modify the source file and run the aggregator to regenerate this file.
-->

## [3.8.2] 2024-11-27

### Security

- Added SBOM and docker image sign
- Fix vulnerabilities

## [3.8.1] 2024-11-25

### Fixed

- Changed `oauthFlows.password.tokenUrl` format from `uri` to `uri-reference` in OpenApi 3.1 schema

## [3.8.0] 2024-08-26

### Added
Expand Down