Skip to content

Doc: Expose information about openapi tooling #431

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 18, 2025
Merged

Doc: Expose information about openapi tooling #431

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dac0821
Doc: Expose information about openapi tooling
wtrocki Feb 18, 2025
a1f40fd
Update README.md
wtrocki Feb 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions tools/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: it doesn't happen automatically so I'd not say this to avoid misleading, there is a readmme about updating spectral reference somewhere if you want to link it

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed.


## CLI

OpenAPI CLI. Internal MongoDB CLI used for OpenAPI transformations.
Loading