Publishing Sequences and Collections

Why publish?

The sequences and collections that you create are private by default. In many cases, the only people that are interested in your tests are you and your team.

However, there are some scenaarios where it makes sense to share them with a broader audience, for example:

  1. Documenting or providing usage examples of API's that you want to share with partners and customers.
  2. A sequence that solves a general problem such as creating and formatting an authorisation token. You can see a one solution to that here.
  3. A collection that bundles a set of sequences with some connection such as tutorials, or multiple solutions to constructing authorization tokens.

How to publish a sequence

Below we can see a screenshot of an unpublished sequence.

If I click on the edit button then we can see the publish button....

When you publish a sequence, it is the latest version that is published. In this case there is only over version (v.0).  Once it is published, if the saved version and the published version are the same, then the publish button is not visible. The published tag also lists the published version:

But after we have saved changes to the sequence, we can continue to publish:

Once a sequence is published, it cannot be unpublished. But you can delete it or save new versions.

How to publish a collection

Collections are even simpler because they don't have versions. A collection is either published or not. But the way to publish is identical:

How to share

Every sequence and collection has a unique ID. Once a a sequence or collection has been published then we add a tag you can click to copy a URL:

The format of these URLs is simple. For a given sequence with ID bej867, then

Playground: https://sequenceapi.com/p/bej867

Sequence: https://sequenceapi.com/s/bej867

Edit: https://sequenceapi.com/e/bej867

How to use a published sequence

OK, you've published a sequence, or you've found a published sequence you like. How do you use it? Learn here.