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.

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

fix(JsonSchema): fix reDoc json sample values #5901

Merged
merged 3 commits into from
Dec 20, 2023

Conversation

ERuban
Copy link
Contributor

@ERuban ERuban commented Oct 19, 2023

Q A
Branch? 3.1
Tickets -
License MIT

Reworking of #5638 PR

@ERuban ERuban changed the title fix-redoc-json-request-example-values fix(JsonSchema): fix reDoc json sample values Oct 19, 2023
@ERuban ERuban force-pushed the fix-redoc-json-request-example-values branch 2 times, most recently from c1734e1 to 9a99735 Compare October 19, 2023 10:19
@soyuka
Copy link
Member

soyuka commented Oct 19, 2023

Hi I don't see any reference to example in the JSON Schema specification. According to this page the specification says to use default for a single example or an array of examples. Also, "string" is quite a bad default value for an iri-reference no? It should be something like https://example.com

@ERuban
Copy link
Contributor Author

ERuban commented Oct 19, 2023

@soyuka hi, but https://example.com looks strange for iri also. It should be smth like /books/{id} in example

Copy link

stale bot commented Dec 18, 2023

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Dec 18, 2023
@ERuban
Copy link
Contributor Author

ERuban commented Dec 18, 2023

👋

@stale stale bot removed the stale label Dec 18, 2023
@soyuka
Copy link
Member

soyuka commented Dec 19, 2023

still not good, either put https://example.com/ or fix that in SwaggerUI... Best would be to even generate the proper IRI in our examples but this is not what the PR is doing.

@ERuban ERuban force-pushed the fix-redoc-json-request-example-values branch from 7827715 to 10f525a Compare December 19, 2023 13:58
@ERuban
Copy link
Contributor Author

ERuban commented Dec 19, 2023

@soyuka ok, done

@soyuka soyuka merged commit cc16a1c into api-platform:3.1 Dec 20, 2023
25 of 28 checks passed
@soyuka
Copy link
Member

soyuka commented Dec 20, 2023

thanks, to go further we'll see to implement #6058

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants