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(v2): Added 'X-Merchant-Id' to headers in Profile API docs #6291

Merged
merged 1 commit into from
Oct 14, 2024

Conversation

AnuthaDev
Copy link
Contributor

Type of Change

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

Description

Add X-Merchant-Id to headers in Profile endpoints for 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?

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 requested a review from a team as a code owner October 11, 2024 09:36
Copy link

semanticdiff-com bot commented Oct 11, 2024

Review changes with SemanticDiff.

Analyzed 2 of 2 files.

Overall, the semantic diff is 6% smaller than the GitHub diff.

Filename Status
✔️ crates/openapi/src/routes/profile.rs 15.3% smaller
✔️ api-reference-v2/openapi_spec.json Analyzed

@AnuthaDev AnuthaDev linked an issue Oct 11, 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 Oct 11, 2024
@AnuthaDev
Copy link
Contributor Author

Mintlify Screenshots (Notice the header field):
image

image image image

@SanchithHegde SanchithHegde added the C-doc Category: Documentation updates label Oct 14, 2024
"name": "X-Merchant-Id",
"in": "header",
"description": "Merchant ID of the profile.",
"required": true,
Copy link
Member

Choose a reason for hiding this comment

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

one small improvement can be made here, these headers are necessary only in case of admin api auth. The JWT auth has these handled. Again this is optional. For someone who is using the api reference would try it with admin api key only.

@likhinbopanna likhinbopanna added this pull request to the merge queue Oct 14, 2024
Merged via the queue into main with commit ca086d0 Oct 14, 2024
15 of 17 checks passed
@likhinbopanna likhinbopanna deleted the profile-doc-fix branch October 14, 2024 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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]: Add X-Merchant-Id to headers in Profile endpoints for v2
4 participants