Resources Enums Models Unions Annotations Clients

dependency 0.6.21

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

Resources

binary

Operations

Method and Path Description
GET /binaries

Search binaries. Results are paginated
GET /binaries/:id

Returns information about the binary with this id.
POST /binaries

Create a new binary.
DELETE /binaries/:id

binary_version

Operations

Method and Path Description
GET /binary_versions

Search binary versions. Results are paginated
GET /binary_versions/:id

Returns information about the binary version with this 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

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.

io.flow.healthcheck.v0.models.healthcheck

Operations

Method and Path Description
GET /_internal_/healthcheck

item

Operations

Method and Path Description
GET /items

Returns a list of all matching items

library

Operations

Method and Path Description
GET /libraries

Search libraries. Results are paginated
GET /libraries/:id

Returns information about the library with this id.
POST /libraries

Create a new library.
DELETE /libraries/:id

library_version

Operations

Method and Path Description
GET /library_versions

Search library versions. Results are paginated
GET /library_versions/:id

Returns information about the library version with this id.

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/users/:user_id

Returns the organization representing the individual user.
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.
PUT /projects/:id

Update an existing project.
PATCH /projects/:id

Patch an existing project
DELETE /projects/:id

project_binary

Operations

Method and Path Description
GET /project_binaries

Search project binaries. Results are paginated

project_library

Operations

Method and Path Description
GET /project_libraries

Search project libraries. Results are paginated

recommendation

Operations

Method and Path Description
GET /recommendations

Returns a list of recommendations for this user

repository

Operations

Method and Path Description
GET /repositories/github

Returns a list of repositories from github

resolver

Operations

Method and Path Description
GET /resolvers

Search resolvers. Results are paginated
GET /resolvers/:id

Returns information about the resolver with this id.
POST /resolvers

Create a new resolver.
DELETE /resolvers/:id

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

sync

Operations

Method and Path Description
GET /syncs
POST /syncs/all
POST /syncs/libraries

Synchronize libraries with given params
POST /syncs/binaries/:id
POST /syncs/libraries/:id
POST /syncs/projects/: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/latest/service.json
https://app.apibuilder.io/flow/error/latest/service.json
https://app.apibuilder.io/flow/github/0.0.3/service.json
https://app.apibuilder.io/flow/healthcheck/latest/service.json

Enums

binary_type

Name Value Description
scala scala

See http://www.scala-lang.org/
sbt sbt

See http://www.scala-sbt.org/

publication

A publication represents something that a user can subscribe to.

Name Value Description
daily_summary daily_summary

A daily summary of dependencies that can be upgraded

recommendation_type

Name Value Description
library library

binary binary

role

Name Value Description
member member

admin admin

scms

Name Value Description
github github

sync_event

Name Value Description
started started

completed completed

visibility

Name Value Description
public public

private private

Interfaces

No interfaces

Models

binary

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

organization organization_summary Yes -

name binary_type Yes -

binary_form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
organization_id string Yes -

name binary_type Yes -

binary_summary

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

organization organization_summary Yes -

name binary_type Yes -

binary_version

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

binary binary Yes -

version string Yes -

github_authentication_form

Example Json: Minimal | Full

Interfaces: None

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

Field Type Required? Default Description Annotations
code string Yes -

github_user

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

user io.flow.common.v0.models.user_reference:0.18.59 Yes -

github_user_id long Yes -

login string Yes -

github_user_form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
user_id string Yes -

github_user_id long Yes -

login string Yes -

github_webhook

Example Json: Minimal | Full

Interfaces: None

Defines a github hook

Field Type Required? Default Description Annotations
id long Yes -

item

Example Json: Minimal | Full

Interfaces: None

A denormalization of item content for search

Field Type Required? Default Description Annotations
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 -

library

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

organization organization_summary Yes -

group_id string Yes -

artifact_id string Yes -

resolver resolver_summary Yes -

The resolver where we found this library

library_form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
organization_id string Yes -

group_id string Yes -

artifact_id string Yes -

resolver_id string Yes -

version version_form No -

If provided, we automatically record this version of this library.

library_summary

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

organization organization_summary Yes -

group_id string Yes -

artifact_id string Yes -

library_version

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

library library Yes -

version string Yes -

cross_build_version string No -

membership

Example Json: Minimal | Full

Interfaces: None

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

Field Type Required? Default Description Annotations
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

Interfaces: None

Field Type Required? Default Description Annotations
user_id string Yes -

organization string Yes -

role role Yes member

organization

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

user io.flow.common.v0.models.user_reference:0.18.59 Yes -

The user that created this organization
key string Yes -

organization_form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
key string Yes -

organization_summary

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

key string Yes -

project

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

organization organization_summary Yes -

user io.flow.common.v0.models.user_reference:0.18.59 Yes -

The user that created this project
visibility visibility Yes -

scms scms Yes -

name string Yes -

uri string Yes -

project_binary

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

project project_detail Yes -

name string Yes -

version string Yes -

path string Yes -

binary reference No -

project_detail

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

organization organization_summary Yes -

name string Yes -

project_form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
organization string Yes -

name string Yes -

visibility visibility Yes -

scms scms Yes -

uri string Yes -

project_library

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

project project_detail Yes -

group_id string Yes -

artifact_id string Yes -

version string Yes -

cross_build_version string No -

path string Yes -

library reference No -

project_patch_form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
name string No -

visibility visibility No -

scms scms No -

uri string No -

project_summary

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

organization organization_summary Yes -

name string Yes -

recommendation

Example Json: Minimal | Full

Interfaces: None

Summary of a specific recommendations for a project. Designed for display in the project dashboard

Field Type Required? Default Description Annotations
id string Yes -

project project_detail Yes -

type recommendation_type Yes -

object reference Yes -

name string Yes -

The name of the library or binary to upgrade
from string Yes -

The current version
to string Yes -

The version to which we recommend upgrading
created_at date-time-iso8601 Yes -

reference

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

repository

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
name string Yes -

visibility visibility Yes -

uri string Yes -

resolver

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

visibility visibility Yes -

organization organization_summary No -

The organization that created the resolver. If empty, indicates a globally public resolver
uri string Yes -

Example: https://flow.artifactoryonline.com/flow/libs-release
credentials credentials No -

resolver_form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
visibility visibility Yes -

organization string Yes -

uri string Yes -

credentials credentials No -

resolver_summary

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

organization organization_summary No -

visibility visibility Yes -

uri string Yes -

subscription

Example Json: Minimal | Full

Interfaces: None

Represents a user that is currently subscribed to a publication

Field Type Required? Default Description Annotations
id string Yes -

Internal unique identifier for this subscription record
user io.flow.common.v0.models.user_reference:0.18.59 Yes -

publication publication Yes -

subscription_form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
user_id string Yes -

publication publication Yes -

sync

Example Json: Minimal | Full

Interfaces: None

Records when we start and complete each sync of a module (e.g. project)

Field Type Required? Default Description Annotations
id string Yes -

Unique identifier for this item.
object_id string Yes -

event sync_event Yes -

created_at date-time-iso8601 Yes -

token

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

user io.flow.common.v0.models.user_reference:0.18.59 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

Interfaces: None

Field Type Required? Default Description Annotations
user_id string Yes -

description string No -

user_form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
email string No -

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

user_identifier

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

user io.flow.common.v0.models.user_reference:0.18.59 Yes -

value string Yes -

user_summary

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

email string No -

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

username_password

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
username string Yes -

password string No -

version_form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
version string Yes -

Example: 1.0.0
cross_build_version string No -

Example: 2.11

Unions

credentials

Interfaces: None

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

item_summary

Interfaces: None

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

library_summary library_summary Minimal | Full

project_summary project_summary 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].