Event Data Structure

Projects

Base

interface ProjectBase {
	id: number;
	typeId: number;
	name: string;
}

Projects Overview

The projects overview page for one account. It lists all available projects, showing an ProjectOverview[].

interface ProjectOverview extends ProjectBase {
	totalConfigurations: number;
	totalEntries: number;
}

Project Detail / Config Overview

The details page for one project, aka the configuration overview page. It lists all configurations for one project, showing an ConfigurationOverview[]. Allows to add, update and delete them.

interface ProjectDetails extends ProjectBase {
	totalEntries: number;
	configurations: ConfigurationOverview[];
}

Responses

Create

interface ProjectCreateResponse {
	id: number;
	typeId: number;
	name: string;
}

Update

export interface ProjectUpdateResponse {
	id: number;
	typeId: number;
	name: string;
}

Delete

export interface ProjectDeleteResponse {
	id: number;
	typeId: number;
	name: string;
}

Configuration

Base

interface ConfigurationBase {
	id: number;
	typeId: number;
	name: string;
}

Config Overview / Project Details

The configuration overview page of one project. It lists all available configurations, showing an ConfigurationOverview[].

interface ConfigurationOverview extends ConfigurationBase {
	entries: number;
}

Config Details

The details page for one configuration. It lists all configuration entries. Allows to add, update and delete them.

interface ConfigurationDetails extends ConfigurationBase {
	entries: ConfigurationEntry[];
}

interface ConfigurationEntry {
    id: number;
    key: string;
    value: string;
    disabled: boolean;
    expire: number;
}

Example of whole configuration data

{
  "id": 1,
  "name": "base",
  "typeId": 1,
  "entries": [
    {
      "id": 1,
      "key": "environment",
      "value": "dev"
    },
    {
      "id": 2,
      "key": "AUTH_REQUIRED",
      "value": true,
      "disabled": true,
      "secondsToLive": 6901232123
    },
    {
      "id": 3,
      "key": "sentry.secret",
      "value": "secretsecret"
    }
  ]
}