Skip to content

Conversation

jeff-matthews
Copy link
Contributor

@jeff-matthews jeff-matthews commented Jul 12, 2025

Testing the <RedoclyAPIBlock>.

Staging

Note

If remote, connect to VPN.

https://developer-stage.adobe.com/commerce/webapi/reference/rest/saas/

Findings

  • You must use the path prefix (/commerce/webapi/) in the src prop.
  • You must save schema files in the static/ directory.
  • You must be on VPN to see the stage build (if remote). There appears to be some blocking JS related to the developer console sign in button at the top right of the page that prevents the page from loading if remote and not on VPN.
  • You must use the layout: none metadata to get full page width. This only seems to work for pages that 1) use the <RedoclyAPIBlock> AND 2) do not live in a directory referenced in a side nav file. Unfortunately, this hides the badge for SaaS only.
  • For some reason, the Redocly loader isn't displaying, which would be ideal since it takes ~3 seconds for the ACCS REST API reference to load. This might be mitigated by the loader that displays for the get credential component.
  • The <RedoclyAPIBlock> only supports a subset of Redocly config options. If we need the pagination option, we'll need to open an enhancement request for the Devsite team.
  • It looks like we might have more flexibility in what content that we include in the .md file where we reference the block. We probably don't want to include much content here and keep it barebones, but it's good to know. The current preview renders the H1 in the file for example.

@jeff-matthews jeff-matthews self-assigned this Jul 14, 2025
jeff-matthews added a commit that referenced this pull request Jul 14, 2025
@jeff-matthews
Copy link
Contributor Author

Ported changes to #462

@github-project-automation github-project-automation bot moved this from 📋 Needs Review to 🏁 Done in Commerce - Pull Requests Jul 14, 2025
@jeff-matthews jeff-matthews deleted the test-redocly-block-pagination branch July 17, 2025 21:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

1 participant