Skip to content

Commit

Permalink
Merge pull request #91 from i-ky/fix-typo
Browse files Browse the repository at this point in the history
Fix a typo
  • Loading branch information
lornajane authored Apr 18, 2024
2 parents d499401 + 9d21ff2 commit 97f513b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion referencing/remove.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ If your OAD does not run afoul of any of the above difficulties, you _can_ produ

## Convert a multi-document OAD into a single document

It is possible to convert a multi-document OAD into a single document event if not all references can be removed. However, depending on exactly how your multi-document OAD is structured, this may be more complex than just removing references. Sadly, the reasons have to do with [painfully obscure and technical ambiguities](https://github.com/OAI/oascomply/blob/main/reports/processing-model-summary.md) regarding how multi-document OADs are intended to be parsed. The OpenAPI Initiative hopes to clarify this in future versions of the specification.
It is possible to convert a multi-document OAD into a single document even if not all references can be removed. However, depending on exactly how your multi-document OAD is structured, this may be more complex than just removing references. Sadly, the reasons have to do with [painfully obscure and technical ambiguities](https://github.com/OAI/oascomply/blob/main/reports/processing-model-summary.md) regarding how multi-document OADs are intended to be parsed. The OpenAPI Initiative hopes to clarify this in future versions of the specification.

* It is possible for a Link Object's `"operationId"` to point to an Operation Object in a Path Item Object that is never referenced; it is unclear how this case should handle it, which is one reason the OAS itself [advises against](https://spec.openapis.org/oas/v3.1.0#fixed-fields-16) using `"operationId"` in multi-document OADs
* Security Scheme Objects are never referenced, only named in Security Requirement Objects, and must be taken into account
Expand Down

0 comments on commit 97f513b

Please sign in to comment.