Tabella Demo Server

A demo RPC API using Tabella. The OAuth 2.0 server used for authentication will accept anything as client ID. The API key for API auth is `coffee` and the bearer token for Bearer auth is `mocha`.

1.0.0

Apache-2.0

Contact

Matthew Burkard

https://gitlab.com/mburkard/tabella

[email protected]

Methods

⮞ auth.sign_up

Create a new user.

Parameters

username required info

Unique username/email for a new user.

string

password required info

Password of the new user.

string

Example Request

{
  "id": 1,
  "method": "auth.sign_up",
  "params": {
    "username": "string",
    "password": "string"
  },
  "jsonrpc": "2.0"
}

Result info

The new user object.

⮞ User

Example Response

{
  "id": 1,
  "result": {
    "id": "ab44feb9-51c4-438b-b88e-4c05f3206064",
    "username": "string",
    "password": "string"
  },
  "jsonrpc": "2.0"
}

⮞ auth.sign_in

Get a JWT for an existing user.

Parameters

username required info

Username/email of the user.

string

password required info

User password.

string

Example Request

{
  "id": 1,
  "method": "auth.sign_in",
  "params": {
    "username": "string",
    "password": "string"
  },
  "jsonrpc": "2.0"
}

Result info

A JWT for the user with the given credentials.

⮞ Token

Example Response

{
  "id": 1,
  "result": {
    "access_token": "string",
    "refresh_token": null,
    "token_type": "string"
  },
  "jsonrpc": "2.0"
}

⮞ note.create_note

Create a new note.

lock_open

Parameters

note required info

Content of the note.

string

tag required info

Tag the note for filtering.

string | null

Example Request

{
  "id": 1,
  "method": "note.create_note",
  "params": {
    "note": "string",
    "tag": "string"
  },
  "jsonrpc": "2.0"
}

Result info

The new note.

⮞ Note

Example Response

{
  "id": 1,
  "result": {
    "id": "815b7bf9-78be-42c6-ac42-3a48dd1c1582",
    "user_id": "77dbd5ab-c482-42e2-86aa-b6523826b0d9",
    "note": "string",
    "tag": "string"
  },
  "jsonrpc": "2.0"
}

⮞ note.update_note

Update a new note.

lock_open

Parameters

note_id required info

ID of the note to update.

string uuid

note required info

Updated note content, if provided.

string

tag required info

Updated note tag, if provided.

string

Example Request

{
  "id": 1,
  "method": "note.update_note",
  "params": {
    "note_id": "67a6a27b-906f-47f3-a590-46c3e88096e5",
    "note": "string",
    "tag": "string"
  },
  "jsonrpc": "2.0"
}

Result info

The updated note.

⮞ Note

Example Response

{
  "id": 1,
  "result": {
    "id": "a47a21f9-9e47-478d-b8b8-ccf086591328",
    "user_id": "732375b7-d09b-4a1f-9145-e41265cbb3ef",
    "note": "string",
    "tag": "string"
  },
  "jsonrpc": "2.0"
}

⮞ note.delete_note

Delete an existing note.

lock_open

Parameters

note_id

string uuid

Example Request

{
  "id": 1,
  "method": "note.delete_note",
  "params": {
    "note_id": "9cb16d86-4f29-4698-b49f-14b3f268d17e"
  },
  "jsonrpc": "2.0"
}

Result info

Null.

null

Example Response

{
  "id": 1,
  "result": null,
  "jsonrpc": "2.0"
}

⮞ note.get_notes

Get notes.

lock_open

Parameters

tag = null info

Optional tag to filter by.

string | null

Example Request

{
  "id": 1,
  "method": "note.get_notes",
  "params": {
    "tag": null
  },
  "jsonrpc": "2.0"
}

Result info

List of notes matching the filter.

array [ ⮞ Note ]

Example Response

{
  "id": 1,
  "result": [
    {
      "id": "08fdfd5c-677e-415e-987e-650f7a0672da",
      "user_id": "ded41be9-2376-4f68-9fe3-d2260f222d66",
      "note": "string",
      "tag": "string"
    }
  ],
  "jsonrpc": "2.0"
}

⮞ note.get_note

Get a note.

lock_open

Parameters

note_id required info

ID of the note to get.

string uuid

Example Request

{
  "id": 1,
  "method": "note.get_note",
  "params": {
    "note_id": "f8ec5199-95ea-470d-8352-2d332173e72c"
  },
  "jsonrpc": "2.0"
}

Result info

Note of the given ID.

⮞ Note | null

Example Response

{
  "id": 1,
  "result": {
    "id": "392124cf-8991-4339-9744-2f6e5e7bac84",
    "user_id": "9e6832b3-04db-46c5-bf77-929c4b8422e7",
    "note": "string",
    "tag": "string"
  },
  "jsonrpc": "2.0"
}