Swagger/OpenAPI Integration

Swagger

Ortelius uses Swagger to display your microservice / API documentation, based on your Component Version. Developers create, or automate the creation of Swagger/OpenAPI documentation. Once created the Swagger/OpenAPI documentation can be associated to the Component Version.

Uploading Swagger/OpenAPI Documentation

You can use the Ortelius Component Detail view to manually upload your Swagger/OpenAPI documentation for your Component. Alternatively, the recommended approach is to use the CI/CD Command Line Interface to automatically add your Swagger/OpenAPI documentation file. Refer to the CI/CD CLI details for incorporating Swagger/OpenAPI into your pipeline process.

Note: Swagger or OpenAPI formats can be used.

Viewing Component CVE Data

Swagger/OpenAPI data is associated to a particular Component Version and can be seen by going to the Component Detail View.