api-docs

API Sections

Schemas

We are in the process of generating schemas for all of our data. This is a work in progress, and we will update this page as we add new schema files.

There are schema files for response data ‘objects’, and schema files for the entire OPTIONS response.

Response Objects

The schema files are located within the API repo at public/api/schema.

• Assigned category
• Assigned subcategory
• Category
• Currency
• Error log
• Item of type Allocated Expense
• Item category
• Item of type Game
• Item subcategory
• Item subtype
• Item type
• Partial transfer
• Permitted user
• Resource type including permitted users
• Resource type including resources
• Item of type Allocated Expense as resource type level
• Item of type Game as resource type level
• Resource type
• Resource
• Subcategory
• Transfer

OPTIONS Response

The schema files for OPTIONS responses are located within the API repo at public/api/schema/options and public/api/schema/auth/options

We aren’t sure why there are two directories for OPTIONS responses schemas, we will sort is out as we add aditional tests.

OPTIONS

• Resource type collection
• Resource type

Authentication OPTIONS

• Create password
• Register

This site is open source. Improve this page.