Add TODO for CommonMark link reference definitions

reconciliation-api · Jun 5, 2024 · 8e06650 · 8e06650
1 parent 13af233
commit 8e06650
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/draft/openapi.yml b/draft/openapi.yml
@@ -401,6 +401,14 @@ components:
           items:
             entity:
               type: boolean
+## TODO: Verify that descriptions allow for CommonMark spec allows this kind of Link reference definitions
+##
+##       > The following properties are taken from the JSON Schema specification but their definitions have been extended by the OAS:
+##       > description - [CommonMark](https://spec.commonmark.org/) syntax MAY be used for rich text representation.
+##       > format - See Data Type Formats for further details. While relying on JSON Schema's defined formats, the OAS offers a few additional predefined formats.
+##
+##       https://spec.commonmark.org/0.31.2/#link-reference-definitions
+##       and that it navigates well in OAS editors.
               description: A boolean indicating if the service supports auto-suggestion of [entity]: /suggest/entity "entities"
             property:
               type: boolean