fix(JsonSchema): fix reDoc json sample values #5638
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ERuban
changed the title
ERuban
changed the title
|
@soyuka 👋 |
|
@soyuka hey, what about this PR? |
|
tests are failing |
- fix(JsonSchema): reDoc json sample values
- fix(JsonSchema): reDoc json sample values
@soyuka done. The last one seems not related to my changes. |
|
thanks! |
soyuka
pushed a commit
to soyuka/core
that referenced
this pull request
Oct 18, 2023
* fix(jsonschema): fix reDoc json sample values * fix(JsonSchema): reDoc json sample values * fix-redoc-json-example-values - fix(JsonSchema): reDoc json sample values * fix-redoc-json-example-values - fix(JsonSchema): reDoc json sample values
soyuka
reviewed
Oct 18, 2023
| @@ -139,7 +139,7 @@ private function getClassType(?string $className, bool $nullable, string $format | |||
| if (true !== $readableLink && $this->isResourceClass($className)) { | |||
| return [ | |||
| 'type' => 'string', | |||
| 'format' => 'iri-reference', | |||
| 'format' => 'iri-template', | |||
There was a problem hiding this comment.
I've a problem with that it's not in the specification: https://json-schema.org/understanding-json-schema/reference/string#resource-identifiers isn't redoc wrong?
we should fix this by introducing an example section instead imo
|
I reverted that. |
soyuka
added a commit
that referenced
this pull request
Oct 18, 2023
|
@soyuka you're right. We don't generate templates here but references. The patch was wrong (maybe there is a bug in ReDoc, but then ReDoc must be patched, not our code). |
|
I think what we need is to add examples if we really want this feature on docs. |
|
ok, got it. let me try to add examples then |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Actually it fixes the same bug as in that PR but for JSON.