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.0 support: example generation from JSON Schema 2020-12 #8577

Closed
20 tasks done
char0n opened this issue Apr 19, 2023 · 2 comments
Closed
20 tasks done

OpenAPI 3.1.0 support: example generation from JSON Schema 2020-12 #8577

char0n opened this issue Apr 19, 2023 · 2 comments
Assignees
@char0n
Labels
type: feature version: 5.x

Comments

@char0n
Copy link
Member

char0n commented Apr 19, 2023 •
edited
Loading

The goal of this issue is to implement proper example generation for Try it out feature from JSON Schema 2020-12 schemas.

The course of action here is to amend existing samples plugin to work with JSON Schema 2020-12 and not to blow up. We're aiming for quick win here. If time will allow us, we want to approach JSON Schema 2020-12 -> data generation in more complex way, similar to https://github.com/json-schema-faker/json-schema-faker

TODO:

What we'll not be adding support for (in alpha/beta phase):

NOTE: the list below needs to be itemized into individual GitHub issues
@char0n char0n self-assigned this Apr 19, 2023
@char0n char0n mentioned this issue May 19, 2023
Closed
char0n added a commit that referenced this issue May 30, 2023
@char0n
feat: introduce samples framework for JSON Schema 2020-12
d186b53 
Refs #8577
@char0n char0n mentioned this issue May 30, 2023
Merged
@char0n
Copy link
Member Author

char0n commented May 30, 2023 •
edited
Loading

Functions from samples/fn.js are statically imported into different modules, which makes it impossible to override. We need to first refactor the code so that samples plugin is used as plugin and not as static ESM module.

PR where above mentioned problems were remedied: #8724

char0n added a commit that referenced this issue May 30, 2023
@char0n
refactor(samples): move example generation code to samples plugin
099b8b0 
Refs #8577
@char0n char0n mentioned this issue May 30, 2023
Merged
char0n added a commit that referenced this issue May 30, 2023
@char0n
refactor(samples): move example generation code to samples plugin (#8727
f718a19 
)

Refs #8577
char0n added a commit that referenced this issue May 30, 2023
@char0n
refactor: use samples plugin to generate schemas examples
e966d4d 
Refs #8577
@char0n char0n mentioned this issue May 30, 2023
Merged
char0n added a commit that referenced this issue May 30, 2023
@char0n
refactor: use samples plugin to generate schemas examples (#8728)
861218a 
Refs #8577
char0n added a commit that referenced this issue May 30, 2023
@char0n
fix(oas3): fix sample generation for RequestBody component
da1c771 
Refs #8577
char0n added a commit that referenced this issue May 31, 2023
@char0n
test: align tests with sample plugin changes
ac2ca23 
Refs #8577
char0n added a commit that referenced this issue May 31, 2023
@char0n
test: align tests with sample plugin changes
334d798 
Refs #8577
char0n added a commit that referenced this issue May 31, 2023
@char0n
feat(oas31): enable overrides for samples plugin
f576eb7 
These overrides are specific to OpenAPI 3.1.0
and JSON Schema 2020-12.

Refs #8577
@char0n char0n mentioned this issue May 31, 2023
Merged
char0n added a commit that referenced this issue May 31, 2023
@char0n
feat(oas31): enable overrides for samples plugin (#8731)
4b7ab99 
These overrides are specific to OpenAPI 3.1.0
and JSON Schema 2020-12.

Refs #8577
char0n added a commit that referenced this issue May 31, 2023
@char0n
refactor(oas31): use system.fn as source of truth for Model wrapper
446844f 
Refs #8577
char0n added a commit that referenced this issue Jun 1, 2023
@char0n
feat: introduce samples framework for JSON Schema 2020-12
ac3b69f 
Refs #8577
char0n added a commit that referenced this issue Jun 1, 2023
@char0n
refactor(samples): move example generation code to samples plugin (#8727
027f53c 
)

Refs #8577
char0n added a commit that referenced this issue Jun 1, 2023
@char0n
refactor: use samples plugin to generate schemas examples (#8728)
1ce9ce0 
Refs #8577
char0n added a commit that referenced this issue Jun 1, 2023
@char0n
test: align tests with sample plugin changes
2ce9d08 
Refs #8577
char0n added a commit that referenced this issue Jun 1, 2023
@char0n
feat(oas31): enable overrides for samples plugin (#8731)
df9aadf 
These overrides are specific to OpenAPI 3.1.0
and JSON Schema 2020-12.

Refs #8577
char0n added a commit that referenced this issue Jun 1, 2023
@char0n
refactor(oas31): use system.fn as source of truth for Model wrapper
b017858 
Refs #8577
@char0n char0n mentioned this issue Jun 5, 2023
Merged
char0n added a commit that referenced this issue Jun 5, 2023
@char0n
feat(samples): add support for new values of format keyword
b6569bd 
This change is specific to JSON Schema 2020-12
and OpenAPI 3.1.0.

Refs #8577
char0n added a commit that referenced this issue Jun 5, 2023
@char0n
feat(samples): add support for new values of format keyword (#8882)
28b1233 
This change is specific to JSON Schema 2020-12
and OpenAPI 3.1.0.

Refs #8577
char0n added a commit that referenced this issue Jun 6, 2023
@char0n
feat(samples): add support for type keyword defined as list of types
a4e2584 
This change is specific to JSON Schema 2020-12
and OpenAPI 3.1.0.

Refs #8577
char0n added a commit that referenced this issue Jun 9, 2023
@char0n
feat(samples): add support for contentMediaType keyword
162b98e 
This change is specific to JSON Schema 2020-12
and OpenAPI 3.1.0.

Refs #8577
@char0n char0n mentioned this issue Jun 9, 2023
Merged
char0n added a commit that referenced this issue Jun 9, 2023
@char0n
feat(samples): add support for contentMediaType keyword (#8903)
1925622 
This change is specific to JSON Schema 2020-12
and OpenAPI 3.1.0.

Refs #8577
@char0n char0n mentioned this issue Jun 9, 2023
Merged
char0n added a commit that referenced this issue Jun 9, 2023
@char0n
feat(samples): add support for custom formats, encoders and media typ…
d72b72c 
…es (#8905)

This change is specific to JSON Schema 2020-12
and OpenAPI 3.1.0.

Refs #8577
char0n added a commit that referenced this issue Jun 9, 2023
@char0n
feat(samples): add support for contentSchema keyword
bb0370e 
This change is specific to JSON Schema 2020-12
and OpenAPI 3.1.0.

Refs #8577
@char0n char0n mentioned this issue Jun 9, 2023
Merged
char0n added a commit that referenced this issue Jun 9, 2023
@char0n
feat(samples): add support for contentSchema keyword (#8907)
6c622a8 
This change is specific to JSON Schema 2020-12
and OpenAPI 3.1.0.

Refs #8577
char0n added a commit that referenced this issue Jun 10, 2023
@char0n
feat(examples): add support for examples keyword
2972c2e 
This change is specific to JSON Schema 2020-12
and OpenAPI 3.1.0.

Refs #8577
@char0n char0n mentioned this issue Jun 10, 2023
Merged
char0n added a commit that referenced this issue Jun 10, 2023
@char0n
feat(examples): add support for examples keyword (#8908)
4b0b285 
This change is specific to JSON Schema 2020-12
and OpenAPI 3.1.0.

Refs #8577
char0n added a commit that referenced this issue Jun 11, 2023
@char0n
feat(samples): add support for inferring schema type
8b04621 
This change is specific to JSON Schema 2020-12
and OpenAPI 3.1.0.

Refs #8577
@char0n char0n mentioned this issue Jun 11, 2023
Merged
char0n added a commit that referenced this issue Jun 11, 2023
@char0n
feat(samples): add support for inferring schema type (#8909)
ce417d5 
This change is specific to JSON Schema 2020-12
and OpenAPI 3.1.0.

Refs #8577
char0n added a commit that referenced this issue Jun 11, 2023
@char0n
feat(samples): add support for proper schema merging
0911bb9 
This change is specific to JSON Schema 2020-12
and OpenAPI 3.1.0.

Refs #8577
@char0n char0n mentioned this issue Jun 11, 2023
Merged
char0n added a commit that referenced this issue Jun 11, 2023
@char0n
feat(samples): add support for proper schema merging (#8910)
7bf0dd9 
This change is specific to JSON Schema 2020-12
and OpenAPI 3.1.0.

Refs #8577
char0n added a commit that referenced this issue Jun 11, 2023
@char0n
refactor(samples): do the general code cleanup
1c2c3d5 
This change is specific to JSON Schema 2020-12
and OpenAPI 3.1.0.

Refs #8577
@char0n char0n mentioned this issue Jun 11, 2023
Merged
char0n added a commit that referenced this issue Jun 11, 2023
@char0n
refactor(samples): do the general code cleanup (#8911)
fd18aaa 
This change is specific to JSON Schema 2020-12
and OpenAPI 3.1.0.

Refs #8577
@char0n char0n mentioned this issue Jun 11, 2023
Open
@char0n
Copy link
Member Author

char0n commented Jun 11, 2023

Missing keywords transformed into #8913

@char0n char0n closed this as completed Jun 11, 2023
char0n added a commit that referenced this issue Jun 12, 2023
@char0n
feat(samples): add support for merging type keyword
df2fbb2 
This change is specific to JSON Schema 2020-12
and OpenAPI 3.1.0.

Refs #8577
@char0n char0n mentioned this issue Jun 12, 2023
Merged
char0n added a commit that referenced this issue Jun 12, 2023
@char0n
feat(samples): add support for merging type keyword (#8916)
b593c50 
This change is specific to JSON Schema 2020-12
and OpenAPI 3.1.0.

Refs #8577
This was referenced Jul 16, 2023
Closed
Merged
Closed
char0n pushed a commit that referenced this issue Nov 13, 2023
@pplr
fix(oas31): use system.fn as source of truth for Model wrapper (#9153)
20c2c74 
Refs #8577
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@char0n char0n

Labels
type: feature version: 5.x
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@char0n