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

chore: generate openapi specs for organization endpoint for v1 and v2 #5648

Merged
merged 11 commits into from
Aug 21, 2024

Conversation

hrithikesh026
Copy link
Contributor

@hrithikesh026 hrithikesh026 commented Aug 20, 2024

Type of Change

  • Bugfix
  • New feature
  • Enhancement
  • Refactoring
  • Dependency updates
  • Documentation
  • CI/CD

Description

generated openapi specs for organization endpoint for v1 and v2

Additional Changes

  • This PR modifies the API contract
  • This PR modifies the database schema
  • This PR modifies application configuration/environment variables

Motivation and Context

How did you test it?

verified that the generated open_api_spec file is valid by running
swagger-cli validate ./api-reference/openapi_spec.json

Checked if new endpoints are being rendered in mintlify
v2
Screenshot 2024-08-20 at 5 22 03 PM

v1
Screenshot 2024-08-20 at 5 16 43 PM

Checklist

  • I formatted the code cargo +nightly fmt --all
  • I addressed lints thrown by cargo clippy
  • I reviewed the submitted code
  • I added unit tests for my changes where possible

@hrithikesh026 hrithikesh026 added S-waiting-on-review Status: This PR has been implemented and needs to be reviewed api-v2 labels Aug 20, 2024
@hrithikesh026 hrithikesh026 added this to the August 2024 Release milestone Aug 20, 2024
@hrithikesh026 hrithikesh026 self-assigned this Aug 20, 2024
@hrithikesh026 hrithikesh026 requested review from a team as code owners August 20, 2024 08:49
@hyperswitch-bot hyperswitch-bot bot added the M-api-contract-changes Metadata: This PR involves API contract changes label Aug 20, 2024
SanchithHegde
SanchithHegde previously approved these changes Aug 20, 2024
Copy link
Member

@Narayanbhat166 Narayanbhat166 left a comment

Choose a reason for hiding this comment

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

can you try to render the openapi locally and check if the endpoints are rendered?

You can follow the steps mentioned here https://mintlify.com/docs/development

@@ -69,6 +69,11 @@ Never share your secret api keys. Keep them guarded and secure.
),
// The paths will be displayed in the same order as they are registered here
paths(
// Routes for Organization
routes::organization::organization_create,
Copy link
Member

Choose a reason for hiding this comment

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

in order to add these endpoints to mintlify you will have to run this command, run it separately for both v1 and v2 folders

npx @mintlify/scraping@latest openapi-file openapi_spec.json -o api-reference

SanchithHegde
SanchithHegde previously approved these changes Aug 20, 2024
Narayanbhat166
Narayanbhat166 previously approved these changes Aug 20, 2024
@@ -0,0 +1,3 @@
---
openapi: post /organization
Copy link
Member

Choose a reason for hiding this comment

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

V2 will have v2 prefix

Copy link
Member

Choose a reason for hiding this comment

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

In other places too

@likhinbopanna likhinbopanna added this pull request to the merge queue Aug 21, 2024
Merged via the queue into main with commit 1d08c7b Aug 21, 2024
13 of 14 checks passed
@likhinbopanna likhinbopanna deleted the generate-openapi-specs-for-organization-endpoint branch August 21, 2024 11:40
@SanchithHegde SanchithHegde removed the S-waiting-on-review Status: This PR has been implemented and needs to be reviewed label Aug 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api-v2 M-api-contract-changes Metadata: This PR involves API contract changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants