Skip to content

Commit 9a4f647

Browse files
committed
Add advice to OAD authors related to doc parsing
1 parent 9da10c5 commit 9a4f647

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

versions/3.1.1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ Implementations MAY support complete-document parsing in any of the following wa
154154
* Detecting a document containing a referenceable Object at its root based on the expected type of the reference
155155
* Allowing users to configure the type of documents that might be loaded due to a reference to a non-root Object
156156

157-
Embedding fragments of OpenAPI content in other formats can produce unexpected interactions among the enclosing format, the OAS, and JSON Schema. While implementations MAY choose to support such arrangements, the resulting behavior is _implementation defined_. This includes parsing fragments of OpenAPI out of a complete OpenAPI document while treating the rest of the document as arbitrary JSON or YAML.
157+
Embedding fragments of OpenAPI content in other formats can produce unexpected interactions among the enclosing format, the OAS, and JSON Schema. While implementations MAY choose to support such arrangements, the resulting behavior is _implementation defined_. This includes parsing fragments of OpenAPI out of a complete OpenAPI document while treating the rest of the document as arbitrary JSON or YAML. Since parsiing isolated fragments in this way will fail to notice keywords that might impact meaning or behavior, including in ways that contradict this specification's requirements, it is RECOMMENDED that OpenAPI Description authors avoid dependingon such behavior.
158158

159159
#### <a name="structuralInteroperability"></a>Structural Interoperability
160160

0 commit comments

Comments
 (0)