IBX-1430: Fix REST API reference #1615

adriendupuis · 2022-05-11T15:41:42Z

Question	Answer
JIRA Ticket	IBX-1430
Versions	4.1, 4.0

Fix several indentation errors that hide some parts or create non-existing routes.

/calendar/calendar/event → /calendar/event
/commerce/basket/{basketId}/{basketId}/line → /commerce/basket/{basketId}/line
/content/assets/assets/images → /content/assets/images
/content/locations/{path}/{locationId} → /content/locations/{path} (the two forms were existing and are now merged; the first one is not necessary as the location ID is always part of the location path.)
/content/locations/{path}/children and /content/locations/{path}/urlaliases were absent from HTML output.
/content/objects's POST request example was badly indented.
/content/objectstategroups/objectstates → /content/objectstategroups/{objectStateGroupId}/objectstates
/content/types/{contentTypeId}/{fieldDefinitionId} → /content/types/{contentTypeId}/fielddefinitions/{fieldDefinitionId}
remove non-existing /content/views/{identifier} (/views/{viewId} equivalent is not implemented)
/product/catalog/attributes/{id}'s request body example was absent from HTML output.
/product/catalog/attributes/translation/{languageCode} → /product/catalog/attributes/translation/{id}/{languageCode}
/product/catalog/attribute_groups's 403 descriptions were incomplete or erroneous.
/user/users:
- Fix query parameters descriptions when using HEAD method.
- Move ?roleId=/user/roles/1 example to /user/groups because, on a clean install, the anonymous role 1 is not assigned to the Anonymous User but to its Anonymous User Group, and, /user/users?roleId only retrieves users with the given role directly assigned to them.

adriendupuis · 2022-05-11T15:44:44Z

I found the missing /content/locations/{path}/urlaliases documentation during #1591. There is certainly more.

TODO: Found other wrongly indented sub-resources.

docs/api/rest_api_reference/input/ez-content-location.raml

- Fix indentation - Same self-closing tag format

string(150) "application/vnd.ibexa.api.AttributeGet+json type: AttributeList example: !include examples/product/catalog/attributes/id/GET/AttributeGet.json.example" PHP Warning: Invalid argument supplied for foreach() in /Users/adriendupuis/www/developer-documentation/tools/raml2html/vendor/raml-org/raml-php-parser/src/Method.php on line 147

Only POST exists in 4.0 and 4.1 https://github.com/ibexa/rest/blob/v4.0.0/src/bundle/Resources/config/routing.yml#L258

And /views/{viewId} equivalent routes are not implemented https://github.com/ibexa/rest/blob/v4.0.0/src/bundle/Resources/config/routing.yml#L276 https://github.com/ibexa/rest/blob/v4.1.5/src/lib/Server/Controller/Views.php#L88

…dent /content/objectstategroups/objectstates doesn't exist; /content/objectstategroups/{objectStateGroupId}/objectstates does: https://github.com/ibexa/rest/blob/v4.0.0/src/bundle/Resources/config/routing.yml#L326

…indent /content/types/{contenttypeid}/{fielddefinitionid} doesn't exist; /content/types/{contenttypeid}/fielddefinitions/{fielddefinitionid} does: https://github.com/ibexa/rest/blob/v4.0.0/src/bundle/Resources/config/routing.yml#L578

GET /content/types/{contenttypeid}/fieldDefinitions: https://github.com/ibexa/rest/blob/v4.0.0/src/bundle/Resources/config/routing.yml#L570 GET /content/types/{contentTypeId}/draft/fieldDefinitions: https://github.com/ibexa/rest/blob/v4.0.0/src/bundle/Resources/config/routing.yml#L611

/content/assets/assets/images/{assetId}/{assetSource} doesn't exist; only /content/assets/images/{assetId}/{assetSource}: https://github.com/ibexa/connector-dam/blob/v4.0.0/src/bundle/Resources/config/routing_rest.yaml#L9 /calendar/calendar/event doesn't exists; only /calendar/event: https://github.com/ibexa/calendar/blob/main/src/bundle/Resources/config/routing_rest.yaml

/commerce/basket/{basketId}/{basketId}/line doesn't exist while /commerce/basket/{basketId}/line does at https://github.com/ibexa/commerce-rest/blob/v4.0.0/src/bundle/Resources/config/routing.yaml#L67 /commerce/basket/{basketId}/{basketId}/line/{lineId} doesn't exist while /commerce/basket/{basketId}/line/{lineId} does at https://github.com/ibexa/commerce-rest/blob/v4.0.0/src/bundle/Resources/config/routing.yaml#L87

docs/api/rest_api_reference/input/ez-content-types.raml

…tions" Revert b328303

…tion/{languageCode} /product/catalog/attributes/translation/{languageCode} doesn't exist while /product/catalog/attributes/translation/{identifier}/{languageCode} exists in https://github.com/ibexa/product-catalog/blob/v4.0.0/src/bundle/Resources/config/routing_rest.yaml#L69

Same format than in `/product/catalog/attribute_groups/translation/{id}/{languageCode}`

docs/api/rest_api_reference/input/ez-user-users.raml

Co-authored-by: DominikaK <[email protected]>

This is the tool that helped a lot on #1615 to test what was already in the reference and that will help to found missing entries.

docs/api/rest_api_reference/input/examples/content/objects/POST/ContentCreate.xml.example

- Fix several indentation errors that hide some parts or create non-existing routes. - Fix /user/users parameters (cherry picked from commit 7544e68)

adriendupuis · 2022-06-15T15:35:41Z

docs/api/rest_api_reference/input/ez-user-groups.raml

    queryParameters:
        roleId:
-            description: Lists User Groups assigned to the given Role.
+            description: Lists User Groups assigned to the given Role (e.g. GET /user/users?roleId=/user/roles/1).


Should be /user/groups?roleId=/user/roles/1 💩

adriendupuis · 2022-06-15T15:40:34Z

docs/api/rest_api_reference/input/ez-user-users.raml

+            description: Checks if there are Users directly assigned to the given Role.
        remoteId:
-            description: Retrieves the User for the given remote ID (e.g. GET /user/users?remoteId=55dd9713db75145f374bbd0b4f60ad29).
+            description: Checks if there is a User for the given remote ID (e.g. GET /user/users?remoteId=55dd9713db75145f374bbd0b4f60ad29).


In the examples, it should be HEAD instead of GET

ez-content-location.raml: Fix /children and /urlaliases indentation

570b67c

adriendupuis changed the title ~~IBX-1430: Fix REST API reference parts which do not appear~~ IBX-1430: Fix REST API reference absent parts May 11, 2022

adriendupuis commented May 11, 2022

View reviewed changes

docs/api/rest_api_reference/input/ez-content-location.raml Outdated Show resolved Hide resolved

adriendupuis added 2 commits May 13, 2022 17:25

ez-user-users.raml: Fix HEAD /user/users queryParameters' descriptions

81c3b56

ez-content-location.raml: Merge /{path} and /{path}/{locationId}

7a8c178

adriendupuis changed the title ~~IBX-1430: Fix REST API reference absent parts~~ IBX-1430: Revise REST API reference May 16, 2022

adriendupuis added 6 commits May 23, 2022 12:08

Format ContentCreate.xml.example

c1b7e01

- Fix indentation - Same self-closing tag format

ez-product-attributegroups.raml: Fix two 403 descriptions

e6dffd8

ez-user-users.raml: Fix UserUpdate indentation

f321b2b

Regenerate rest_api_reference.html

ddb5659

ez-content-views.raml: GET /content/views doesn't exist

01037de

Only POST exists in 4.0 and 4.1 https://github.com/ibexa/rest/blob/v4.0.0/src/bundle/Resources/config/routing.yml#L258

adriendupuis changed the title ~~IBX-1430: Revise REST API reference~~ IBX-1430: Fix REST API reference Jun 7, 2022

adriendupuis added 6 commits June 7, 2022 17:05

adriendupuis commented Jun 8, 2022

View reviewed changes

docs/api/rest_api_reference/input/ez-content-types.raml Outdated Show resolved Hide resolved

Revert "ez-objectstategroups.raml: Init missing GET for …/fieldDefini…

f26f9c5

…tions" Revert b328303

adriendupuis mentioned this pull request Jun 8, 2022

IBX-1430: Complete 4.4 REST API reference #1642

Merged

adriendupuis added 2 commits June 8, 2022 12:17

ez-product-attributes.raml: {identifier} → {id}

e0af064

Same format than in `/product/catalog/attribute_groups/translation/{id}/{languageCode}`

adriendupuis marked this pull request as ready for review June 8, 2022 10:33

adriendupuis requested a review from DominikaK June 8, 2022 10:33

DominikaK self-assigned this Jun 8, 2022

DominikaK added the Needs DOC review label Jun 8, 2022

DominikaK approved these changes Jun 8, 2022

View reviewed changes

docs/api/rest_api_reference/input/ez-user-users.raml Outdated Show resolved Hide resolved

docs/api/rest_api_reference/input/ez-user-users.raml Outdated Show resolved Hide resolved

adriendupuis and others added 2 commits June 8, 2022 13:58

Update docs/api/rest_api_reference/input/ez-user-users.raml

45a1585

Co-authored-by: DominikaK <[email protected]>

Update docs/api/rest_api_reference/input/ez-user-users.raml

8f914d7

Co-authored-by: DominikaK <[email protected]>

adriendupuis merged commit 7544e68 into master Jun 8, 2022

adriendupuis deleted the fix/rest-api-reference branch June 8, 2022 13:45

adriendupuis added a commit that referenced this pull request Jun 8, 2022

Add tools/rest_api_reference_test.php

a63c76f

This is the tool that helped a lot on #1615 to test what was already in the reference and that will help to found missing entries.

adriendupuis commented Jun 9, 2022

View reviewed changes

docs/api/rest_api_reference/input/examples/content/objects/POST/ContentCreate.xml.example Show resolved Hide resolved

adriendupuis added a commit that referenced this pull request Jun 9, 2022

IBX-1430: Fix REST API reference (#1615)

f6de2d1

- Fix several indentation errors that hide some parts or create non-existing routes. - Fix /user/users parameters (cherry picked from commit 7544e68)

adriendupuis added a commit that referenced this pull request Jun 9, 2022

IBX-1430: Fix REST API reference (#1615)

4cc0c80

- Fix several indentation errors that hide some parts or create non-existing routes. - Fix /user/users parameters (cherry picked from commit 7544e68)

adriendupuis commented Jun 15, 2022

View reviewed changes

This was referenced Jun 15, 2022

IBX-1430: Fix REST API reference for 4.x #1655

Merged

IBX-1430: Fix REST API reference for 3.3 #1656

Merged

dabrt removed the Needs DOC review label Dec 16, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

IBX-1430: Fix REST API reference #1615

IBX-1430: Fix REST API reference #1615

Uh oh!

adriendupuis commented May 11, 2022 •

edited

Loading

Uh oh!

adriendupuis commented May 11, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

adriendupuis Jun 15, 2022

Uh oh!

adriendupuis Jun 15, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

IBX-1430: Fix REST API reference #1615

IBX-1430: Fix REST API reference #1615

Uh oh!

Conversation

adriendupuis commented May 11, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

adriendupuis commented May 11, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

adriendupuis Jun 15, 2022

Choose a reason for hiding this comment

Uh oh!

adriendupuis Jun 15, 2022

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

adriendupuis commented May 11, 2022 •

edited

Loading