wix-incubator / corvid-spi-docs

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Velo-SPI-Docs

A JSON model representing Velo SPIs

Steps to Update Velo SPI

  1. Copy the updated service.json from wix-code-docs and replace the corresponding service.json in the corvid-spi-docs repository.

  2. Add the layoutType field to the service.json. For example:

    "layoutType": "JS"
  3. Add the memberOf field to the service.json with the EDM name (usually the folder name). For example:

    "memberOf": "wix-ecom"

Here is an example of how it should look:

ecom-additional-fees service.json example

  1. Add the module prefix to all type paths. For example:

    "type": "ecom-additional-fees.Options"

    should be replaced by:

    "type": "wix-ecom.ecom-additional-fees.Options"

Example:

alt text

  1. Push the changes to a branch and verify with branch preview.
  2. Merge the branch into master.

About

License:MIT License