Skip to content

Instantly share code, notes, and snippets.

@davalapar

davalapar/api-spec.md

Last active December 20, 2019 02:43
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save davalapar/a386d942d12ce51d3e19c1da40c58621 to your computer and use it in GitHub Desktop.
Save davalapar/a386d942d12ce51d3e19c1da40c58621 to your computer and use it in GitHub Desktop.
Download ZIP
api-spec.md
Raw
api-spec.md 
- Endpoints are in plural form
- Actions are create, read, update, and delete
- Phases are init, prep, and exec
  - init (initialize) returns essential data
  - prep (prepare) returns confirmation data
  - exec (execute) returns result data

      Protocol : https
      Hostname : articles.com
      Endpoint : /api/articles
        Action : /create
    Parameters : { phase: 'exec', title: '', description: '' }
 Serialization : cbor
   Compression : gzip
Authentication : hmac-sha256
@davalapar
Copy link
Author 

table types: `in-memory`, `disk-only`

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment