Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

brunoamui
Copy link
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.
Copy link

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

@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']

Copy link

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.

Copy link

github-actions bot commented Mar 14, 2025

Copy link

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.

Copy link

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