Make sure to have Docker installed so you don't have to install the tooling for every API clients.

nvm use && yarn

You can also execute docker commands one by one, see Docker commands

yarn docker:setup

Build docker image from Dockerfile

yarn docker:build

Mount docker image on dev container

yarn docker:mount

Stops dev container and clean the built image

yarn docker:clean

You can make changes locally and run commands through the docker container.

yarn docker build:specs <client | all>

yarn docker build:specs

yarn docker build:specs recommend

This is used by the build script and should not need to be called manually but if you want to format all specs file do:

yarn docker specs:fix

If you just want to check the format (not override the files), run:

yarn docker specs:lint <client> yarn docker specs:lint search

yarn docker generate <language | all> <client | all>

yarn docker generate

yarn docker build:clients <language | all> <client | all>

yarn docker build:clients java recommend

The clients can be tested inside the playground folder and with the common test suite (CTS)

yarn docker playground <language> <client>

yarn docker playground javascript search

yarn playground:browser

yarn docker playground java search

Error: The operation couldn't be completed. Unable to locate a Java Runtime.

Java is not located in your PATH, either source the right .bash_profile, .zshrc, etc. file or do the following command in this repository:

echo 'export PATH="/usr/local/opt/openjdk/bin:$PATH"' > .bash_profile && source .bash_profile