From dac08218e2fb75b15758fb8fb9b2f70b48b89de7 Mon Sep 17 00:00:00 2001 From: Wojciech Trocki Date: Tue, 18 Feb 2025 11:38:06 +0100 Subject: [PATCH 1/2] Doc: Expose information about openapi tooling --- tools/README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 tools/README.md diff --git a/tools/README.md b/tools/README.md new file mode 100644 index 0000000000..33d2937c3e --- /dev/null +++ b/tools/README.md @@ -0,0 +1,17 @@ +# 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 from OpenAPI specifications. +The automated process ensures that the Postman workspace is always synchronized with the latest API updates. + +## SPECTRAL + +This segment focuses on using Spectral for OpenAPI specification validation. +Any changes to rules or configuration in `.spectral.yaml` will automatically update OpenAPI validations across the MongoDB OpenAPI repository. + +## CLI + +OpenAPI CLI. Internal MongoDB CLI used for OpenAPI transformations. From a1f40fd7c9f8a02052b4280085065a7c72c4cc6a Mon Sep 17 00:00:00 2001 From: Wojciech Trocki Date: Tue, 18 Feb 2025 11:44:05 +0100 Subject: [PATCH 2/2] Update README.md shorten introduction --- tools/README.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/tools/README.md b/tools/README.md index 33d2937c3e..f99c9414c7 100644 --- a/tools/README.md +++ b/tools/README.md @@ -2,15 +2,13 @@ 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 +## Postman -Includes resources and scripts to generate MongoDB Atlas Postman Collections from OpenAPI specifications. -The automated process ensures that the Postman workspace is always synchronized with the latest API updates. +Includes resources and scripts to generate [MongoDB Atlas Postman Collections](https://www.mongodb.com/developer/products/atlas/admin-api-postman/) from OpenAPI specifications. -## SPECTRAL +## Spectral -This segment focuses on using Spectral for OpenAPI specification validation. -Any changes to rules or configuration in `.spectral.yaml` will automatically update OpenAPI validations across the MongoDB OpenAPI repository. +MongoDB [Spectral](https://github.com/stoplightio/spectral) OpenAPI specification validation rules ## CLI