@spotto/contract

README

This repository is a source of truth / documentation for the spotto-api.

The repository consists of a series of typescript classes that document the API contract between the spotto API and its clients

How do I get set up?

1. Clone this repository
2. yarn install
3. run 'yarn start' to start a documentation server

Contribution guidelines

When adding endpoints create a new folder / file for your endpoint. Fill out file using others as a guide.

Any response and request shapes should be specified in the /types folder. The documentation server is sometimes unable to understand more complicated interfaces. In these scenarios please create two types files, one with a logical working type that can be used by other repositories. The other will be simply for filling the response server.

Any documentation specific types files should have the suffix 'Docs' within the same folder. e.g.

• types
  • objects
    • objectTypes.ts
    • objectTypesDocs.ts

Who do I talk to?

• Repo owner or admin