Skip to content

README.md

Latest commit

 

History

History
61 lines (40 loc) · 1.65 KB

README.md

File metadata and controls

61 lines (40 loc) · 1.65 KB

CatalogIt API

CircleCI API Version 1.2.0

GET /v1/containers

Returns all container names.

GET /v1/container/:name

Returns an array of all active containers; use query parameter all to see inactive and active containers.

GET /v1/container/:name/:version

Returns a single container.

POST /v1/containers

Creates new container :Container. Returns new object if successful or error otherwise

Fields

name
- type:        String
- required:    true
- description: Name of container. Must be unique in combination with version.
- requirement: Must be a string using only [A-Za-z0-9_-]

version
- type:        String
- required:    true
- description: The docker version. Must be unique in combination with name.
- requirement: Must be a string

image
- type:        String
- required:    true
- description: The docker image tag.
- requirement: must be a valid docker link (formatted docker-image-name:tag. With no
               underscores!

active
- type:        Boolean
- required:    false
- description: Wether the name/version pair is active. Inactive means it will not be shown
- requirement: Must be a boolean value.

POST /v1/container/:name/:version

Sets a container to active state (must already exist via POST /v1/containers).

DELETE /v1/container/:name/:version

Sets a container to inactive state. Will not be shown in default listing of container versions.

README generated by running npm run readme in repository while app runs locally on default port.