davalapar/api-spec.md

Last active December 20, 2019 02:43

Star () You must be signed in to star a gist
Fork () You must be signed in to fork a gist

Learn more about clone URLs
Clone this repository at <script src="https://gist.github.com/davalapar/a386d942d12ce51d3e19c1da40c58621.js"></script>
Save davalapar/a386d942d12ce51d3e19c1da40c58621 to your computer and use it in GitHub Desktop.

api-spec.md

Raw

    - 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


  

Author

davalapar commented Dec 20, 2019

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