Skip to content

Commit

Permalink
fix: finish actual spec (#3)
Browse files Browse the repository at this point in the history
  • Loading branch information
hairmare authored Dec 1, 2022
1 parent fb63a2d commit b6d99f5
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,29 @@ We rely on involved parties to resolve RaBe CRIDs on their own.
RaBe CRIDs are as simple as possible:

```text
crid://rabe/<version>/<data-content>#t=clock:19961108T143720.25Z
crid://rabe.ch/<version>/<data-content>
```

### `<version>` data part

To allow for future change, all of RaBe's CRIDs are versioned. Versioning SHALL
follow semantic versioning conventions but is more similar to ie. Kubernetes
API-versions.

### `<data-content>` data part

RaBe CRID's define the data-content as the lowercased, normalized and dasherized
name of a show as the primary URL path segment for a show. These are mostly based
on the current URL slugs from the RaBe Website. We SHOULD provide further guidance
on normalization down the road.

For references to specific times, we support a media-frag URI-part and SHOULS use
the `#t=<iso-timestamp>` format.

### ABNF definition

RaBe CRIDs SHALL conform to the following ABNF definition.

```abnf
crid = "crid://rabe.ch/" version "/" data-content
version = "v" 1*DIGIT [ pre-release ] ; ie. v1, v2,
Expand Down

0 comments on commit b6d99f5

Please # to comment.