Adobe Commerce REST schema transformer

A toolkit that gets, cleans up, updates, and converts a Commerce's REST schema for Redoc.

Prerequisites

1. Ruby
2. Node.js
3. Yarn
4. jq

Install dependencies

yarn install

Configure variables

Create a .env file:

cp .env.example .env

Set values for your running Commerce app in .env.

Get, transform, and process the schema

You can get all three original schemas and transform them in one run. Just make sure the Magento app is running.

bin/get-schemas-for-redoc

NOTE: Be ready to enter a 2FA code and a version of the running Adobe Commerce.

Find the redoc-ready schemas at __output__. For debugging, use intermediate results in __output__/artifacts.

Running tests

This project uses Jest for tests.

Use the following to run tests:

yarn test