Versions, latest and pinned

Versions, latest and pinnedEvery face lens and screen effect has one draft and any number of published versions. You edit the draft. Publishing freezes it as the next version.Statuses

Status

Meaning

Draft

Never published. Apps can't fetch it.

Published

Has at least one published version. You can keep editing the draft.

Archived

Frozen: no more edits. Its published versions keep serving.

The lists of face lenses and screen effects have a status filter.PublishingOwners and Designers can publish. Choose Publish in the studio header, and the editor:

saves your pending edits;

checks the draft on the server, including your workspace's rules;

publishes it only if there are no issues.

If there are issues, the Issues tab lists them, the editor says "Fix the issues before publishing.", and nothing is published. When it works, you see a message such as "Published version 3".Versions are numbered 1, 2, 3 and so on. A version holds the manifest and the images its layers use. Images you uploaded but never used in a layer are left out.A published version never changesOnce published, a version's files are never changed or overwritten.

Editing the draft afterwards changes only the draft.

Deleting an image from the Assets tab doesn't touch published versions; they keep their own copies.

To change what apps get, edit the draft and publish again. That makes the next version.

This is what lets your app keep a version for good once it has checked it. See Downloading safely.The Versions tabThe studio's Versions tab lists every published version, newest first, with:

Version — its number;

Published — when;

Size — the manifest and its images together;

Engine — the lowest renderer engine version that can draw it;

Manifest — a link to its manifest.json, and Copy URL.

Preview imagesAfter a face lens is published, the editor draws a 512 × 512 PNG of the new version in your browser and uploads it. The image shows in the Preview column, and the delivery API returns it as previewUrl.Making it can fail, for example in a browser without WebGL. The row then offers Generate preview to try again. A lens too detailed to fit a 512 KiB image gets no preview. So treat the preview as optional: previewUrl can be null.Screen effects have no preview images.Latest or pinnedThe delivery API gives you two ways to ask for an item:

Request

Answers with

GET /v1/lenses/:lensId

The latest published version. It changes each time someone publishes.

GET /v1/lenses/:lensId/versions/:version

That exact version, always the same.

Screen effects work the same way, under /v1/effects/.

Use latest when every publish should reach your users.

Use pinned when you want to check a version yourself before your app moves to it. For example, keep asking for version 3 until you choose to switch to version 4.

See Delivery API.ArchivingArchive is in the More actions (⋯) menu of the studio header. After you confirm, the item becomes read-only: it can't be edited or renamed.An archived item keeps serving. The latest route still answers with its last published version, and its pinned versions still answer. Apps that already use it keep working.

Important: There is no un-archive. To keep working on an archived design, make a new item. It gets a new id, so your app has to switch to it.

Rules and published versionsIf your workspace gets a rule profile later, versions that are already published are not checked again. The rules apply from the next Validate or Publish. See Rules and keep-out zones.