OpenAPI 3 Shotstack API Definition

Defines the Shotstack API and provides tooling for documentation and SDK generation.

Installation

The project is built using Node.js. To install the dependencies run the command:

npm install

Generating Docs

Generate the docs using:

npm run build:docs

Generated docs are saved to build/docs directory

You can preview the docs in the browser using:

npm run start

Deploy docs using:

npm run deploy:docs

Note: this deploys to Shotstack's S3 docs bucket, if you wish to host your own documentation, modify the script within the package.json file.

Generating SDK's

Requires the OpenAPI Generator to be installed.

npm install @openapitools/openapi-generator-cli -g

or

brew install openapi-generator

Once installed generate SDK's for PHP, Node and Ruby:

npm run build:sdks

Note: The generated SDK's need some modifications to work correctly, and files need to be copied to the respective project repos.

Copy the generated SDK files to each SDK project manually or run:

npm run build:sdks:update

Note: this overwrites all existing files.

By default files are written to the following locations: ../shotstack-sdk-node, ../shotstack-sdk-php and ../shotstack-sdk-ruby. To override the defaults and specify your own locations, run:

npm run build:sdks:update [NODE_SDK PATH PHP_SDK_PATH RUBY_SDK_PATH]

Note: you must provide all three paths in the correct order: Node, PHP, Ruby.

Linking Shins as a Subtree

This is for reference only, you should not need to follow these steps.

Add our fork of Shins:

git remote add -f shins [email protected]:shotstack/shins.git

Add it as a subtree:

git subtree add --prefix .shins/ shins master --squash

To pull latest changes:

git subtree pull --prefix=.shins/ shins master --squash

For more details on Git subtrees see: https://www.atlassian.com/git/tutorials/git-subtree

Installing Shins

Follow the process above to link and update Shins as a subtree, then:

cd .shins
npm install