-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
docs(openapi): Fixed API documentation for V2 #6496
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hyperswitch-bot
bot
added
the
M-api-contract-changes
Metadata: This PR involves API contract changes
label
Nov 6, 2024
AnuthaDev
added
the
S-waiting-on-review
Status: This PR has been implemented and needs to be reviewed
label
Nov 6, 2024
jarnura
approved these changes
Nov 7, 2024
SanchithHegde
approved these changes
Nov 8, 2024
14 tasks
SanchithHegde
removed
the
S-waiting-on-review
Status: This PR has been implemented and needs to be reviewed
label
Nov 17, 2024
bsayak03
pushed a commit
that referenced
this pull request
Nov 26, 2024
bsayak03
pushed a commit
that referenced
this pull request
Nov 26, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
api-v2
C-doc
Category: Documentation updates
M-api-contract-changes
Metadata: This PR involves API contract changes
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Type of Change
Description
Improved OpenAPI documentation for V2
Additional Changes
Issues Addressed
Merchant Account Update: Path Parameters in definition says it is {account_id} instead that should be {id}
Merchant Profile List Changes: Instead
Profile - list
makeMerchant Account - Profile List
, Path Parameters in definition says it is {account_id} instead that should be {id}Profile Changes: In profile all routes has [profile_id] in the path, change the path to [id] and the explanation in path parameter also to [id]. For
Merchant Connector - list
in side-bar, change toProfile - Connector Accounts list
. In the definition of the apiList Merchant Connector Details for the business profile
insteadList Connector Accounts for the profile
Connector Account Changes: Instead of
Merchant Connector Account
use the termConnector Account
Api-Key Changes: In the path param and its definition we are using {key_id] instead use [id]
Routing Changes: In path param and its definition we are using {routing_algorithm_id} instead is {id] , these changes are in api-documentation
How did you test it?
Checklist
cargo +nightly fmt --all
cargo clippy