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

docs(openapi): Fixed API documentation for V2 #6496

Merged
merged 2 commits into from
Nov 12, 2024
Merged

docs(openapi): Fixed API documentation for V2 #6496

merged 2 commits into from
Nov 12, 2024

Conversation

AnuthaDev
Copy link
Contributor

@AnuthaDev AnuthaDev commented Nov 6, 2024

Type of Change

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

Description

Improved OpenAPI documentation for V2

Additional Changes

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

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 make Merchant 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 to Profile - Connector Accounts list. In the definition of the api
    List Merchant Connector Details for the business profile instead
    List Connector Accounts for the profile

  • Connector Account Changes: Instead of Merchant Connector Account use the term Connector 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

  • 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

@AnuthaDev AnuthaDev added C-doc Category: Documentation updates api-v2 labels Nov 6, 2024
@AnuthaDev AnuthaDev requested a review from a team as a code owner November 6, 2024 13:16
Copy link

semanticdiff-com bot commented Nov 6, 2024

Review changes with  SemanticDiff

Changed Files
File Status
  api-reference-v2/mint.json  65% smaller
  crates/openapi/src/routes/profile.rs  24% smaller
  crates/openapi/src/routes/merchant_connector_account.rs  1% smaller
  api-reference-v2/api-reference/api-key/api-key--retrieve.mdx Unsupported file format
  api-reference-v2/api-reference/api-key/api-key--revoke.mdx Unsupported file format
  api-reference-v2/api-reference/api-key/api-key--update.mdx Unsupported file format
  api-reference-v2/api-reference/connector-account/connector-account--create.mdx Unsupported file format
  api-reference-v2/api-reference/connector-account/connector-account--delete.mdx Unsupported file format
  api-reference-v2/api-reference/connector-account/connector-account--retrieve.mdx Unsupported file format
  api-reference-v2/api-reference/connector-account/connector-account--update.mdx Unsupported file format
  api-reference-v2/api-reference/merchant-account/business-profile--list.mdx Unsupported file format
  api-reference-v2/api-reference/payments/payments--session-token.mdx Unsupported file format
  api-reference-v2/api-reference/profile/merchant-connector--list.mdx Unsupported file format
  api-reference-v2/api-reference/profile/profile--activate-routing-algorithm.mdx Unsupported file format
  api-reference-v2/api-reference/profile/profile--deactivate-routing-algorithm.mdx Unsupported file format
  api-reference-v2/api-reference/profile/profile--retrieve-active-routing-algorithm.mdx Unsupported file format
  api-reference-v2/api-reference/profile/profile--retrieve-default-fallback-routing-algorithm.mdx Unsupported file format
  api-reference-v2/api-reference/profile/profile--retrieve.mdx Unsupported file format
  api-reference-v2/api-reference/profile/profile--update-default-fallback-routing-algorithm.mdx Unsupported file format
  api-reference-v2/api-reference/profile/profile--update.mdx Unsupported file format
  api-reference-v2/api-reference/routing/routing--retrieve.mdx Unsupported file format
  api-reference-v2/openapi_spec.json  0% smaller
  crates/openapi/src/openapi_v2.rs  0% smaller
  crates/openapi/src/routes/api_keys.rs  0% smaller
  crates/openapi/src/routes/merchant_account.rs  0% smaller
  crates/openapi/src/routes/payments.rs  0% smaller
  crates/openapi/src/routes/routing.rs  0% smaller

@AnuthaDev AnuthaDev linked an issue Nov 6, 2024 that may be closed by this pull request
@hyperswitch-bot hyperswitch-bot bot added the M-api-contract-changes Metadata: This PR involves API contract changes label Nov 6, 2024
@AnuthaDev AnuthaDev added the S-waiting-on-review Status: This PR has been implemented and needs to be reviewed label Nov 6, 2024
@AnuthaDev AnuthaDev self-assigned this Nov 8, 2024
@AnuthaDev AnuthaDev added this to the November 2024 Release milestone Nov 8, 2024
@likhinbopanna likhinbopanna added this pull request to the merge queue Nov 12, 2024
Merged via the queue into main with commit 7dfcd51 Nov 12, 2024
16 of 17 checks passed
@likhinbopanna likhinbopanna deleted the v2-docs branch November 12, 2024 07:16
@SanchithHegde SanchithHegde removed the S-waiting-on-review Status: This PR has been implemented and needs to be reviewed label Nov 17, 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOCS] FIx API documentation for V2
4 participants