API

API Playground

A complete API reference is available as part of the live editor at the /playground endpoint of your VADAAR instance (for example, http://localhost:8442/playground if your instance is hosted locally). The playground is only accessible while the VADAAR Server instance is running because it is generated against the current API.

Prerequisite

A Personal Access Token is required to access the API.

1. Navigate to the /playground endpoint.
2. Create a New Tab using Ctrl + Alt + T.
3. Near the bottom of the page, select HTTP Headers and in the text box, set the following with TOKEN substituted with a personal access token:

   {
     "Authorization": "Bearer TOKEN"
   }
4. Near the top-left, select the Reload schema button represented by a refresh icon (or use Shift + Alt + Enter).

Result: The editor should now be usable. You may run this example query as a test.

query WhoAmI {
  me {
    user {
      givenName
    }
  }
}

tip

You can use Ctrl + Alt + Enter to run a query.

API Reference

Prerequisite

The API Reference is accessible after following the steps for accessing the API Playground.

In the API Playground, near the top-left, select the Operations drop-down and select Schema Reference.

All fields on the Query type will be shown. Mutations, Subscriptions and other types can be viewed by changing the filters on the right-hand pane.