Product · Jun 4, 2023
What’s new in Criteria — May 2023
May saw support for Spectral rulesets, Swagger 2.0 documents and more granular configuration of API styles.
Configure active styles
Earlier this year we released API Issues, which provide you with immediate targeted feedback when designing an API. Issues are generated from API styles, such as "All operations should have a default error response" or "All create operations should use POST".
It's not possible to see all styles that are in effect for your API, as well as turn them on or off according to your needs.
API Styles can be found in the settings view of your API:
Sync your Spectral rulesets
Spectral is a popular open source tool for linting OpenAPI, and AsyncAPI documents. It can be configured with out-of-the-box rulesets or customized according to your company's style guide.
Criteria now supports syncing your Spectral rulesets, and will show warnings and errors in the Issues view.
To get started:
- Open the Styles tab in the Settings view of your API.
- Click Set Up GitHub.
- Give Criteria read access to your repository.
- Specify the branch and path to your main ruleset file.
Migrate Swagger 2.0 documents
Version 3.0 of the OpenAPI specification was released in 2017. Despite this, many tools still produce an earlier version of the specification known as Swagger 2.0.
Criteria now supports importing Swagger 2.0 documents. They will automatically be migrated to the latest version upon import.
We’d love to hear what you think about the enhancements we've made this month. Contact us at firstname.lastname@example.org to share your thoughts and feedback.