diff --git a/tools/README.md b/tools/README.md new file mode 100644 index 0000000000..f99c9414c7 --- /dev/null +++ b/tools/README.md @@ -0,0 +1,15 @@ +# OpenAPI Tools for MongoDB Atlas + +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: + +## Postman + +Includes resources and scripts to generate [MongoDB Atlas Postman Collections](https://www.mongodb.com/developer/products/atlas/admin-api-postman/) from OpenAPI specifications. + +## Spectral + +MongoDB [Spectral](https://github.com/stoplightio/spectral) OpenAPI specification validation rules + +## CLI + +OpenAPI CLI. Internal MongoDB CLI used for OpenAPI transformations.