Skip to content

Commit

Permalink
Consistent Markdown bullets
Browse files Browse the repository at this point in the history
  • Loading branch information
peterbrightwell committed Jul 7, 2023
1 parent 727f15d commit a91d089
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/APIs.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# APIs
{:.no_toc}

* A markdown unordered list which will be replaced with the ToC, excluding the "Contents header" from above
- A markdown unordered list which will be replaced with the ToC, excluding the "Contents header" from above
{:toc}

_(c) AMWA 2023, CC Attribution-NoDerivatives 4.0 International (CC BY-ND 4.0)_
Expand Down
25 changes: 13 additions & 12 deletions docs/Behaviour.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Behaviour
{:.no_toc}

* A markdown unordered list which will be replaced with the ToC, excluding the "Contents header" from above
- A markdown unordered list which will be replaced with the ToC, excluding the "Contents header" from above
{:toc}

<!-- _(c) AMWA 2023, CC Attribution-NoDerivatives 4.0 International (CC BY-ND 4.0)_ -->
Expand Down Expand Up @@ -50,8 +50,8 @@ The following `PATCH` request asks to reset the label and "location" tag, at the
The reset behaviour depends on the API implementation.
The new values MUST be valid per the schema.

* For labels and descriptions, the implementation MUST either restore an initial or configured default value, or set the value to the empty string.
* For a named tag, the implementation MUST either restore an initial or configured default array of values, or remove the named tag from the resource.
- For labels and descriptions, the implementation MUST either restore an initial or configured default value, or set the value to the empty string.
- For a named tag, the implementation MUST either restore an initial or configured default array of values, or remove the named tag from the resource.

A `PATCH` request with `tags` set to `null` asks to reset all tags.

Expand Down Expand Up @@ -88,20 +88,21 @@ An API implementation SHOULD reject requests which do not meet the additional li

Minimum requirements on supported annotations are specified in terms of size in Bytes when encoded in UTF-8.

* An API implementation MUST support writing a label of up to 64 Bytes for every resource.
* An API implementation SHOULD support writing a description of up to 64 Bytes for every resource.
* An API implementation MUST support writing at least 1 tag for every resource with:
* a name of up to 64 Bytes with the URN prefix `urn:x-nmos:tag:user:`
* an array of values with 1 element of up to 64 Bytes.
* An API implementation SHOULD support writing at least 5 such tags for every resource.
- An API implementation MUST support writing a label of up to 64 Bytes for every resource.
- An API implementation SHOULD support writing a description of up to 64 Bytes for every resource.
- An API implementation MUST support writing at least 1 tag for every resource with:
- a name of up to 64 Bytes with the URN prefix `urn:x-nmos:tag:user:`
- an array of values with 1 element of up to 64 Bytes.
- An API implementation SHOULD support writing at least 5 such tags for every resource.

Notes:
* UTF-8 is a variable length encoding so 64 Bytes does not equate to a fixed number of code points or characters.

- UTF-8 is a variable length encoding so 64 Bytes does not equate to a fixed number of code points or characters.
The first 128 code points in the Basic Latin (ASCII) Unicode block (U+0000 to U+007F) need 1 Byte, the next 1920 code points (U+0080 to U+07FF) which cover the remainder of almost all Latin-script alphabets need 2 Bytes, and the remaining 61440 code points of the Basic Multilingual Plane (BMP), including most Chinese, Japanese and Korean characters (U+0800 to U+FFFF) need 3 Bytes.
Code points in the Supplementary Planes (U+10000 to U+10FFFF) take 4 Bytes.
The 64 Byte minimum requirement therefore corresponds to between 16 and 64 code points.
* Uniform Resource Names (URNs) are restricted to a subset of characters within the ASCII range by [RFC 8141][RFC-8141] and use the percent-encoding mechanism defined by [RFC 3986][RFC-3986] for octets outside this subset, which increases the number of Bytes taken to encode those characters. RFC 8141 recommends not using characters outside the ASCII range.
* These minimum requirements are chosen with highly memory-constrained devices in mind.
- Uniform Resource Names (URNs) are restricted to a subset of characters within the ASCII range by [RFC 8141][RFC-8141] and use the percent-encoding mechanism defined by [RFC 3986][RFC-3986] for octets outside this subset, which increases the number of Bytes taken to encode those characters. RFC 8141 recommends not using characters outside the ASCII range.
- These minimum requirements are chosen with highly memory-constrained devices in mind.
Manufacturers are encouraged to support further annotation for some or all resources, i.e. larger values, more values per tag, and more tags.
An API implementation can have higher limits, for example based on the total size of annotations across all resources.

Expand Down

0 comments on commit a91d089

Please sign in to comment.