Skip to content

@W-19995399 - Add Rules for Custom API in Dev Guidelines#3413

Merged
shauryemahajanSF merged 2 commits intodevelopfrom
t/commerce/W-19995399/rulesForCustomAPis
Oct 21, 2025
Merged

@W-19995399 - Add Rules for Custom API in Dev Guidelines#3413
shauryemahajanSF merged 2 commits intodevelopfrom
t/commerce/W-19995399/rulesForCustomAPis

Conversation

@shauryemahajanSF
Copy link
Contributor

Description

Add implementation guidelines for custom APIs so that the results of the custom API discovery tool can be used in the PWA kit to create functional code.

Types of Changes

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Documentation update
  • Breaking change (could cause existing functionality to not work as expected)
  • Other changes (non-breaking changes that does not fit any of the above)

Breaking changes include:

  • Removing a public function or component or prop
  • Adding a required argument to a function
  • Changing the data type of a function parameter or return value
  • Adding a new peer dependency to package.json

How to Test-Drive This PR

  • Call Custom API Tool and use results to create a new hook or component.

Checklists

General

  • Changes are covered by test cases
  • CHANGELOG.md updated with a short description of changes (not required for documentation updates)

Accessibility Compliance

You must check off all items in one of the follow two lists:

  • There are no changes to UI

or...

Localization

  • Changes include a UI text update in the Retail React App (which requires translation)

@cc-prodsec
Copy link
Collaborator

cc-prodsec commented Oct 21, 2025

Snyk checks have passed. No issues have been found so far.

Status Scanner Critical High Medium Low Total (0)
Licenses 0 0 0 0 0 issues
Open Source Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@shauryemahajanSF shauryemahajanSF marked this pull request as ready for review October 21, 2025 20:56
@shauryemahajanSF shauryemahajanSF requested a review from a team as a code owner October 21, 2025 20:56
Copy link
Contributor

@snilakandan13 snilakandan13 left a comment

Choose a reason for hiding this comment

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

Looks good

@shauryemahajanSF shauryemahajanSF merged commit 1688036 into develop Oct 21, 2025
42 checks passed
@shauryemahajanSF shauryemahajanSF deleted the t/commerce/W-19995399/rulesForCustomAPis branch October 21, 2025 22:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants