Skip to content

Rename Payment Handler API --> Web-based Payment Handler API#43238

Merged
hamishwillee merged 2 commits intomdn:mainfrom
stephenmcgruer:web-based-payment-handlers
Mar 8, 2026
Merged

Rename Payment Handler API --> Web-based Payment Handler API#43238
hamishwillee merged 2 commits intomdn:mainfrom
stephenmcgruer:web-based-payment-handlers

Conversation

@stephenmcgruer
Copy link
Contributor

Description

Rename files referencing the "Payment Handler API" to "Web-based Payment Handler API"

Motivation

This spec was renamed recently, see
https://w3c.github.io/web-based-payment-handler/

Additional details

Move was done via:

npm run content move web/api/payment_handler_api Web/API/Web_Based_Payment_Handler_API
node scripts/update-moved-file-links.js

Then individual edits to files.

Related issues and pull requests

@stephenmcgruer stephenmcgruer requested a review from a team as a code owner February 24, 2026 18:22
@stephenmcgruer stephenmcgruer requested review from hamishwillee and removed request for a team February 24, 2026 18:22
@github-actions github-actions bot added Content:WebAPI Web API docs Content:PWA Progressive Web Apps content size/s [PR only] 6-50 LoC changed labels Feb 24, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Feb 24, 2026

Preview URLs (26 pages)

Flaws (1)

Note! 25 documents with no flaws that don't need to be listed. 🎉

Found an unexpected or unresolvable flaw? Please report it here.

URL: /en-US/docs/Web/API/Permissions_API
Title: Permissions API
Flaw count: 1

  • broken_links:
    • Link /en-US/docs/Web/API/Web_Based_Payment_Handler_API doesn't resolve

(comment last updated: 2026-03-08 23:22:10)

Copy link
Collaborator

@hamishwillee hamishwillee left a comment

Choose a reason for hiding this comment

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

@stephenmcgruer Thanks very much.

Can you please also update https://github.com/mdn/content/blob/main/files/jsondata/GroupData.json#L1185

This defines the sidebar for Web API. It is why the flaw is being reported "Invalid slug for templ/sidebar: Web Based Payment Handler API" - because the macro for the sidebar can't find a key of that name.

Then test that the sidebar renders properly - just load locally and see that the interfaces are in the sidebar still when you look at the Payment API page.

Did you grep the rest of the document source to check for mention of the API?

@stephenmcgruer stephenmcgruer requested a review from a team as a code owner March 5, 2026 23:09
@stephenmcgruer stephenmcgruer requested review from pepelsbey and removed request for a team March 5, 2026 23:09
@stephenmcgruer
Copy link
Contributor Author

Thanks for the review! I've now done a much more thorough pass, as well as learned a bit more about how MDN references work. Not ready for re-review quite yet, I just wanted to be able to examine my changes in the GitHub UI . Will flag for re-review when ready :).

@github-actions github-actions bot added Content:Security Security docs size/m [PR only] 51-500 LoC changed and removed size/s [PR only] 6-50 LoC changed labels Mar 5, 2026
@stephenmcgruer stephenmcgruer force-pushed the web-based-payment-handlers branch 2 times, most recently from e3ee1d1 to bead4d3 Compare March 5, 2026 23:34
This spec was renamed recently, see
https://w3c.github.io/web-based-payment-handler/

Move was done via:

npm run content move web/api/payment_handler_api Web/API/Web_Based_Payment_Handler_API
node scripts/update-moved-file-links.js

Then individual edits to files.
@stephenmcgruer stephenmcgruer force-pushed the web-based-payment-handlers branch from bead4d3 to 958862d Compare March 5, 2026 23:40
Copy link
Contributor Author

@stephenmcgruer stephenmcgruer left a comment

Choose a reason for hiding this comment

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

Ok, ready for review now I think.

## See also

- {{domxref("Payment Handler API", "Payment Handler API", "", "nocode")}}
- {{domxref("Web-based Payment Handler API", "", "", "nocode")}}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

A number of files had what I believe is an unnecessary duplication of "Payment Handler API" here, because you only (?) need that if you want the rendered text to be different than the link/reference first parameter. Lmk if that wasn't correct and I can restore the duplication.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Correct - this is if you want to use a different text to the page title.

FWIW

  • personally I never use domxref for guide links because there is no benefit to it and the rendering is less clear to editors - I do [Whatever text I want](https://pr43238.review.mdn.allizom.net/en-US/docs/Web/API/Web-Based_Payment_Handler_API).
    But I don't bother changing it either when I see cases like this.
  • More generally, in the Web API section we are ambivalent about using domxref of a bare link. Again though, we don't change them to one or the other in review. CSS section takes a different view and always uses the macro.

"properties": [],
"events": []
},
"Web-Based Payment Handler API": {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The two .json files appear to be in alphabetical order, but I wasn't sure how they treat the order of a dash "-" vs an alphabetical character. Lmk! :)

Copy link
Collaborator

Choose a reason for hiding this comment

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

I have no idea. Assume - is whitespace unless someone explicitly argues.

Copy link
Collaborator

@hamishwillee hamishwillee left a comment

Choose a reason for hiding this comment

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

@stephenmcgruer Thanks very much.

FYI, the macro reference is case sensitive, so the related APIs were'n't working properly:

Image

Fixed in 34432ee

@hamishwillee hamishwillee merged commit 73ca80b into mdn:main Mar 8, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Content:PWA Progressive Web Apps content Content:Security Security docs Content:WebAPI Web API docs size/m [PR only] 51-500 LoC changed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants