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-264634: Add links to the docs page for each endpoint in the Postman Collection #132

Merged
merged 11 commits into from
Aug 2, 2024

Conversation

Luke-Sanderson
Copy link
Contributor

Proposed changes

  • Iterate through the OpenAPI Spec and save the json paths to each request
  • Iterate through each path and get the name, operationId, and tag for each request
  • Construct a URL to the docs page
  • Search the collection for the matching request and add the link to the description

Jira ticket: CLOUDP-264634

Checklist

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

Further comments

Alternative approaches taken. Instead of saving the paths, perform a search in the OpenAPI Spec for a matching summary for each title in the collection. This approach uses an extra search when compared to the proposed solution

@Luke-Sanderson Luke-Sanderson marked this pull request as ready for review August 2, 2024 10:48
@Luke-Sanderson Luke-Sanderson requested a review from a team as a code owner August 2, 2024 10:48
@Luke-Sanderson Luke-Sanderson merged commit fdcc5fd into main Aug 2, 2024
9 checks passed
@Luke-Sanderson Luke-Sanderson deleted the CLOUDP-264634 branch August 2, 2024 12:30
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