MongoDB Atlas Administration API OpenAPI Specification 3.0

This repository hosts the OpenAPI specification for the Atlas Administration API (v2.0).

Tools

This repository also contains tools for validating, generating, and distributing OpenAPI specifications.

FOASCLI

The tools/cli directory hosts a Go-based CLI tool used to merge multiple OpenAPI specifications into a single federated specification, which is used for the Admin APIs.

For more details, please refer to the CLI’s README.md.

Spectral

The tools/spectral directory contains MongoDB-specific Spectral rule definitions. These rules are used to validate that the generated OpenAPI specifications comply with MongoDB’s guidelines.

For more details, please refer to the Spectral’s README.md.

Postman

The tools/postman directory contains the logic required to generate the MongoDB Atlas Postman collections.

For more details, please refer to the Spectral’s README.md.

Contributing

See our CONTRIBUTING.md guide.