Skip to content

Commit 156d852

Browse files
committed
Updated GFM reference for Link Object
1 parent 111cf2b commit 156d852

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

versions/3.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1150,7 +1150,7 @@ href | url | a relative or absolute URL to a linked resource. This fie
11501150
operationId | string | the name of an _existing_, resolvable OAS operation, as defined with a unique `operationId`. This field is mutually exclusive with the `href` field. Relative `href` values _may_ be used to locate an existing Operation Object in the OAS.
11511151
parameters | Link Parameters Object | an Object representing parameters to pass to an operation as specified with `operationId` or identified via `href`.
11521152
headers | Link Headers Object | an Object representing headers to pass to the linked resource.
1153-
description | string | a description of the link, supports GFM.
1153+
description | string | a description of the link, supports [CommonMark syntax](http://spec.commonmark.org/).
11541154
^x- | Any | Allows extensions to the OpenAPI Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Specification Extensions](#specificationExtensions) for further details.
11551155

11561156
Locating a linked resource may be performed by either a `href` or `operationId`. In the case of an `operationId`, it must be unique and resolved in the scope of the OAS document. Because of the potential for name clashes, consider the `href` syntax as the preferred method for specifications with external references.

0 commit comments

Comments
 (0)