Resources Models Unions Annotations Clients

registry 0.3.41

History | Watch
  • Contact: N/A
  • License: N/A

Resources

application

Operations

Method and Path Description
GET /applications

Search applications. Always paginated.
GET /applications/versions

Provides visibility into recent changes of each application, including deletion
GET /applications/yaml

Returns YAML representation of applications.
GET /applications/:id

Returns information about a specific application.
POST /applications

Create a new application.
PUT /applications/:id

Upsert an application with the specified id.
DELETE /applications/:id

Delete the application with this id
PUT /applications/:id/dependencies/:dependency

Ensure that name is a dependencies for this project, adding if necessary.
DELETE /applications/:id/dependencies/:dependency

Remove name as a dependencies for this project

service

Operations

Method and Path Description
GET /services

Search services. Always paginated.
GET /services/versions

Provides visibility into recent changes of each service, including deletion
GET /services/:id

Returns information about a specific service.
POST /services

Create a new service.
PUT /services/:id

Upsert an service with the specified id.
DELETE /services/:id

Delete the service with this id

Headers

No headers

Imports

http://www.apidoc.me/flow/common/latest/service.json
http://www.apidoc.me/flow/error/latest/service.json

Enums

No enums

Interfaces

No interfaces

Models

application

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

ports [port] Yes -

All of the ports assigned to this application
dependencies [string] Yes -

A list of the direct dependencies of this application. Guaranteed to be non-cyclical over the set of all applications.

application_form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

service string Yes -

external long No -

The external port number to allocate to this application. Defaults to a unique port assigned by the registry.
internal long No -

The internal port number that this application runs on. Defaults to the service's default port number.
dependency [string] No -

The application IDs on which this application is dependent

application_put_form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
service string No -

external long No -

internal long No -

dependency [string] No -

application_version

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

timestamp date-time-iso8601 Yes -

type io.flow.common.v0.enums.change_type:0.18.59 Yes -

application application Yes -

http

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
host string Yes -

port long Yes -

The port on which clients access this service.

port

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
service service_reference Yes -

external long Yes -

The port on which clients access this service. If running in a container, this is the host port.
internal long Yes -

The port on which this service is running internally. If running in a container, this is the port inside the container.

postgresql

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
dbname string Yes -

The database name.
host string Yes -

port long Yes -

The port on which clients access this database.
user string Yes -

service

Example Json: Minimal | Full

Interfaces: None

A service is used to identify what type of software is actually running. We use this to enable setting up application types with enough configuration info by default to support our use cases around docker, CI, etc. The name service comes from https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.txt

Field Type Required? Default Description Annotations
id string Yes -

Example: play
default_port long Yes -

Example: 9000

service_form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

default_port long Yes -

service_put_form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
default_port long Yes -

service_reference

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

Example: play

service_version

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

timestamp date-time-iso8601 Yes -

type io.flow.common.v0.enums.change_type:0.18.59 Yes -

service service Yes -

Unions

healthcheck

Interfaces: None

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

postgresql postgresql Minimal | Full

Annotations

personal_data

Identifies a field that contains Personal Data, as defined by GDPR. By default, any field marked with this annotation will be kept for 1 year and will be purgeable upon request provided there are no incomplete business activities associated with it.

consumer

Identifies a field that contains data about a consumer [as opposed to an employee of Flow, an organization or a partner].