Skip to content

oapi.md spec-url is root-absolute and will not resolve under a Mike version prefix #135

Description

@allister-beamable

docs/api/oapi.md on api/v1.0 line 11:

spec-url="/Docs/assets/beamable-oapi.json"

A root-absolute path. Mike serves each version under its own prefix (/API-1.0/…), so this cannot resolve to the branch's own copy of the OpenAPI spec once deployed — the RapiDoc widget would come up empty on the branch's only substantive reference page.

Currently unverifiable in production because api/v1.0 has never been published, which is why this has gone unnoticed. Both candidate URLs 404 today:

https://help.beamable.com/assets/beamable-oapi.json          → 404
https://help.beamable.com/API-1.0/assets/beamable-oapi.json  → 404

The likely fix is a relative path (../assets/beamable-oapi.json) so it resolves within the version prefix, but that needs verification against how Mike rewrites paths and how RapiDoc resolves spec-url relative to the document — worth a local mike deploy to a scratch alias rather than guessing.

Blocks publishing the branch. Surfaced during the #127 copyediting audit.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentationreadme-io-sunsetRetiring docs.beamable.com (ReadMe.io); API-1.0 as partial successor

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions