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

Jump to bottom

OpenApi 3.1: external resolution of Example Object externalValue #467

Closed
Tracked by #425
, #426
...
char0n opened this issue Jul 1, 2021 · 1 comment · Fixed by #470
Closed
Tracked by #425
, #426
...

OpenApi 3.1: external resolution of Example Object externalValue #467

char0n opened this issue Jul 1, 2021 · 1 comment · Fixed by #470
Assignees
@char0n
Labels
ApiDOM enhancement New feature or request OpenAPI 3.1

Comments

@char0n
Copy link
Member

char0n commented Jul 1, 2021 •
edited
Loading

Specification: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#example-object

We have to guarantee mutual exclusivity between value and externalValue fields.

externalValue with URI pointing to a resource that is either JSON or YAML will be parsed into ApiDOM. Other types of content will be escaped using base64 encoding and set into value field.
@char0n char0n added enhancement New feature or request OpenAPI 3.1 ApiDOM labels Jul 1, 2021
@char0n char0n self-assigned this Jul 1, 2021
@char0n char0n mentioned this issue Jul 1, 2021
Closed
3 tasks
char0n added a commit that referenced this issue Jul 1, 2021
@char0n
feat(reference): add binary parser plugin
0ebc379 
Refs #467
@char0n char0n mentioned this issue Jul 1, 2021
Merged
char0n added a commit that referenced this issue Jul 1, 2021
@char0n
feat(reference): add binary parser plugin
7c52686 
Refs #467
@char0n
Copy link
Member Author

char0n commented Jul 1, 2021

Needed to implement BinaryParser which returns base64 encoded data within ParseResultElement. More here: #468

@char0n char0n mentioned this issue Jul 1, 2021
Open
6 tasks
char0n added a commit that referenced this issue Jul 1, 2021
@char0n
feat(reference): add OAS 3.1 Example.externalValue dereference
37590ba 
Refs #467
@char0n char0n mentioned this issue Jul 1, 2021
Merged
char0n added a commit that referenced this issue Jul 1, 2021
@char0n
feat(reference): add OAS 3.1 Example.externalValue dereference
751188f 
Refs #467
char0n added a commit that referenced this issue Jul 1, 2021
@char0n
feat(reference): add OAS 3.1 Example.externalValue ext. resolution
81c4453 
Closes #467
@char0n char0n mentioned this issue Jul 1, 2021
Merged
char0n added a commit that referenced this issue Jul 1, 2021
@char0n
feat(reference): add OAS 3.1 Example.externalValue ext. resolution
fd93841 
Closes #467
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@char0n char0n

Labels
ApiDOM enhancement New feature or request OpenAPI 3.1
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(reference): add OAS 3.1 Example.externalValue ext. resolution swagger-api/apidom
1 participant
@char0n