delta 0.7.18

  • Contact: N/A
  • License: N/A

Resources

aws_actor

way to trigger aws configure actor message

Operations

Method and Path Description
POST /actors/aws/:build_id

Trigger actor message for build id

dashboard_build

Operations

Method and Path Description
GET /dashboard_builds

event

Operations

Method and Path Description
GET /events
GET /events/:id

github_user

Operations

Method and Path Description
POST /authentications/github

Used to authenticate a user via github

github_webhook

The target of the github webooks

Operations

Method and Path Description
POST /webhooks/github/:project_id

Receives a webhook on push for this particular project

image

Operations

Method and Path Description
GET /images
GET /images/:id
DELETE /images/:id

io.flow.common.v0.models.user

Operations

Method and Path Description
GET /users

Search for a specific user. You must specify at least 1 parameter - either a id or email - and will receive back either 0 or 1 users.

GET /users/:id

Returns information about the user with this id.

GET /users/:id/identifier

Returns the latest identifier for this user. The basic use case is to enable things like unsubscribe w/out login (and thus once you have an identifier, you can GET /users?identifier=xxx). Identifiers are rotated regularly with last n identifiers being valid (allowing eventual expiration).

POST /users

Create a new user.

item

Operations

Method and Path Description
GET /items

Returns a list of all matching items

membership

Operations

Method and Path Description
GET /memberships

Search all memberships. Results are always paginated.

GET /memberships/:id
POST /memberships
DELETE /memberships/:id

organization

Operations

Method and Path Description
GET /organizations

Search organizations. Results are paginated

GET /organizations/:id

Returns information about the organization with this id.

POST /organizations

Create a new organization.

PUT /organizations/:id

Update an existing organization.

DELETE /organizations/:id

project

Operations

Method and Path Description
GET /projects

Search projects. Results are paginated

GET /projects/:id

Returns information about the project with this id.

POST /projects

Create a new project.

POST /projects/:id/events/pursue_desired_state

Triggers the pursue desired state event.

PUT /projects/:id

Update an existing project.

DELETE /projects/:id
GET /projects/:id/builds/states
GET /projects/:id/builds/:build_name/states/desired
POST /projects/:id/builds/:build_name/states/desired
GET /projects/:id/builds/:build_name/states/last

repository

Operations

Method and Path Description
GET /github

Returns a list of repositories from github

GET /github/:owner/:repo/config

Returns the delta configuration for the specified github repo, if the repo has a .delta file in its root

sha

Operations

Method and Path Description
GET /shas
GET /shas/:id
DELETE /shas/:id

sns_message_ami

Operations

Method and Path Description
POST /sns_message_amis

subscription

Operations

Method and Path Description
GET /subscriptions

Search subscriptions. Always paginated.

GET /subscriptions/:id

Returns information about a specific subscription.

POST /subscriptions

Create a new subscription.

DELETE /subscriptions/:id

tag

Operations

Method and Path Description
GET /tags
GET /tags/:id
DELETE /tags/:id

token

Operations

Method and Path Description
GET /tokens
GET /tokens/:id

Used to fetch one token

POST /tokens

Create a new API token for this user

DELETE /tokens/:id

Headers

No headers

Imports

https://app.apibuilder.io/flow/common/0.0.12/service.json
https://app.apibuilder.io/flow/delta-config/0.1.68/service.json
https://app.apibuilder.io/flow/error/latest/service.json
https://app.apibuilder.io/flow/github/0.0.3/service.json

Enums

docker_provider

Name Value Description
docker_hub docker_hub

event_type

Name Value Description
change change

Indicates this event actually reported a successful change was completed in the project

info info

Indicates this was an informational event only

publication

A publication represents something that a user can subscribe to.

Name Value Description
deployments deployments

Get notified of all deployments

role

Name Value Description
member member

admin admin

scms

Name Value Description
github github

status

Name Value Description
enabled enabled

paused paused

visibility

Name Value Description
public public

private private

Models

aws_actor

Example Json: Minimal | Full

Defines an aws actor

Field Type Required? Default Description
id long Yes -

build

Example Json: Minimal | Full

A build provides information abuot a dockerfile and the name of the build in the registry.

Field Type Required? Default Description
id string Yes -

project project_summary Yes -

status status Yes -

name string Yes -

This is the full name of the application that this build represents and is used to lookup information in the registry, in docker hub, in AWS, etc.

Example: delta-api

build_state

Example Json: Minimal | Full

Describes the last and desired states of a build

Field Type Required? Default Description
name string Yes -

The build name

desired state No -

last state No -

latest_image string No -

If available, the full name of the latest image for this build

dashboard_build

Example Json: Minimal | Full

Summary of each build for the purposes of displaying on a dashboard

Field Type Required? Default Description
project project_summary Yes -

name string Yes -

The build name

desired state Yes -

last state Yes -

docker

Example Json: Minimal | Full
Field Type Required? Default Description
provider docker_provider Yes -

organization string Yes -

Example: flowcommerce

ecs_ami_region_image

Example Json: Minimal | Full
Field Type Required? Default Description
Name string Yes -

ImageId string Yes -

ecs_ami_regions

Example Json: Minimal | Full
Field Type Required? Default Description
us-east-1 ecs_ami_region_image Yes -

ecs_amis

Example Json: Minimal | Full
Field Type Required? Default Description
Regions ecs_ami_regions Yes -

event

Example Json: Minimal | Full
Field Type Required? Default Description
id string Yes -

created_at date-time-iso8601 Yes -

project project_summary Yes -

type event_type Yes -

summary string Yes -

error string No -

github_authentication_form

Example Json: Minimal | Full

Used to authenticate user based on the oauth code we receive from github

Field Type Required? Default Description
code string Yes -

github_user

Example Json: Minimal | Full
Field Type Required? Default Description
id string Yes -

user reference Yes -

github_user_id long Yes -

login string Yes -

github_user_form

Example Json: Minimal | Full
Field Type Required? Default Description
user_id string Yes -

github_user_id long Yes -

login string Yes -

github_webhook

Example Json: Minimal | Full

Defines a github hook

Field Type Required? Default Description
id long Yes -

image

Example Json: Minimal | Full
Field Type Required? Default Description
id string Yes -

build build Yes -

name string Yes -

version string Yes -

image_form

Example Json: Minimal | Full
Field Type Required? Default Description
build_id string Yes -

name string Yes -

version string Yes -

item

Example Json: Minimal | Full

A denormalization of item content for search

Field Type Required? Default Description
id string Yes -

Unique identifier for this item.

organization organization_summary Yes -

visibility visibility Yes -

summary item_summary Yes -

label string Yes -

description string No -

membership

Example Json: Minimal | Full

A user can belong to one or more organizations via memberships.

Field Type Required? Default Description
id string Yes -

Unique identifier for this membership

user user_summary Yes -

organization organization_summary Yes -

role role Yes -

membership_form

Example Json: Minimal | Full
Field Type Required? Default Description
user_id string Yes -

organization string Yes -

role role Yes member

organization

Example Json: Minimal | Full
Field Type Required? Default Description
id string Yes -

user user_summary Yes -

The user that created this organization

docker docker Yes -

Required information to locate docker images for projects associated with this organization.

travis travis Yes -

organization_form

Example Json: Minimal | Full
Field Type Required? Default Description
id string Yes -

docker docker Yes -

travis travis Yes -

organization_summary

Example Json: Minimal | Full
Field Type Required? Default Description
id string Yes -

project

Example Json: Minimal | Full
Field Type Required? Default Description
id string Yes -

organization organization_summary Yes -

user reference Yes -

The user that created this project

visibility visibility Yes -

scms scms Yes -

name string Yes -

uri string Yes -

config io.flow.delta.config.v0.unions.config:0.1.68 Yes -

project_form

Example Json: Minimal | Full
Field Type Required? Default Description
organization string Yes -

name string Yes -

visibility visibility Yes -

scms scms Yes -

uri string Yes -

config io.flow.delta.config.v0.models.config_project:0.1.68 No -

Project configuration. If not provided, we use the global default

project_summary

Example Json: Minimal | Full
Field Type Required? Default Description
id string Yes -

organization organization_summary Yes -

name string Yes -

uri string Yes -

reference

Example Json: Minimal | Full
Field Type Required? Default Description
id string Yes -

repository

Example Json: Minimal | Full
Field Type Required? Default Description
name string Yes -

visibility visibility Yes -

uri string Yes -

sha

Example Json: Minimal | Full
Field Type Required? Default Description
id string Yes -

project project_summary Yes -

created_at date-time-iso8601 Yes -

branch string Yes -

hash string Yes -

sns_message_ami

Example Json: Minimal | Full
Field Type Required? Default Description
ECSAmis [ecs_amis] Yes -

state

Example Json: Minimal | Full

Used to describe the last state of a project in AWS. Specifically which versions are running

Field Type Required? Default Description
timestamp date-time-iso8601 Yes -

Example: Date / time that this state was captured

versions [version] Yes -

state_form

Example Json: Minimal | Full
Field Type Required? Default Description
versions [version] Yes -

subscription

Example Json: Minimal | Full

Represents a user that is currently subscribed to a publication

Field Type Required? Default Description
id string Yes -

Internal unique identifier for this subscription record

user reference Yes -

publication publication Yes -

subscription_form

Example Json: Minimal | Full
Field Type Required? Default Description
user_id string Yes -

publication publication Yes -

tag

Example Json: Minimal | Full
Field Type Required? Default Description
id string Yes -

project project_summary Yes -

created_at date-time-iso8601 Yes -

name string Yes -

hash string Yes -

token

Example Json: Minimal | Full
Field Type Required? Default Description
id string Yes -

user reference Yes -

masked string Yes -

cleartext string No -

The cleartext token. Only available when the token is initially created

description string No -

token_form

Example Json: Minimal | Full
Field Type Required? Default Description
user_id string Yes -

description string No -

travis

Example Json: Minimal | Full
Field Type Required? Default Description
organization string Yes -

Example: flowcommerce

user_form

Example Json: Minimal | Full
Field Type Required? Default Description
email string No -

name io.flow.common.v0.models.name:0.0.12 No -

user_identifier

Example Json: Minimal | Full
Field Type Required? Default Description
id string Yes -

user reference Yes -

value string Yes -

user_summary

Example Json: Minimal | Full
Field Type Required? Default Description
id string Yes -

email string No -

name io.flow.common.v0.models.name:0.0.12 Yes -

username_password

Example Json: Minimal | Full
Field Type Required? Default Description
username string Yes -

password string No -

variable

Example Json: Minimal | Full

Configuration variable of an organization

Field Type Required? Default Description
id string Yes -

organization organization_summary Yes -

key string Yes -

value string Yes -

variable_form

Example Json: Minimal | Full
Field Type Required? Default Description
organization string Yes -

key string Yes -

value string Yes -

version

Example Json: Minimal | Full
Field Type Required? Default Description
name string Yes -

Example: 0.0.1

instances long Yes -

The number of instances running this version

Unions

item_summary

  • Type discriminator: discriminator
Type Discriminator Value Example Json Description
project_summary project_summary Minimal | Full

Annotations

No annotations