Merge pull request #29 from stac-extensions/m-mohr-patch-1

Description and type clarifications
stac-extensions · Mar 14, 2024 · 3cb217b · 3cb217b
2 parents 96c0ce8 + 85feb0a
commit 3cb217b
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -74,8 +74,8 @@ API Key, and OpenID authentication. All the [authentication clients](https://git
 
 | Field Name         | Type                                                         | Description |
 | ------------------ | ------------------------------------------------------------ | ----------- |
-| `type`             | string                                                       | **REQUIRED**. The authentication scheme type used to access the data (`http` \| `s3` \| `planetaryComputer` \| `earthdata` \| `signedUrl` \| `oauth2` \| `apiKey` \| `openIdConnect` \| `myCustomSchemeType`). |
-| `description`      | string                                                       | Additional instructions for authentication                   |
+| `type`             | string                                                       | **REQUIRED**. The authentication scheme type used to access the data (`http` \| `s3` \| `planetaryComputer` \| `earthdata` \| `signedUrl` \| `oauth2` \| `apiKey` \| `openIdConnect` \| a custom scheme type ). |
+| `description`      | string                                                       | Additional instructions for authentication. [CommonMark 0.29](https://commonmark.org/) syntax MAY be used for rich text representation. |
 | `name`             | string                                                       | Required for `type: apiKey`. The name of the header, query, or cookie parameter to be used. |
 | `in`               | string                                                       | Required for `type: apiKey`. The location of the API key (`query` \| `header` \| `cookie`). |
 | `scheme`           | string                                                       | Required for `type: http`. The name of the HTTP Authorization scheme to be used in the [Authorization header as defined in RFC7235](https://tools.ietf.org/html/rfc7235#section-5.1).  The values used SHOULD be registered in the [IANA Authentication Scheme registry](https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml). (`basic` \| `bearer` \| `digest` \| `dpop` \| `hoba` \| `mutual` \| `negotiate` \| `oauth` (1.0) \| `privatetoken` \| `scram-sha-1` \| `scram-sha-256` \| `vapid`) |