Publishing and versions

Publish

Choose Publish on a collection and write a changelog. Scalaix checks every endpoint and creates the next version number (1, 2, 3, ...). A version is a snapshot of all the collection's endpoint definitions and never changes afterwards.

Publishing fails if the collection has no endpoints or if any definition is invalid.

Calling a version

Callers get the latest version unless they ask for one:

# latest
curl -X POST https://www.scalaix.com/acme/support/classify-ticket ...

# pinned
curl -X POST "https://www.scalaix.com/acme/support/classify-ticket?version=3" ...

The response's version field says which version answered. Pin a version in production code when you want changes to roll out only after you've tested them; move the pin forward when you're ready.

Drafts after publishing

Editing an endpoint after publishing changes the draft only. The collection shows Unpublished changes until you publish again; callers keep getting the published version.

Generated docs

Each published collection has a docs page at:

https://www.scalaix.com/<project>/<collection>

It shows every endpoint's description, URL, inputs table, output schema with an example, request and response examples, code in curl, Python and JavaScript, and the errors to expect. A version selector shows older versions. Link to one endpoint with /<project>/<collection>/<endpoint>.

Docs are public while the project's Public API docs setting is on. Turn it off under Settings → General → Public API docs to hide them (the docs pages return 404); the endpoints keep working for callers with keys.