Specsheet documentation

Show a spec on a page

1. Attach your OpenAPI or Swagger file (.json, .yaml or .yml) to the page or blog post.
2. Edit the page, type /OpenAPI Viewer, and insert the macro.
3. In the settings panel, pick the spec file (if the page has more than one). Save and publish.

Update the spec

Upload a new version of the same attachment. The macro shows the latest version.

Supported formats

OpenAPI 3.0 and 3.1, Swagger 2.0; JSON or YAML; up to about 5 MB per file.

What the macro does not do

• It does not send requests to your API ("Try it out" is off). This keeps all data inside Confluence.
• It does not load specs from URLs or external $ref files. Put everything in one file.

Exporting

PDF and Word exports show the spec title, version and a table of every operation.

Troubleshooting

• "Attach an OpenAPI or Swagger file..." -- the page has no .json/.yaml/.yml attachment.
• "The spec file chosen for this macro is no longer attached" -- edit the macro and pick another file.
• "... does not look like an OpenAPI or Swagger spec" -- the file is missing the openapi or swagger field.

Support

Email support@therocketshed.com. We reply within 3 business days.