A snapshot is a link to your bundled OpenAPI definition. When a snapshot link is used in any other registered OpenAPI definition, reference docs, or developer portal, it is recorded as a dependency.
There are point-in-time snapshots as well as latest-branch snapshots. A point-in-time snapshot link will always reference the same document. A latest-branch snapshot will reference the more recent bundle associated with that given branch.
An example of a (non-functional) latest-branch snapshot:
An example of a (non-functional) point-in-time snapshot:
Notice the extra path segment for the point-in-time snapshot.
You may access a snapshot in JSON or YAML format.
The format may be selected from the user-interface.
You may also change the last four letters of the snapshot URL to control the format (
Your latest-branch snapshot links for any given branch will be accessible from the version overview.
Your point-in-time snapshot links will be found in the build logs.
Use your link like you would any other URL from within other API definitions, reference docs or developer portals.
You can launch new references docs from the button underneath usages.
If your snapshot is protected by access control, you will need to be logged in to access it.
To access it from our openapi-cli command line tool, you may use the
openapi-cli registry:login command.
The snapshots may be protected by access control on a version-level. In other words, access may be restricted to all snapshots for any given API version.
Control the access from the version's Settings > Access control screen.