Skip to content

Commit

Permalink
Rename ez*.raml to ibexa*.raml (#2360)
Browse files Browse the repository at this point in the history
  • Loading branch information
adriendupuis authored Apr 17, 2024
1 parent 97adf70 commit 7384530
Show file tree
Hide file tree
Showing 50 changed files with 82 additions and 82 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ It is based on `*.raml` files located in the `docs/api/rest_api/rest_api_referen

After you modify relevant files in the input folder, you can generate an HTML file from repository root (this step can also be performed by one of the Tech Writers during PR review):

`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/output/ docs/api/rest_api/rest_api_reference/input/ibexa.raml`

In case of errors, look for mistakes in the RAML file, for example, double apostrophes.
Move `rest_api_reference.html` from the output folder to `docs/api/rest_api/rest_api_reference/` root.
Expand Down
80 changes: 0 additions & 80 deletions docs/api/rest_api/rest_api_reference/input/ez.raml

This file was deleted.

80 changes: 80 additions & 0 deletions docs/api/rest_api/rest_api_reference/input/ibexa.raml
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
#%RAML 1.0
---
title: Ibexa REST API
baseUri: ../rest_api_usage/rest_api_usage/

/: !include ibexa-root.raml

/bookmark: !include ibexa-bookmark.raml

/content:
displayName: Managing content
/objects: !include ibexa-content-objects.raml
/objectstategroups: !include ibexa-objectstategroups.raml
/locations: !include ibexa-content-locations.raml
/views: !include ibexa-content-views.raml
/sections: !include ibexa-content-sections.raml
/trash: !include ibexa-content-trash.raml
/urlaliases: !include ibexa-content-urlaliases.raml
/urlwildcards: !include ibexa-content-urlwildcards.raml
/typegroups: !include ibexa-content-typegroups.raml
/types: !include ibexa-content-types.raml
# /assets: !include ibexa-content-assets.raml
#/binary: !include ibexa-content-binary.raml

/views: !include ibexa-views.raml

/calendar: !include ibexa-calendar.raml


/user:
displayName: Managing users
/current: !include ibexa-user-current.raml
/groups: !include ibexa-user-groups.raml
/users: !include ibexa-user-users.raml
/roles: !include ibexa-user-roles.raml
/policies: !include ibexa-user-policies.raml
/sessions: !include ibexa-user-sessions.raml
/token: !include ibexa-user-token.raml

#/segments: !include ibexa-segment_groups.raml
#/segment_groups: !include ibexa-segment_groups.raml

#/personalization/v1: !include ibexa-personalization.raml

/services: !include ibexa-services.raml

/languages: !include ibexa-languages.raml

/cart: !include ibexa-cart.raml

/commerce: !include ibexa-commerce.raml

/orders: !include ibexa-orders.raml

/payment-method: !include ibexa-payment-methods.raml

/shipping: !include ibexa-shipping.raml

/shipments: !include ibexa-shipments.raml

/corporate: !include ibexa-corporate.raml

/product/catalog:
displayName: Product catalog
/catalogs: !include ibexa-product-catalogs.raml
/currencies: !include ibexa-product-currency.raml
/regions: !include ibexa-product-regions.raml
/attribute_types: !include ibexa-product-attributetypes.raml
/attribute_groups: !include ibexa-product-attributegroups.raml
/attributes: !include ibexa-product-attributes.raml
/customer_groups: !include ibexa-product-customergroups.raml
/product_types: !include ibexa-product-producttypes.raml
/products: !include ibexa-product-products.raml
/product_variants: !include ibexa-product-productvariants.raml
/product_variant: !include ibexa-product-productvariant.raml
/vat: !include ibexa-product-vat.raml

/taxonomy: !include ibexa-taxonomy.raml

types: !include ibexa-types.raml
2 changes: 1 addition & 1 deletion tools/raml2html/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ To generate static HTML from RAML definitions, use the following code:


```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/ 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/ibexa.raml
```

0 comments on commit 7384530

Please sign in to comment.