From 8e06650641984010075088b0d8bee3f9540e4db0 Mon Sep 17 00:00:00 2001 From: Thad Guidry Date: Wed, 5 Jun 2024 20:49:03 +0800 Subject: [PATCH] Add TODO for CommonMark link reference definitions --- draft/openapi.yml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/draft/openapi.yml b/draft/openapi.yml index b4aa401..ef40d2d 100644 --- 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