Skip to content

refactor: centralize API slug mapping into a single file#903

Open
brunoamui wants to merge 2 commits intomainfrom
sync-api-reference-mapping
Open

refactor: centralize API slug mapping into a single file#903
brunoamui wants to merge 2 commits intomainfrom
sync-api-reference-mapping

Conversation

@brunoamui
Copy link
Copy Markdown
Collaborator

Creates a dedicated api-slug-mapping.ts file to centralize the mapping between API

display names and their slugs. Updates all files to use this mapping and adds documentation.

What is the purpose of this pull request?

What problem is this solving?

How should this be manually tested?

Screenshots or example usage

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Requires change to documentation, which has been updated accordingly.

brunoamui and others added 2 commits March 14, 2025 13:33
Creates a dedicated api-slug-mapping.ts file to centralize the mapping between API

display names and their slugs. Updates all files to use this mapping and adds documentation.
@netlify
Copy link
Copy Markdown

netlify bot commented Mar 14, 2025

Deploy Preview for elated-hoover-5c29bf ready!

Name Link
🔨 Latest commit fef7a53
🔍 Latest deploy log https://app.netlify.com/sites/elated-hoover-5c29bf/deploys/67d45aa20dad64000833b178
😎 Deploy Preview https://deploy-preview-903--elated-hoover-5c29bf.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Copy Markdown

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

This pull request does not contain a valid label. Please add one of the following labels: ['release-no', 'release-auto', 'release-patch', 'release-minor', 'release-major']

@netlify
Copy link
Copy Markdown

netlify bot commented Mar 14, 2025

Deploy Preview for elated-hoover-5c29bf ready!

Name Link
🔨 Latest commit 014de6f
🔍 Latest deploy log https://app.netlify.com/sites/elated-hoover-5c29bf/deploys/67d4757e21aed000088b151c
😎 Deploy Preview https://deploy-preview-903--elated-hoover-5c29bf.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 14, 2025

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 14, 2025

A total of 11 tests failed!

API guides documentation page

3 failing tests:

  • Check if a random guide page, chosen using the sidebar, loads (/docs/guides)
  • try to click on any document contributor (/docs/guides)
  • try to send feedback (/docs/guides)

Status of documentation pages

8 failing tests:

  • Checks page docs/apps/vtex.store-icons/iconpack
  • Checks page docs/apps/vtex.store-icons/iconpack
  • Checks page docs/apps/vtex.store-icons/iconpack
  • Checks page docs/apps/vtex.store-icons/iconpack
  • Checks page docs/guides/adding-custom-headers-to-your-store-framework-store
  • Checks page docs/guides/adding-custom-headers-to-your-store-framework-store
  • Checks page docs/guides/adding-custom-headers-to-your-store-framework-store
  • Checks page docs/guides/adding-custom-headers-to-your-store-framework-store

For more information, open the cypress action summary page.

@github-actions
Copy link
Copy Markdown

A total of 9 tests failed!

API reference documentation page

9 failing tests:

  • Check if a random guide page, chosen using the sidebar, loads (/docs/api-reference)
  • Check if a random guide page, chosen using the sidebar, loads (/docs/api-reference)
  • Check if a random guide page, chosen using the sidebar, loads (/docs/api-reference)
  • Check if it has a title (/docs/api-reference)
  • Check if it has a title (/docs/api-reference)
  • Check if it has a title (/docs/api-reference)
  • Check if the response tab is clickable and, after it, if the response appeared (/docs/api-reference)
  • Check if the response tab is clickable and, after it, if the response appeared (/docs/api-reference)
  • Check if the response tab is clickable and, after it, if the response appeared (/docs/api-reference)

For more information, open the cypress action summary page.

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.

1 participant