TAX-2677: docs(tax) - Add v3 tax class batch endpoints OpenAPI spec#1301
Merged
bc-vincent-zhao merged 18 commits intomainfrom Apr 1, 2026
Merged
TAX-2677: docs(tax) - Add v3 tax class batch endpoints OpenAPI spec#1301bc-vincent-zhao merged 18 commits intomainfrom
bc-vincent-zhao merged 18 commits intomainfrom
Conversation
theromulans
reviewed
Mar 31, 2026
theromulans
reviewed
Mar 31, 2026
theromulans
reviewed
Mar 31, 2026
theromulans
reviewed
Mar 31, 2026
theromulans
reviewed
Mar 31, 2026
theromulans
reviewed
Mar 31, 2026
Contributor
|
Thanks for this, would be excellent to get our documentation update up and running 👏 |
…batch spec Rewrite descriptions to be public-facing: remove PHP class names, internal route details, implementation exception references, and all uses of "internal" as a label. Port info metadata and security scheme style from v2 spec. Refs TAX-2677 Co-Authored-By: Claude <noreply@anthropic.com>
Replace internal API host with standard BigCommerce API Gateway server configuration, matching the pattern used in the v2 tax classes spec. Refs TAX-2677 Co-Authored-By: Claude <noreply@anthropic.com>
- Rename path /tax/class to /tax/classes - Rename tag to "Tax Classes" to match conventions used elsewhere - Remove "Batch" prefix from operation summaries - Move name character restriction detail to the name field schema description - Fix uniqueness scope: names must be unique across the store, not just the batch - Update info description per reviewer suggestion Refs TAX-2677 Co-Authored-By: Claude <noreply@anthropic.com>
Refs TAX-2677 Co-Authored-By: Claude <noreply@anthropic.com>
Refs TAX-2677 Co-Authored-By: Claude <noreply@anthropic.com>
…X permission Refs TAX-2677 Co-Authored-By: Claude <noreply@anthropic.com>
bc-vincent-zhao
force-pushed
the
tax_classes_v3
branch
from
748bf31 to
7d1158b
Compare
theromulans
reviewed
Apr 1, 2026
theromulans
reviewed
Apr 1, 2026
Update PUT and DELETE operation summaries to remove "Batch" prefix. Capitalize "IDs" consistently throughout DELETE endpoint descriptions and replace "batch" with "request" in uniqueness constraint text. Refs TAX-2677 Co-Authored-By: Claude <noreply@anthropic.com>
bc-vincent-zhao
commented
Apr 1, 2026
Contributor
Author
bc-vincent-zhao
left a comment
bc-vincent-zhao
left a comment
There was a problem hiding this comment.
thanks @theromulans updated as you recommended.
theromulans
reviewed
Apr 1, 2026
theromulans
reviewed
Apr 1, 2026
Capitalize "id" to "ID" in the 422 error description for the batch update endpoint, consistent with capitalization elsewhere in the spec. Refs TAX-2677 Co-Authored-By: Claude <noreply@anthropic.com>
Capitalize "ids" to "IDs" in the info description for the DELETE endpoint for consistent terminology throughout the spec. Refs TAX-2677 Co-Authored-By: Claude <noreply@anthropic.com>
theromulans
reviewed
Apr 1, 2026
Co-authored-by: Brett Daniels <theromulans@gmail.com>
Co-authored-by: Brett Daniels <theromulans@gmail.com>
Co-authored-by: Brett Daniels <theromulans@gmail.com>
Co-authored-by: Brett Daniels <theromulans@gmail.com>
Co-authored-by: Brett Daniels <theromulans@gmail.com>
Co-authored-by: Brett Daniels <theromulans@gmail.com>
Co-authored-by: Brett Daniels <theromulans@gmail.com>
theromulans
approved these changes
Apr 1, 2026
Contributor
theromulans
left a comment
theromulans
left a comment
There was a problem hiding this comment.
🚀 Thanks @bc-vincent-zhao !
Contributor
|
@bc-vincent-zhao Is your expectation that these docs should appear online without any further work? Just observing the |
Contributor
Author
|
@theromulans thanks for the reminder, yes, I was expecting the new endpoint automatically appear on dev doc, I may have missed a nav link update, let me double check. |
Contributor
Author
|
@bigcommerce/dev-docs-team would you please help us understand how to get a new endpoint published ? In this PR I created a entire new swagger yml for v3 tax classes endpoint, how can I get it published alongside the current v2 version (https://developer.bigcommerce.com/docs/rest-management/tax/tax-classes) ? Thanks in advance 🙇 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Jira: TAX-2677
What/Why?
Adds a new OpenAPI 3.0 spec (
reference/tax_classes.v3.yaml) documenting the internal v1 Tax API batch endpoints for tax classes (POST /tax/class,PUT /tax/class,DELETE /tax/class).Key details captured in the spec:
TaxBatchResourceValidator)DELETEusesid:inquery filter; path segment:idis ignored{ "data": ..., "meta": ... })Rollout/Rollback
Documentation-only change — no code deployed. No rollback needed.
Testing
Verify the spec renders correctly in the docs portal and that all three batch endpoints (POST, PUT, DELETE) display with accurate request/response schemas.
Fixes TAX-2677
Co-Authored-By: Claude noreply@anthropic.com