Skip to content

fix: payment policies api routes update (EDU-19248) - #1753

Merged
ricardoaerobr merged 7 commits into
masterfrom
EDU-19248---Fix-Payment-Policies-API-routes
Aug 7, 2026
Merged

fix: payment policies api routes update (EDU-19248)#1753
ricardoaerobr merged 7 commits into
masterfrom
EDU-19248---Fix-Payment-Policies-API-routes

Conversation

@ricardoaerobr

Copy link
Copy Markdown
Contributor

PR created to move the account info from the URL route to a query string position (EDU-19248).

Types of changes

  • New content (endpoints, descriptions or fields from scratch)
  • Improvement (make an endpoint's title or description even better)
  • Spelling and grammar accuracy (self-explanatory)

Changelog

Do not forget to update your changes to our Developer Portal's changelog. Did you create a release note?

  • Yes, I already created a release note about this change.
  • Not yet, but I'm going to.
  • No, it's just a fix.

@ricardoaerobr ricardoaerobr self-assigned this Aug 7, 2026
@ricardoaerobr ricardoaerobr added the documentation Improvements or additions to documentation label Aug 7, 2026
@vtex-pr-sentinel

Copy link
Copy Markdown

🛡️ SDD Check — action required

I couldn't detect an SDD in this PR. Please check one option below (requires write access to the repo):

  • SDD lives in another PR — paste the SDD PR URL here:
  • This PR doesn't need an SDD
  • SDD applies, but I'm not adopting it in this PR

@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown

OpenAPI Preview

Preview the changed specs:

Links point to commit 573a059. They will update on each new push to this PR.

@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown

Thanks for your contribution. The .json file will be checked now with Spectral.

Comment thread VTEX - Payment Policies API.json Outdated
Comment thread VTEX - Payment Policies API.json Outdated
Comment thread VTEX - Payment Policies API.json Outdated
Comment thread VTEX - Payment Policies API.json Outdated

@PedroAntunesCosta PedroAntunesCosta left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The parameter/server mechanics of the fix are correct and match what the Jira ticket describes as the real API contract. However, the operation descriptions for all 5 CRUD-style endpoints still say the account is "identified by the accountName URL variable" — that variable no longer exists after this PR, so the docs would ship with a new inaccuracy of the same kind this ticket was opened to fix. That's the one blocking item; the rest are minor consistency suggestions.

@PedroAntunesCosta PedroAntunesCosta left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

All 4 prior recommendations were fixed exactly as suggested. No new issues found in the follow-up pass.

@ricardoaerobr
ricardoaerobr merged commit 0d207e5 into master Aug 7, 2026
1 check failed
@ricardoaerobr
ricardoaerobr deleted the EDU-19248---Fix-Payment-Policies-API-routes branch August 7, 2026 22:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants