IBX-8369: Fix REST LocationList #2445
Draft
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
"Message: Unresolved reference 'ProductFilter'" from webapi-parser
adriendupuis
commented
Jul 22, 2024
Comment on lines
538
to
540
| type: Ref[] | ||
| xml: | ||
| name: LocationList |
There was a problem hiding this comment.
Inspired by https://dzone.com/articles/the-x-factor-raml-with-xml-data-format but I don't feel it's the right way. It misses that the "Ref" nodes are named Location.
<?xml version="1.0" encoding="UTF-8"?>
<LocationList media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/1/locations">
<Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/42"/>
</LocationList>
adriendupuis
added
Wait with merge
adriendupuis
commented
Jul 24, 2024
Comment on lines
1085
to
1089
| LocationListXML: | ||
| type: LocationRefXML[] | ||
| xml: | ||
| name: LocationList | ||
| properties: |
There was a problem hiding this comment.
It's like LocationList node shouldn't have properties…
Message: Property 'properties' not supported in a RAML 1.0 array node
<?xml version="1.0" encoding="UTF-8"?>
<LocationList media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/1/locations">
<Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/42"/>
</LocationList>This reverts commit c9e76d0.
…2418) * Ibexa Cloud product guide page added * Content added * Image added * Content & images added * Image fixed * Content added * Vale suggestions * Fixes after review * Content added * Fixes * Updates & content added * Updates * Sentence updated * Content added; fixes * Kafka removed --------- Co-authored-by: Julita Falcon Dusza <julitafalcondusza@Users-MacBook-Pro.local>
* Mentioned Symfony performance article in the doc * Applied suggestion Co-authored-by: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> --------- Co-authored-by: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com>
* Added documentation about env function for migrations * Changed from tag names to function names
--------- Co-authored-by: julitafalcondusza <117284672+julitafalcondusza@users.noreply.github.com>
adriendupuis
force-pushed
the
fix-rest-locationlist
branch
from
e7c902d
to
b6aa8ab
Compare
# Conflicts: # docs/api/rest_api/rest_api_reference/rest_api_reference.html
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.
The old definition is the one from the PHP class. The REST output has nothing in common with the PHP class:
It's also important to notice that REST
LocationListis not a list of https://github.com/ibexa/rest/blob/main/src/lib/Server/Output/ValueObjectVisitor/Location.phpNote: Sample case, if the right syntax is found, similar ones could be fixed (BookmarkList , ContentTypeList, UrlAliasRefList ObjectStateGroupList, …)
Checklist