Skip to content

Commit 3497ca3

Browse files
committed
descriptor: Replace "supported" with "registered"
Avoid adding a second word meaning the same thing. I've consolidated around "registered" because it matches the existing "Registered algorithms" header. Also some copy-edits for the sentences I've touched: * "alpha numeric" -> "alphanumerics" (matching [1]). * "paramterize" -> "parameterize * "future extension of digest support" -> "extensions", because folks may be taking advantage of the extended grammar *now*, without waiting for the image-spec to take advantage of the extended grammar. [1]: https://en.wikipedia.org/wiki/Alphanumeric Signed-off-by: W. Trevor King <[email protected]>
1 parent 023b077 commit 3497ca3

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

descriptor.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -78,18 +78,18 @@ encoded := /[a-zA-Z0-9=_-]+/
7878

7979
Some example digest strings include the following:
8080

81-
digest | algorithm | Supported |
82-
--------------------------------------------------------------------------|---------------------|-----------|
83-
`sha256:6c3c624b58dbbcd3c0dd82b4c53f04194d1247c6eebdaab7c610cf7d66709b3b` | [SHA-256](#sha-256) | Yes |
84-
`sha512:401b09eab3c013d4ca54922bb802bec8fd5318192b0a75f201d8b372742...` | [SHA-512](#sha-512) | Yes |
85-
`multihash+base58:QmRZxt2b1FVZPNqd8hsiykDL3TdBDeTSPX9Kv46HmX4Gx8` | Multihash | No |
86-
`sha256+b64u:LCa0a2j_xo_5m0U8HTBBNBNCLXBkg7-g-YpeiGJm564` | SHA-256 with urlsafe base64 | No|
87-
88-
Please see [Registered Algorithms](#registered-algorithms) for a list of supported algorithms.
89-
90-
Implementations SHOULD allow digests that are unsupported to pass validation if they comply with the above grammar.
91-
While `sha256` will only use hex encoded digests, support for separators in _algorithm_ and alpha numeric in _encoded_ is included to allow for future extension of digest support.
92-
As an example, we can paramterize the encoding and algorithm as `multihash+base58:QmRZxt2b1FVZPNqd8hsiykDL3TdBDeTSPX9Kv46HmX4Gx8`, which would be considered valid but unsupported by this specification.
81+
digest | algorithm | Registered |
82+
--------------------------------------------------------------------------|---------------------|------------|
83+
`sha256:6c3c624b58dbbcd3c0dd82b4c53f04194d1247c6eebdaab7c610cf7d66709b3b` | [SHA-256](#sha-256) | Yes |
84+
`sha512:401b09eab3c013d4ca54922bb802bec8fd5318192b0a75f201d8b372742...` | [SHA-512](#sha-512) | Yes |
85+
`multihash+base58:QmRZxt2b1FVZPNqd8hsiykDL3TdBDeTSPX9Kv46HmX4Gx8` | Multihash | No |
86+
`sha256+b64u:LCa0a2j_xo_5m0U8HTBBNBNCLXBkg7-g-YpeiGJm564` | SHA-256 with urlsafe base64 | No |
87+
88+
Please see [Registered Algorithms](#registered-algorithms) for a list of registered algorithms.
89+
90+
Implementations SHOULD allow digests with unrecognized algorithms to pass validation if they comply with the above grammar.
91+
While `sha256` will only use hex encoded digests, separators in _algorithm_ and alphanumerics in _encoded_ are included to allow for extensions.
92+
As an example, we can parameterize the encoding and algorithm as `multihash+base58:QmRZxt2b1FVZPNqd8hsiykDL3TdBDeTSPX9Kv46HmX4Gx8`, which would be considered valid but unregistered by this specification.
9393

9494
### Verification
9595

0 commit comments

Comments
 (0)