Skip to content

feat: adds support for external anchor and relative id #167

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

Draft
baywet wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

feat: adds support for external anchor and relative id #167

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
13 changes: 8 additions & 5 deletions OpenAPI/OpenAPI.NET/references-openapi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,7 @@ JSON Schema references can use either a locator or an identifier. Locators indic
- An internal inline subschema
- An external OpenApi document component
- An external inline subchema
- An external inline subchema using anchor [Not currently supported]
- An external inline subchema using anchor
- An external fragment [Not supported]

#### An internal component
Expand Down Expand Up @@ -489,9 +489,10 @@ components:
type: string
```

#### An external inline subchema using an anchor [Not currently supported]
#### An external inline subchema using an anchor

OpenAPI.NET supports resolving plain-name JSON Schema anchors in external OpenAPI documents.

We accept pull requests.

```yaml
openapi: 3.1.0
Expand Down Expand Up @@ -572,7 +573,7 @@ person:
### What can a JSON Schema identifier reference target

- Reference an internal component using a $id
- Reference an internal subschema using a $id [Not supported yet]
- Reference an internal subschema using a $id
- Reference an external component schema using a $id

#### Reference an internal component using a $id
Expand Down Expand Up @@ -609,7 +610,9 @@ components:
type: string
```

#### Reference an internal subschema using a $id [Not supported yet]
#### Reference an internal subschema using a $id

OpenAPI.NET supports resolving `$id` values on nested schemas. Relative `$id` values are resolved against the closest parent schema resource identifier.

```yaml
openapi: 3.1.0
Expand Down
Loading