Ion Channel Yolanda API

Base URL: /v1, Version: 0.0.3

Yolanda is the 'project' microservice for the Ion Channel

Default response content-types: application/json
Schemes: https

Summary

Path Operation Description
/project/createProject POST

Create a new project

/project/getProject GET

Retrieve the project details given a project ID

/project/getProjects GET

Retrieve a list of projects details given an account ID

/project/updateProject PUT

Update an existing project

Paths

Create a new project

POST /project/createProject

Tags: Project

the POST /project/createProject creates a new project.

project object to create

Uses default content-types: application/json

201 Created

An object containing the new project

400 Bad Request

Invalid parameters provided

404 Not Found

A property provided was not found

422 Unprocessable Entity

Missing a required param

default

Unexpected error

Retrieve the project details given a project ID

GET /project/getProject

Tags: Project

the /project/getProject endpoint returns an object containing the details for a given project.

id

The ID of the project to request details for

query string (uuid)
team_id

The ID of the project to request details for

query string (uuid)

Uses default content-types: application/json

200 OK

An object containing the project's details

404 Not Found

No the project details were found

default

Unexpected error

Retrieve a list of projects details given an account ID

GET /project/getProjects

Tags: Project

the /project/getProjects endpoint returns an object containing an array of projects for a given team_id.

team_id

The ID of the account to request all projects for

query string (uuid)
limit

Limit the number of rows in the response. To receive all rows set limit to 0.

query integer 10
offset

Starting row for responses (for pagination)

query integer

Uses default content-types: application/json

200 OK

An object containing a list of projects

404 Not Found

No the project details were found

default

Unexpected error

Update an existing project

PUT /project/updateProject

Tags: Project

the PUT /project/updateProject updates an existing project.

project object to create

Uses default content-types: application/json

200 OK

An object containing the updated project

400 Bad Request

Invalid parameters provided

404 Not Found

A id provided was not found

422 Unprocessable Entity

Missing a required param

default

Unexpected error

Schema definitions

Error: object

code: integer (int32)
message: string
fields: string

Meta: object

copyright: string

Copyright info

authors: string

Authors

version: string

API version

last_update: string

Last update of source data (optional)

Project: object

id: string (uuid)

Unique identifier representing a specific project

name: string

Name of the project?

active: boolean

Is the project active

type: string

Source type for the project (git|file)

source: string

Source endpoint for the project (git repo)

branch: string

Source specifier for a source (git branch)

description: string

Short description of the project

chat_channel: string

Group chat channel for the project

team_id: string (uuid)

Account ID of project owner

ruleset_id: string (uuid)

Governance ruleset ID associated with the project

meta: Meta
timestamps: Timestamps
links: Links

Projects: object

data: object[]
meta: Meta
timestamps: Timestamps
links: Links

Timestamps: object

created: string

Time the object was created

updated: string

Time the object was last updated