IBX-6107: REST API ref tester #1901
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
docs/api/rest_api_reference/ → docs/api/rest_api/rest_api_reference/
In case of missing YAML library, the error message won't be the same. Before, it pretended the use of `undefined function EzSystems\Raml2Html\Test\yaml_parse_file()`. After, it notifies the use of `undefined function yaml_parse_file()`.
Co-authored-by: Paweł Niedzielski <[email protected]>
If the TestCommand doesn't do its job, let the ReferenceTester crash.
adriendupuis
force-pushed
the
rest-api-ref-tester
branch
from
25a96fc to
adb0644
Compare
|
Splitted from #1642 |
adriendupuis
commented
Feb 17, 2023
tools/raml2html/README.md
Outdated
| To generate static HTML from RAML definitions, use the following code from project root: | ||
|
|
||
| ```sh | ||
| php tools/raml2html/raml2html.php build --non-standard-http-methods=COPY,MOVE,PUBLISH,SWAP -t default -o docs/api/rest_api/rest_api_reference/output/ docs/api/rest_api/rest_api_reference/input/ez.raml |
There was a problem hiding this comment.
There is no need to use a temporary location.
Suggested change
| php tools/raml2html/raml2html.php build --non-standard-http-methods=COPY,MOVE,PUBLISH,SWAP -t default -o docs/api/rest_api/rest_api_reference/output/ docs/api/rest_api/rest_api_reference/input/ez.raml | |
| php tools/raml2html/raml2html.php build --non-standard-http-methods=COPY,MOVE,PUBLISH,SWAP -t default -o docs/api/rest_api/rest_api_reference/ docs/api/rest_api/rest_api_reference/input/ez.raml |
adriendupuis
commented
Mar 3, 2023
Comment on lines
13
to
26
| public const DEFAULT_FILE_LIST = [ | ||
| 'vendor/ibexa/rest/src/bundle/Resources/config/routing.yml', | ||
| //'vendor/ibexa/commerce-rest/src/bundle/Resources/config/routing.yaml', // Removed as of 4.4 | ||
| // `find $dxpRoot/vendor/ibexa -name "routing_rest.y*ml"` | ||
| //'vendor/ibexa/admin-ui/src/bundle/Resources/config/routing_rest.yaml', | ||
| 'vendor/ibexa/calendar/src/bundle/Resources/config/routing_rest.yaml', | ||
| 'vendor/ibexa/cart/src/bundle/Resources/config/routing_rest.yaml', | ||
| 'vendor/ibexa/connector-dam/src/bundle/Resources/config/routing_rest.yaml', | ||
| 'vendor/ibexa/personalization/src/bundle/Resources/config/routing_rest.yaml', | ||
| 'vendor/ibexa/product-catalog/src/bundle/Resources/config/routing_rest.yaml', | ||
| //'vendor/ibexa/scheduler/src/bundle/Resources/config/routing_rest.yaml', // prefixed /api/datebasedpublisher/v1 | ||
| 'vendor/ibexa/segmentation/src/bundle/Resources/config/routing_rest.yaml', | ||
| 'vendor/ibexa/taxonomy/src/bundle/Resources/config/routing_rest.yaml', | ||
| ]; |
There was a problem hiding this comment.
This shouldn't be there but in an independent config file to ease variation between versions.
For 4.3, uncomment 'vendor/ibexa/commerce-rest/src/bundle/Resources/config/routing.yaml'
For 3.3, use
public const DEFAULT_FILE_LIST = [
'vendor/ezsystems/ezplatform-rest/src/bundle/Resources/config/routing.yml',
'vendor/ezsystems/ezcommerce-rest/src/Siso/RestBundle/Resources/config/routing.yaml',
// `find $dxpRoot/vendor/ezsystems -name "routing_rest.y*ml"`
//'vendor/ezsystems/ezplatform-admin-ui/src/bundle/Resources/config/routing_rest.yaml',
'vendor/ezsystems/date-based-publisher/bundle/Resources/config/routing_rest.yaml',
'vendor/ezsystems/ezplatform-calendar/src/bundle/Resources/config/routing_rest.yaml',
'vendor/ezsystems/ezplatform-connector-dam/src/bundle/Resources/config/routing_rest.yaml',
'vendor/ezsystems/ezrecommendation-client/src/bundle/Resources/config/routing_rest.yaml',
];There was a problem hiding this comment.
There will be the addition of vendor/ibexa/corporate-account/src/bundle/Resources/config/routing_rest.yaml to 4.x, see https://github.com/ibexa/corporate-account/pull/155/files#diff-cd2d6c168e688c1fe9908fbfeb46faca08e464562c38a143e38c16a6bdd1b246 and #1930
adriendupuis
changed the title
# Conflicts: # tools/raml2html/README.md # tools/raml2html/composer.json
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.
Compares the REST API reference to DXP config.
This tool helps to find missing REST routes, missing REST route methods and non-existent REST routes.
It extracts reference routes from the HTML output of the raml2html build. It extracts configuration routes from the yaml files of the DXP. It compares routes existng only on one side and it compares methods of common routes. When a route doesn't exists on one side, it tries few argument renamings (like
Id↔︎Identifier) or if the route if flagged(removed)(see #1642 for the unification of depreciation and removal flags).Checklist