Skip to content

Commit dac0821

Browse files
authored
Doc: Expose information about openapi tooling
1 parent 7145b66 commit dac0821

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

tools/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# OpenAPI Tools for MongoDB Atlas
2+
3+
Folder contains essential tools and workflows for managing MongoDB Atlas API specifications and their integration with development tools like Postman and Spectral. Below is a summary of the functionalities provided in the subfolders:
4+
5+
## POSTMAN
6+
7+
Includes resources and scripts to generate MongoDB Atlas Postman Collections from OpenAPI specifications.
8+
The automated process ensures that the Postman workspace is always synchronized with the latest API updates.
9+
10+
## SPECTRAL
11+
12+
This segment focuses on using Spectral for OpenAPI specification validation.
13+
Any changes to rules or configuration in `.spectral.yaml` will automatically update OpenAPI validations across the MongoDB OpenAPI repository.
14+
15+
## CLI
16+
17+
OpenAPI CLI. Internal MongoDB CLI used for OpenAPI transformations.

0 commit comments

Comments
 (0)