Skip to content
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.

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

CLOUDP-267379: Add collection description to generated collections #166

Merged
merged 2 commits into from
Aug 14, 2024

Conversation

Luke-Sanderson
Copy link
Contributor

@Luke-Sanderson Luke-Sanderson commented Aug 14, 2024

Proposed changes

  • Set the collection description equal to markdown file.
  • Tested locally and uploaded to a private Postman account
  • Markdown provided by Jeff Vincent from Docs team

Jira ticket: CLOUDP-267379

Checklist

  • I have signed the MongoDB CLA
  • I have added tests that prove my fix is effective or that my feature works

Further comments

@Luke-Sanderson Luke-Sanderson marked this pull request as ready for review August 14, 2024 10:54
@Luke-Sanderson Luke-Sanderson requested a review from a team as a code owner August 14, 2024 10:54
To test out the MongoDB Atlas Admin API collection, start by [creating a free MongoDB Atlas cluster](https://www.mongodb.com/docs/atlas/tutorial/deploy-free-tier-cluster/).
Once you have a cluster, you can [fork this collection](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/\#create-a-fork) into your own workspace in order to manage your MongoDB Atlas resources. Make sure to also fork the MongoDB Atlas Administration API Environment at the same time.

Once you have your cluster up and running, follow [this guide](https://www.mongodb.com/docs/atlas/configure-api-access/) to find your public and private API keys. Set each of these values as secrets in the Postman Vault:
Copy link
Collaborator

Choose a reason for hiding this comment

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

in the Postman Vault

nit; would it make sense to include a link to postman vault docs?
https://learning.postman.com/docs/sending-requests/postman-vault/postman-vault-secrets/

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yup that would be a good addition, the more links the better

Copy link
Collaborator

@matt-condon matt-condon left a comment

Choose a reason for hiding this comment

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

LGTM

@Luke-Sanderson Luke-Sanderson merged commit c094176 into main Aug 14, 2024
9 checks passed
@Luke-Sanderson Luke-Sanderson deleted the CLOUDP-267379 branch August 14, 2024 11:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants