Skip to content

Commit 9a5db0a

Browse files
committed
raml2html/README.md: enh. test:compare doc
1 parent b976ef5 commit 9a5db0a

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

tools/raml2html/README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,20 @@ composer install;
1414

1515
## Usage
1616

17+
### Generate
18+
1719
To generate static HTML from RAML definitions, use the following code from project root:
1820

1921
```sh
2022
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/ibexa.raml
2123
```
2224

23-
To test static HTML against an Ibexa DXP to find missing routes and removed routes:
25+
### Compare documented routes with DXP configured routes
26+
27+
To test static HTML against an Ibexa DXP to find routes missing from the doc, and routes removed from the DXP:
2428

2529
```sh
26-
php tools/raml2html/raml2html.php test:compare ~/ibexa-dxp docs/api/rest_api/rest_api_reference/rest_api_reference.html
30+
php tools/raml2html/raml2html.php test:compare ~/ibexa-dxp
2731
```
2832

2933
Note: The Ibexa DXP doesn't need to run.
@@ -34,5 +38,5 @@ cd ~/ibexa-dxp;
3438
composer create-project ibexa/commerce-skeleton . --no-install --ignore-platform-reqs --no-scripts;
3539
composer install --ignore-platform-reqs --no-scripts;
3640
cd -;
37-
php tools/raml2html/raml2html.php test ~/ibexa-dxp
41+
php tools/raml2html/raml2html.php test:compare ~/ibexa-dxp;
3842
```

0 commit comments

Comments
 (0)