Speccy API review

Version updated for https://github.com/mcclowes/speccy to version docusaurus-plugin-speccy@0.13.0.

  • This action is used across all versions by 0 repositories.

Action Type

This is a Composite action.

Go to the GitHub Marketplace to find the latest changes.

Action Summary

Speccy is an OpenAPI renderer that provides a React-based solution for rendering API specifications across various platforms such as web, macOS, and Docusaurus. It automates tasks like linting and diffing OpenAPI documents, making it easier to maintain consistent documentation and ensure compliance with the specification standard.

What’s Changed

Minor Changes

  • #62 54e9a75 Thanks @mcclowes! - Add a Webhooks reference page listing every webhook the API delivers.

    Webhooks still appear under their tag in the sidebar, but the Reference group now also links to /reference/webhooks, a single list of every webhook in the spec. The entry and its generated route appear only when the document declares webhooks.

Patch Changes

  • #62 ac83fee Thanks @mcclowes! - Serve the published OpenAPI description under docusaurus start. The file was only emitted from postBuild, so the overview’s link to it 404ed for the whole time an author worked locally. The plugin now writes the description into its generated files directory and mounts that directory on the dev server at the same URL.

    The overview card also shows the description’s URL instead of a second “Open OpenAPI description” label, and opens it in a new tab rather than navigating the reader out of the docs.

  • Updated dependencies [ac83fee, 54e9a75, 8a798d1, eb610fc, 1e75c06]: