From 8cb215cbc4379db8539cd66e4f1ece44c5d211af Mon Sep 17 00:00:00 2001 From: Mike Kistler Date: Tue, 3 Oct 2023 10:49:11 -0700 Subject: [PATCH 1/4] Add structured fields primitive types to format registry --- registries/_format/sf-binary.md | 37 ++++++++++++++++++++++++++++ registries/_format/sf-boolean.md | 36 ++++++++++++++++++++++++++++ registries/_format/sf-decimal.md | 36 ++++++++++++++++++++++++++++ registries/_format/sf-integer.md | 37 ++++++++++++++++++++++++++++ registries/_format/sf-string.md | 41 ++++++++++++++++++++++++++++++++ registries/_format/sf-token.md | 35 +++++++++++++++++++++++++++ 6 files changed, 222 insertions(+) create mode 100644 registries/_format/sf-binary.md create mode 100644 registries/_format/sf-boolean.md create mode 100644 registries/_format/sf-decimal.md create mode 100644 registries/_format/sf-integer.md create mode 100644 registries/_format/sf-string.md create mode 100644 registries/_format/sf-token.md diff --git a/registries/_format/sf-binary.md b/registries/_format/sf-binary.md new file mode 100644 index 0000000000..9604c3201d --- /dev/null +++ b/registries/_format/sf-binary.md @@ -0,0 +1,37 @@ +--- +owner: mikekistler +issue: +description: structured fields byte sequence as defined by `sf-binary` in [RFC 8941] +base_type: string +layout: default +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format represents a structured fields byte sequence as defined by `sf-binary` in [RFC 8941]. + +```abnf +sf-binary = ":" *(base64) ":" +base64 = ALPHA / DIGIT / "+" / "/" / "=" +``` + +A Byte Sequence is delimited with colons and encoded using base64 ([RFC 4648], Section 4). + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} + +{% if page.remarks %} +### Remarks + +{{ page.remarks }} +{% endif %} + +[RFC 8941]: https://www.rfc-editor.org/rfc/rfc8941#name-byte-sequences +[RFC 4648]: https://www.rfc-editor.org/rfc/rfc4648#section-4 diff --git a/registries/_format/sf-boolean.md b/registries/_format/sf-boolean.md new file mode 100644 index 0000000000..19d02bcccf --- /dev/null +++ b/registries/_format/sf-boolean.md @@ -0,0 +1,36 @@ +--- +owner: mikekistler +issue: +description: structured fields boolean as defined by `sf-boolean` in [RFC 8941] +base_type: string +layout: default +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format represents a structured fields boolean as defined by `sf-boolean` in [RFC 8941]. + +```abnf +sf-boolean = "?" boolean +boolean = "0" / "1" +``` + +A Boolean is indicated with a leading "?" character followed by a "1" for a true value or "0" for false. + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} + +{% if page.remarks %} +### Remarks + +{{ page.remarks }} +{% endif %} + +[RFC 8941]: https://www.rfc-editor.org/rfc/rfc8941#name-booleans diff --git a/registries/_format/sf-decimal.md b/registries/_format/sf-decimal.md new file mode 100644 index 0000000000..581fc97737 --- /dev/null +++ b/registries/_format/sf-decimal.md @@ -0,0 +1,36 @@ +--- +owner: mikekistler +issue: +description: structured fields decimal as defined by `sf-decimal` in [RFC 8941] +base_type: integer +layout: default +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format represents a structured fields decimal as defined by `sf-decimal` in [RFC 8941]. + +```abnf +sf-decimal = ["-"] 1*12DIGIT "." 1*3DIGIT +``` + +Decimals are numbers with an integer and a fractional component. +The integer component has at most 12 digits; the fractional component has at most three digits. + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} + +{% if page.remarks %} +### Remarks + +{{ page.remarks }} +{% endif %} + +[RFC 8941]: https://www.rfc-editor.org/rfc/rfc8941#name-decimals diff --git a/registries/_format/sf-integer.md b/registries/_format/sf-integer.md new file mode 100644 index 0000000000..9689d3f282 --- /dev/null +++ b/registries/_format/sf-integer.md @@ -0,0 +1,37 @@ +--- +owner: mikekistler +issue: +description: structured fields integer as defined by `sf-integer` in [RFC 8941] +base_type: integer +layout: default +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format represents a structured fields integer as defined by `sf-integer` in [RFC 8941]. + +```abnf +sf-integer = ["-"] 1*15DIGIT +``` + +Integers have a range of -999,999,999,999,999 to 999,999,999,999,999 inclusive (i.e., up to fifteen digits, signed), +for IEEE 754 compatibility [IEEE754]. + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} + +{% if page.remarks %} +### Remarks + +{{ page.remarks }} +{% endif %} + +[RFC 8941]: https://www.rfc-editor.org/rfc/rfc8941#name-integers +[IEEE754]: https://ieeexplore.ieee.org/document/8766229 \ No newline at end of file diff --git a/registries/_format/sf-string.md b/registries/_format/sf-string.md new file mode 100644 index 0000000000..91a8336932 --- /dev/null +++ b/registries/_format/sf-string.md @@ -0,0 +1,41 @@ +--- +owner: mikekistler +issue: +description: structured fields string as defined by `sf-string` in [RFC 8941] +base_type: string +layout: default +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format represents a structured fields string as defined by `sf-string` in [RFC 8941]. + +```abnf +sf-string = DQUOTE *chr DQUOTE +chr = unescaped / escaped +unescaped = %x20-21 / %x23-5B / %x5D-7E +escaped = "\" ( DQUOTE / "\" ) +``` + +Strings are zero or more printable ASCII [RFC0020] characters (i.e., the range %x20 to %x7E). +Note that this excludes tabs, newlines, carriage returns, etc. + +Strings are delimited with double quotes, using a backslash ("\") to escape double quotes and backslashes. + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} + +{% if page.remarks %} +### Remarks + +{{ page.remarks }} +{% endif %} + +[RFC 8941]: https://www.rfc-editor.org/rfc/rfc8941#name-strings diff --git a/registries/_format/sf-token.md b/registries/_format/sf-token.md new file mode 100644 index 0000000000..c4753c9269 --- /dev/null +++ b/registries/_format/sf-token.md @@ -0,0 +1,35 @@ +--- +owner: mikekistler +issue: +description: structured fields token as defined by `sf-token` in [RFC 8941] +base_type: string +layout: default +--- + +# {{ page.collection }} + +## {{ page.slug }} - {{ page.description }} + +Base type: `{{ page.base_type }}`. + +The `{{page.slug}}` format represents a structured fields token as defined by `sf-token` in [RFC 8941]. + +```abnf +sf-token = ( ALPHA / "*" ) *( tchar / ":" / "/" ) +``` + +Tokens are short textual words; their abstract model is identical to their expression in the HTTP field value serialization. + +{% if page.issue %} +### GitHub Issue + +* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }}) +{% endif %} + +{% if page.remarks %} +### Remarks + +{{ page.remarks }} +{% endif %} + +[RFC 8941]: https://www.rfc-editor.org/rfc/rfc8941#name-tokens From 515bbc37b17353a6d3eadf35890d99866f101774 Mon Sep 17 00:00:00 2001 From: Mike Kistler Date: Wed, 4 Oct 2023 17:25:09 -0700 Subject: [PATCH 2/4] De-emphasize the ABNF --- registries/_format/sf-binary.md | 4 ++-- registries/_format/sf-boolean.md | 4 ++-- registries/_format/sf-decimal.md | 4 ++-- registries/_format/sf-integer.md | 4 ++-- registries/_format/sf-string.md | 4 ++-- registries/_format/sf-token.md | 4 ++-- 6 files changed, 12 insertions(+), 12 deletions(-) diff --git a/registries/_format/sf-binary.md b/registries/_format/sf-binary.md index 9604c3201d..97f105aa37 100644 --- a/registries/_format/sf-binary.md +++ b/registries/_format/sf-binary.md @@ -1,7 +1,7 @@ --- owner: mikekistler issue: -description: structured fields byte sequence as defined by `sf-binary` in [RFC 8941] +description: structured fields byte sequence as defined in [RFC 8941] base_type: string layout: default --- @@ -12,7 +12,7 @@ layout: default Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format represents a structured fields byte sequence as defined by `sf-binary` in [RFC 8941]. +The `{{page.slug}}` format represents a structured fields byte sequence as defined in [RFC 8941]. ```abnf sf-binary = ":" *(base64) ":" diff --git a/registries/_format/sf-boolean.md b/registries/_format/sf-boolean.md index 19d02bcccf..6327ac1454 100644 --- a/registries/_format/sf-boolean.md +++ b/registries/_format/sf-boolean.md @@ -1,7 +1,7 @@ --- owner: mikekistler issue: -description: structured fields boolean as defined by `sf-boolean` in [RFC 8941] +description: structured fields boolean as defined in [RFC 8941] base_type: string layout: default --- @@ -12,7 +12,7 @@ layout: default Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format represents a structured fields boolean as defined by `sf-boolean` in [RFC 8941]. +The `{{page.slug}}` format represents a structured fields boolean as defined in [RFC 8941]. ```abnf sf-boolean = "?" boolean diff --git a/registries/_format/sf-decimal.md b/registries/_format/sf-decimal.md index 581fc97737..e2789f784d 100644 --- a/registries/_format/sf-decimal.md +++ b/registries/_format/sf-decimal.md @@ -1,7 +1,7 @@ --- owner: mikekistler issue: -description: structured fields decimal as defined by `sf-decimal` in [RFC 8941] +description: structured fields decimal as defined in [RFC 8941] base_type: integer layout: default --- @@ -12,7 +12,7 @@ layout: default Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format represents a structured fields decimal as defined by `sf-decimal` in [RFC 8941]. +The `{{page.slug}}` format represents a structured fields decimal as defined in [RFC 8941]. ```abnf sf-decimal = ["-"] 1*12DIGIT "." 1*3DIGIT diff --git a/registries/_format/sf-integer.md b/registries/_format/sf-integer.md index 9689d3f282..73ea95b021 100644 --- a/registries/_format/sf-integer.md +++ b/registries/_format/sf-integer.md @@ -1,7 +1,7 @@ --- owner: mikekistler issue: -description: structured fields integer as defined by `sf-integer` in [RFC 8941] +description: structured fields integer as defined in [RFC 8941] base_type: integer layout: default --- @@ -12,7 +12,7 @@ layout: default Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format represents a structured fields integer as defined by `sf-integer` in [RFC 8941]. +The `{{page.slug}}` format represents a structured fields integer as defined in [RFC 8941]. ```abnf sf-integer = ["-"] 1*15DIGIT diff --git a/registries/_format/sf-string.md b/registries/_format/sf-string.md index 91a8336932..77e1b20bdb 100644 --- a/registries/_format/sf-string.md +++ b/registries/_format/sf-string.md @@ -1,7 +1,7 @@ --- owner: mikekistler issue: -description: structured fields string as defined by `sf-string` in [RFC 8941] +description: structured fields string as defined in [RFC 8941] base_type: string layout: default --- @@ -12,7 +12,7 @@ layout: default Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format represents a structured fields string as defined by `sf-string` in [RFC 8941]. +The `{{page.slug}}` format represents a structured fields string as defined in [RFC 8941]. ```abnf sf-string = DQUOTE *chr DQUOTE diff --git a/registries/_format/sf-token.md b/registries/_format/sf-token.md index c4753c9269..9dd7af5783 100644 --- a/registries/_format/sf-token.md +++ b/registries/_format/sf-token.md @@ -1,7 +1,7 @@ --- owner: mikekistler issue: -description: structured fields token as defined by `sf-token` in [RFC 8941] +description: structured fields token as defined in [RFC 8941] base_type: string layout: default --- @@ -12,7 +12,7 @@ layout: default Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format represents a structured fields token as defined by `sf-token` in [RFC 8941]. +The `{{page.slug}}` format represents a structured fields token as defined in [RFC 8941]. ```abnf sf-token = ( ALPHA / "*" ) *( tchar / ":" / "/" ) From 6b74070995b228553bc95068f117205404335521 Mon Sep 17 00:00:00 2001 From: Mike Kistler Date: Fri, 13 Oct 2023 10:52:26 -0500 Subject: [PATCH 3/4] Add source info and address PR comments --- registries/_format/sf-binary.md | 2 ++ registries/_format/sf-boolean.md | 2 ++ registries/_format/sf-decimal.md | 4 +++- registries/_format/sf-integer.md | 4 +++- registries/_format/sf-string.md | 2 ++ registries/_format/sf-token.md | 2 ++ 6 files changed, 14 insertions(+), 2 deletions(-) diff --git a/registries/_format/sf-binary.md b/registries/_format/sf-binary.md index 97f105aa37..fb935b0958 100644 --- a/registries/_format/sf-binary.md +++ b/registries/_format/sf-binary.md @@ -2,6 +2,8 @@ owner: mikekistler issue: description: structured fields byte sequence as defined in [RFC 8941] +source: https://www.rfc-editor.org/rfc/rfc8941#name-byte-sequences +source_label: RFC 8941 base_type: string layout: default --- diff --git a/registries/_format/sf-boolean.md b/registries/_format/sf-boolean.md index 6327ac1454..0a1ac9b983 100644 --- a/registries/_format/sf-boolean.md +++ b/registries/_format/sf-boolean.md @@ -2,6 +2,8 @@ owner: mikekistler issue: description: structured fields boolean as defined in [RFC 8941] +source: https://www.rfc-editor.org/rfc/rfc8941#name-booleans +source_label: RFC 8941 base_type: string layout: default --- diff --git a/registries/_format/sf-decimal.md b/registries/_format/sf-decimal.md index e2789f784d..eddc2451cd 100644 --- a/registries/_format/sf-decimal.md +++ b/registries/_format/sf-decimal.md @@ -2,7 +2,9 @@ owner: mikekistler issue: description: structured fields decimal as defined in [RFC 8941] -base_type: integer +source: https://www.rfc-editor.org/rfc/rfc8941#name-decimals +source_label: RFC 8941 +base_type: number layout: default --- diff --git a/registries/_format/sf-integer.md b/registries/_format/sf-integer.md index 73ea95b021..3118f7823d 100644 --- a/registries/_format/sf-integer.md +++ b/registries/_format/sf-integer.md @@ -2,7 +2,9 @@ owner: mikekistler issue: description: structured fields integer as defined in [RFC 8941] -base_type: integer +source: https://www.rfc-editor.org/rfc/rfc8941#name-integers +source_label: RFC 8941 +base_type: integer, number layout: default --- diff --git a/registries/_format/sf-string.md b/registries/_format/sf-string.md index 77e1b20bdb..78264b14ef 100644 --- a/registries/_format/sf-string.md +++ b/registries/_format/sf-string.md @@ -2,6 +2,8 @@ owner: mikekistler issue: description: structured fields string as defined in [RFC 8941] +source: https://www.rfc-editor.org/rfc/rfc8941#name-strings +source_label: RFC 8941 base_type: string layout: default --- diff --git a/registries/_format/sf-token.md b/registries/_format/sf-token.md index 9dd7af5783..0d71dae486 100644 --- a/registries/_format/sf-token.md +++ b/registries/_format/sf-token.md @@ -2,6 +2,8 @@ owner: mikekistler issue: description: structured fields token as defined in [RFC 8941] +source: https://www.rfc-editor.org/rfc/rfc8941#name-tokens +source_label: RFC 8941 base_type: string layout: default --- From a5fe410c856d4004a2052e3b50c9b9d542e6e599 Mon Sep 17 00:00:00 2001 From: Mike Kistler Date: Sun, 25 Feb 2024 09:44:22 -0600 Subject: [PATCH 4/4] Address PR reivew comments --- registries/_format/sf-binary.md | 14 ++++++++------ registries/_format/sf-boolean.md | 10 ++++++---- registries/_format/sf-decimal.md | 10 ++++++---- registries/_format/sf-integer.md | 10 ++++++---- registries/_format/sf-string.md | 10 ++++++---- registries/_format/sf-token.md | 10 ++++++---- 6 files changed, 38 insertions(+), 26 deletions(-) diff --git a/registries/_format/sf-binary.md b/registries/_format/sf-binary.md index fb935b0958..d28c1c6665 100644 --- a/registries/_format/sf-binary.md +++ b/registries/_format/sf-binary.md @@ -1,7 +1,7 @@ --- owner: mikekistler -issue: -description: structured fields byte sequence as defined in [RFC 8941] +issue: +description: structured fields byte sequence as defined in [RFC8941] source: https://www.rfc-editor.org/rfc/rfc8941#name-byte-sequences source_label: RFC 8941 base_type: string @@ -14,14 +14,16 @@ layout: default Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format represents a structured fields byte sequence as defined in [RFC 8941]. +The `{{page.slug}}` format represents a structured fields byte sequence as defined in [RFC8941]. ```abnf sf-binary = ":" *(base64) ":" base64 = ALPHA / DIGIT / "+" / "/" / "=" ``` -A Byte Sequence is delimited with colons and encoded using base64 ([RFC 4648], Section 4). +A Byte Sequence is delimited with colons and encoded using base64 ([RFC4648], Section 4). + +This format is appropriate for a header value that must conform to the {{page.slug}} structured field definition. {% if page.issue %} ### GitHub Issue @@ -35,5 +37,5 @@ A Byte Sequence is delimited with colons and encoded using base64 ([RFC 4648], S {{ page.remarks }} {% endif %} -[RFC 8941]: https://www.rfc-editor.org/rfc/rfc8941#name-byte-sequences -[RFC 4648]: https://www.rfc-editor.org/rfc/rfc4648#section-4 +[RFC8941]: https://www.rfc-editor.org/rfc/rfc8941#name-byte-sequences +[RFC4648]: https://www.rfc-editor.org/rfc/rfc4648#section-4 diff --git a/registries/_format/sf-boolean.md b/registries/_format/sf-boolean.md index 0a1ac9b983..e999e31563 100644 --- a/registries/_format/sf-boolean.md +++ b/registries/_format/sf-boolean.md @@ -1,7 +1,7 @@ --- owner: mikekistler -issue: -description: structured fields boolean as defined in [RFC 8941] +issue: +description: structured fields boolean as defined in [RFC8941] source: https://www.rfc-editor.org/rfc/rfc8941#name-booleans source_label: RFC 8941 base_type: string @@ -14,7 +14,7 @@ layout: default Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format represents a structured fields boolean as defined in [RFC 8941]. +The `{{page.slug}}` format represents a structured fields boolean as defined in [RFC8941]. ```abnf sf-boolean = "?" boolean @@ -23,6 +23,8 @@ boolean = "0" / "1" A Boolean is indicated with a leading "?" character followed by a "1" for a true value or "0" for false. +This format is appropriate for a header value that must conform to the {{page.slug}} structured field definition. + {% if page.issue %} ### GitHub Issue @@ -35,4 +37,4 @@ A Boolean is indicated with a leading "?" character followed by a "1" for a true {{ page.remarks }} {% endif %} -[RFC 8941]: https://www.rfc-editor.org/rfc/rfc8941#name-booleans +[RFC8941]: https://www.rfc-editor.org/rfc/rfc8941#name-booleans diff --git a/registries/_format/sf-decimal.md b/registries/_format/sf-decimal.md index eddc2451cd..e46253e48c 100644 --- a/registries/_format/sf-decimal.md +++ b/registries/_format/sf-decimal.md @@ -1,7 +1,7 @@ --- owner: mikekistler -issue: -description: structured fields decimal as defined in [RFC 8941] +issue: +description: structured fields decimal as defined in [RFC8941] source: https://www.rfc-editor.org/rfc/rfc8941#name-decimals source_label: RFC 8941 base_type: number @@ -14,7 +14,7 @@ layout: default Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format represents a structured fields decimal as defined in [RFC 8941]. +The `{{page.slug}}` format represents a structured fields decimal as defined in [RFC8941]. ```abnf sf-decimal = ["-"] 1*12DIGIT "." 1*3DIGIT @@ -23,6 +23,8 @@ sf-decimal = ["-"] 1*12DIGIT "." 1*3DIGIT Decimals are numbers with an integer and a fractional component. The integer component has at most 12 digits; the fractional component has at most three digits. +This format is appropriate for a header value that must conform to the {{page.slug}} structured field definition. + {% if page.issue %} ### GitHub Issue @@ -35,4 +37,4 @@ The integer component has at most 12 digits; the fractional component has at mos {{ page.remarks }} {% endif %} -[RFC 8941]: https://www.rfc-editor.org/rfc/rfc8941#name-decimals +[RFC8941]: https://www.rfc-editor.org/rfc/rfc8941#name-decimals diff --git a/registries/_format/sf-integer.md b/registries/_format/sf-integer.md index 3118f7823d..09ac3568d1 100644 --- a/registries/_format/sf-integer.md +++ b/registries/_format/sf-integer.md @@ -1,7 +1,7 @@ --- owner: mikekistler -issue: -description: structured fields integer as defined in [RFC 8941] +issue: +description: structured fields integer as defined in [RFC8941] source: https://www.rfc-editor.org/rfc/rfc8941#name-integers source_label: RFC 8941 base_type: integer, number @@ -14,7 +14,7 @@ layout: default Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format represents a structured fields integer as defined in [RFC 8941]. +The `{{page.slug}}` format represents a structured fields integer as defined in [RFC8941]. ```abnf sf-integer = ["-"] 1*15DIGIT @@ -23,6 +23,8 @@ sf-integer = ["-"] 1*15DIGIT Integers have a range of -999,999,999,999,999 to 999,999,999,999,999 inclusive (i.e., up to fifteen digits, signed), for IEEE 754 compatibility [IEEE754]. +This format is appropriate for a header value that must conform to the {{page.slug}} structured field definition. + {% if page.issue %} ### GitHub Issue @@ -35,5 +37,5 @@ for IEEE 754 compatibility [IEEE754]. {{ page.remarks }} {% endif %} -[RFC 8941]: https://www.rfc-editor.org/rfc/rfc8941#name-integers +[RFC8941]: https://www.rfc-editor.org/rfc/rfc8941#name-integers [IEEE754]: https://ieeexplore.ieee.org/document/8766229 \ No newline at end of file diff --git a/registries/_format/sf-string.md b/registries/_format/sf-string.md index 78264b14ef..87f96ba627 100644 --- a/registries/_format/sf-string.md +++ b/registries/_format/sf-string.md @@ -1,7 +1,7 @@ --- owner: mikekistler -issue: -description: structured fields string as defined in [RFC 8941] +issue: +description: structured fields string as defined in [RFC8941] source: https://www.rfc-editor.org/rfc/rfc8941#name-strings source_label: RFC 8941 base_type: string @@ -14,7 +14,7 @@ layout: default Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format represents a structured fields string as defined in [RFC 8941]. +The `{{page.slug}}` format represents a structured fields string as defined in [RFC8941]. ```abnf sf-string = DQUOTE *chr DQUOTE @@ -28,6 +28,8 @@ Note that this excludes tabs, newlines, carriage returns, etc. Strings are delimited with double quotes, using a backslash ("\") to escape double quotes and backslashes. +This format is appropriate for a header value that must conform to the {{page.slug}} structured field definition. + {% if page.issue %} ### GitHub Issue @@ -40,4 +42,4 @@ Strings are delimited with double quotes, using a backslash ("\") to escape doub {{ page.remarks }} {% endif %} -[RFC 8941]: https://www.rfc-editor.org/rfc/rfc8941#name-strings +[RFC8941]: https://www.rfc-editor.org/rfc/rfc8941#name-strings diff --git a/registries/_format/sf-token.md b/registries/_format/sf-token.md index 0d71dae486..355817d89f 100644 --- a/registries/_format/sf-token.md +++ b/registries/_format/sf-token.md @@ -1,7 +1,7 @@ --- owner: mikekistler -issue: -description: structured fields token as defined in [RFC 8941] +issue: +description: structured fields token as defined in [RFC8941] source: https://www.rfc-editor.org/rfc/rfc8941#name-tokens source_label: RFC 8941 base_type: string @@ -14,7 +14,7 @@ layout: default Base type: `{{ page.base_type }}`. -The `{{page.slug}}` format represents a structured fields token as defined in [RFC 8941]. +The `{{page.slug}}` format represents a structured fields token as defined in [RFC8941]. ```abnf sf-token = ( ALPHA / "*" ) *( tchar / ":" / "/" ) @@ -22,6 +22,8 @@ sf-token = ( ALPHA / "*" ) *( tchar / ":" / "/" ) Tokens are short textual words; their abstract model is identical to their expression in the HTTP field value serialization. +This format is appropriate for a header value that must conform to the {{page.slug}} structured field definition. + {% if page.issue %} ### GitHub Issue @@ -34,4 +36,4 @@ Tokens are short textual words; their abstract model is identical to their expre {{ page.remarks }} {% endif %} -[RFC 8941]: https://www.rfc-editor.org/rfc/rfc8941#name-tokens +[RFC8941]: https://www.rfc-editor.org/rfc/rfc8941#name-tokens