IBX-1430: Complete 4.4 REST API reference #1642

adriendupuis · 2022-06-08T09:21:58Z

Question	Answer
JIRA Ticket	IBX-1430
Versions	4.4

Update/Complete REST API reference

Add missing methods to existing routes
Add missing routes
~~Update namespace (xmlns) from ez.no to ibexa.co~~ (kept for another latter PR)
Harmonize deprecation and removal flags
~~Add a test command to compare the built reference against real routing configuration~~ (moved to IBX-6107: REST API ref tester #1901)
Fix build command's templates to quit skipping some methods

Related and dependencies:

Follows IBX-1430: Fix REST API reference #1615 and REST API ref: Merge /user/groups/{id}/ into /user/groups/{path}/ #1843 where there were only fixes.
~~Needs ibexa/scheduler#76 to properly document scheduler API~~

Changelog:

Add GET /content/types/{contentTypeId}/fieldDefinitions
Add GET /content/types/{contentTypeId}/draft
Add GET /content/types/{contentTypeId}/draft/fieldDefinitions
Add POST /content/objects/{contentId}/hide
Add POST /content/objects/{contentId}/reveal
Add GET /product/catalog/attribute_types
Add GET /product/catalog/attribute_types/{identifier}
Add GET /product/catalog/regions/{identifier}
Add DELETE /commerce/basket/{basketId}
Add POST /cart
Add POST /cart/view
Add GET /cart/{identifier}
Add DELETE /cart/{identifier}
Add PATCH /cart/{identifier}
Add GET /cart/{identifier}/entry
Add DELETE /cart/{identifier}/entry/{entryId}
Add PATCH /cart/{identifier}/entry/{entryId}
Add POST /cart/{identifier}/empty
Add GET /cart/{identifier}/summary
Add GET /user/current
Add POST /user/groups/subgroups
Add GET /user/users/{userId}/drafts
Add GET /user/users/{userId}/segments
Add POST /user/users/{userId}/segments
Add DELETE /user/users/{userId}/segments/{segmentIdentifier}
Add GET /taxonomy/{taxonomyName}/entry/{id}
Add GET /taxonomy/{taxonomyName}/entry/identifier/{identifier}
Add GET /taxonomy/{taxonomyName}/entry/content-id/{contentId}
Add DELETE /taxonomy/{taxonomyName}/entries
Add POST /taxonomy/{taxonomyName}/entries/move
Add GET /taxonomy/{taxonomyName}/entry-assignment/{id}
Add GET /taxonomy/{taxonomyName}/entry-assignments/content-id/{contentId}
Fix POST /commerce/common/check_sku_file/{mode} route
Fix POST /product/catalog/attributes/view response body RAML syntax
Fix POST /product/catalog/attribute_groups/view response body
Fix POST /product/catalog/products/view response body
Fix POST /product/catalog/product_types/view response body
Fix POST /product/catalog/product_variants/view/{baseProductCode} missing route argument

Not treated and kept for an other latter PR:

/content/binary/
/languages/
/segments/ and /segment_groups/
/personalization/v1/
/views/
Files renaming to remove "ez-" prefix

tools/raml2html/README.md

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

tools/rest_api_reference_test.php

adriendupuis · 2023-01-06T08:44:06Z

docs/api/rest_api/rest_api_reference/input/ez-commerce.raml

+                    description: OK - The basket has been deleted
+                400:
+                    description: Error - The basket does not exist
+                403:


Notice:
This the 403 from Ibexa\Commerce\Rest\Service\ValueObjectVisitor\ValidationResponse
not the usual 401 from Ibexa\Rest\Server\Output\ValueObjectVisitor\UnauthorizedException

adriendupuis · 2023-01-09T15:58:09Z

I'll now target 4.4

I see a lot of depreciation in ez-commerce.raml 😓 😛

docs/api/rest_api/rest_api_reference/input/ez-commerce.raml

adriendupuis · 2023-01-24T14:00:11Z

I split this REST API ref. update. I'll continue in another one.

Here are added 32 pairs (method+route), few existing ones are fixed, that's a lot to review.

There is still a lot to improve (examples addition, being sure that every possible responses are covered, enhance the test command, etc.)

docs/api/rest_api/rest_api_reference/input/ez-cart.raml

tools/raml2html/composer.json

tools/raml2html/README.md

tools/raml2html/src/Command/TestCommand.php

/content/objects: ez-content-object.raml → ez-content-objects.raml /content/locations: ez-content-location.raml → ez-content-location.raml /content/sections: ez-content-section.raml → ez-content-sections.raml

- GET /content/objects/{contentId}/versions/{versionNo}/schedule - PUT /content/objects/{contentId}/versions/{versionNo}/schedule/{publicationTimestamp} - PATCH /content/objects/{contentId}/versions/{versionNo}/schedule/{publicationTimestamp}

Prefixed /api/datebasedpublisher/v1 instead of /api/ibexa/v2 - GET /content/objects/{contentId}/versions/{versionNo}/schedule - PUT /content/objects/{contentId}/versions/{versionNo}/schedule/{publicationTimestamp} - PATCH /content/objects/{contentId}/versions/{versionNo}/schedule/{publicationTimestamp}

Taken from ibexa/cart#25

When a route had more than one sub-routes, its methods were skipped at HTML generation time. ``` /tmp: displayName: 1st level route get: displayName: Immediate GET /first: get: displayName: Test a URI element ``` was documenting - GET /tmp - GET /tmp/first while ``` /tmp: displayName: 1st level route get: displayName: Immediate GET /first: get: displayName: Test a URI element /second: post: displayName: Test another URI element ``` was only documenting - GET /tmp/first - GET /tmp/second and was skipping GET /tmp

tools/raml2html/themes/default/resource-group.html.twig

# Conflicts: # docs/api/rest_api/rest_api_reference/input/ez.raml # docs/api/rest_api/rest_api_reference/rest_api_reference.html

(cherry picked from commit c4bd49e)

adriendupuis · 2023-03-02T14:34:39Z

After being merged into master branch, has been cherry-picked in 4.4 branch.

adriendupuis mentioned this pull request Jun 8, 2022

IBX-1430: Fix REST API reference #1615

Merged

DominikaK force-pushed the master branch from b309f53 to 2ed59e0 Compare June 10, 2022 06:36

adriendupuis commented Dec 28, 2022

View reviewed changes

tools/raml2html/README.md Outdated Show resolved Hide resolved

adriendupuis force-pushed the update-rest-api-ref branch from d889c05 to 86374db Compare December 29, 2022 11:42

adriendupuis commented Dec 29, 2022

View reviewed changes

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

adriendupuis commented Dec 29, 2022

View reviewed changes

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

adriendupuis force-pushed the update-rest-api-ref branch from c1ce916 to 7c4800c Compare December 30, 2022 12:30

Steveb-p reviewed Dec 30, 2022

View reviewed changes

tools/rest_api_reference_test.php Outdated Show resolved Hide resolved

adriendupuis commented Jan 6, 2023

View reviewed changes

adriendupuis force-pushed the update-rest-api-ref branch 4 times, most recently from d039175 to b431958 Compare January 9, 2023 14:14

adriendupuis mentioned this pull request Jan 9, 2023

REST API ref: Merge /user/groups/{id}/ into /user/groups/{path}/ #1843

Merged

9 tasks

adriendupuis commented Jan 9, 2023

View reviewed changes

docs/api/rest_api/rest_api_reference/input/ez-commerce.raml Outdated Show resolved Hide resolved

adriendupuis changed the title ~~IBX-1430: Complete REST API reference~~ IBX-1430: Complete 4.4 REST API reference Jan 19, 2023

adriendupuis marked this pull request as ready for review January 24, 2023 13:45

adriendupuis requested a review from Steveb-p January 24, 2023 13:45

adriendupuis mentioned this pull request Feb 1, 2023

IBX-4498: raml2html: Upgrade dependencies #1871

Merged

7 tasks

DominikaK force-pushed the master branch 3 times, most recently from 33f6b7e to 2b50cbd Compare February 2, 2023 14:26

adriendupuis commented Feb 3, 2023

View reviewed changes

docs/api/rest_api/rest_api_reference/input/ez-cart.raml Outdated Show resolved Hide resolved

DominikaK added the Needs DEV review label Feb 3, 2023

adriendupuis mentioned this pull request Feb 9, 2023

Added JSON /views example #1857

Merged

7 tasks

adriendupuis commented Feb 9, 2023

View reviewed changes

tools/raml2html/composer.json Outdated Show resolved Hide resolved

adriendupuis commented Feb 16, 2023

View reviewed changes

tools/raml2html/README.md Outdated Show resolved Hide resolved

Steveb-p reviewed Feb 16, 2023

View reviewed changes

tools/raml2html/src/Command/TestCommand.php Outdated Show resolved Hide resolved

adriendupuis and others added 13 commits February 17, 2023 09:41

ez-commerce.raml: Remove removal time from navigation

f3f62d3

ez-cart.raml: Add section displayName

d4f035f

ez-user-users.raml: Add /user/users/segments

d25ea2e

Rename few *.raml to correspond w/ their routes

8164fe1

/content/objects: ez-content-object.raml → ez-content-objects.raml /content/locations: ez-content-location.raml → ez-content-location.raml /content/sections: ez-content-section.raml → ez-content-sections.raml

Complete CartSummary.json.example with a real example

e081529

Taken from ibexa/cart#25

Continue ez-cart.raml

1f4bbd2

ez-content-types.raml: Add GET /content/types/{contentTypeId}/draft

a1f7db6

ez-cart.raml: Fix missing CartViewInput type

0dfa2e6

ez.raml & ez-views.raml: Comment w/ routes kept for another latter PR

3fa993b

ez-cart.raml: eCommerce → Commerce

0b99680

adriendupuis force-pushed the update-rest-api-ref branch from e9807b6 to 74a8238 Compare February 17, 2023 08:51

adriendupuis added 2 commits February 17, 2023 09:51

Regenerate rest_api_reference.html

567e4ff

(minor) index.html.twig: Format code

58fb083

adriendupuis mentioned this pull request Feb 17, 2023

IBX-6107: REST API ref tester #1901

Draft

7 tasks

adriendupuis commented Feb 17, 2023

View reviewed changes

tools/raml2html/themes/default/resource-group.html.twig Show resolved Hide resolved

adriendupuis added 4 commits February 17, 2023 14:06

Merge branch 'master' into update-rest-api-ref

5d552b8

# Conflicts: # docs/api/rest_api/rest_api_reference/input/ez.raml # docs/api/rest_api/rest_api_reference/rest_api_reference.html

Regenerate rest_api_reference.html

2aca123

resource-endpoints.html.twig: Fix isFirstLevel usage

4aceca6

resource-endpoints.html.twig: Fix <h3> condition

9c9568b

adriendupuis requested a review from Steveb-p February 17, 2023 15:31

Merge branch 'master' into update-rest-api-ref

fd6e802

Steveb-p approved these changes Mar 2, 2023

View reviewed changes

adriendupuis merged commit c4bd49e into master Mar 2, 2023

adriendupuis deleted the update-rest-api-ref branch March 2, 2023 13:32

adriendupuis added a commit that referenced this pull request Mar 2, 2023

IBX-1430: Complete 4.4 REST API reference (#1642)

aa8e575

(cherry picked from commit c4bd49e)

adriendupuis mentioned this pull request Mar 2, 2023

IBX-1430: Complete 4.3 REST API reference #1912

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

IBX-1430: Complete 4.4 REST API reference #1642

IBX-1430: Complete 4.4 REST API reference #1642

Uh oh!

adriendupuis commented Jun 8, 2022 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

adriendupuis Jan 6, 2023

Uh oh!

adriendupuis commented Jan 9, 2023

Uh oh!

Uh oh!

adriendupuis commented Jan 24, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

adriendupuis commented Mar 2, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

IBX-1430: Complete 4.4 REST API reference #1642

IBX-1430: Complete 4.4 REST API reference #1642

Uh oh!

Conversation

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

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

adriendupuis Jan 6, 2023

Choose a reason for hiding this comment

Uh oh!

adriendupuis commented Jan 9, 2023

Uh oh!

Uh oh!

adriendupuis commented Jan 24, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

adriendupuis commented Mar 2, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

adriendupuis commented Jun 8, 2022 •

edited

Loading