Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(reference): document OpenAPI 3.1 swagger-client deref strategy #2416

Merged
merged 1 commit into from
Dec 27, 2022
Merged

docs(reference): document OpenAPI 3.1 swagger-client deref strategy #2416

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions packages/apidom-reference/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1315,6 +1315,26 @@ Supported media types:
]
```

##### [openapi-3-1-swagger-client](https://github.com/swagger-api/apidom/tree/main/packages/apidom-reference/src/dereference/strategies/openapi-3-1-swagger-client)

Dereference strategy for dereferencing [OpenApi 3.1.0](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md) definitions with [swagger-client](https://github.com/swagger-api/swagger-js) flavour.
This strategy support additional options:

| Option | Description |
|-------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `useCircularStructures` | `Boolean=true`. Prevents circular values from being constructed, unless you specifically want that to happen. If set to `false`, it will leave the circular references unresolved. |
| `allowMetaPatches` | `Boolean=false`. Allows adding meta patches, which include adding `$$refs` to the resolved definition. `$$ref` is a meta information created from the original JSON Reference. |

Supported media types:

```js
[
'application/vnd.oai.openapi;version=3.1.0',
'application/vnd.oai.openapi+json;version=3.1.0',
'application/vnd.oai.openapi+yaml;version=3.1.0'
]
```

##### Dereference strategies execution order

It's important to understand that default dereference strategies are run in specific order. The order is determined
Expand Down