api: update image builder api via npm run api
There have been some recent updates to the /experimental/ routes related to blueprints, this commit pulls them in.
This commit is contained in:
lucasgarfield
Lucas Garfield
parent
7982ec4981
commit
46ac78b1de
2 changed files with 237 additions and 150 deletions
|
|
@ -18,6 +18,8 @@ paths:
|
|||
summary: get the service version
|
||||
description: "get the service version"
|
||||
operationId: getVersion
|
||||
tags:
|
||||
- meta
|
||||
responses:
|
||||
'200':
|
||||
description: a service version
|
||||
|
|
@ -29,6 +31,8 @@ paths:
|
|||
get:
|
||||
summary: return the readiness
|
||||
operationId: getReadiness
|
||||
tags:
|
||||
- meta
|
||||
responses:
|
||||
'200':
|
||||
description: readiness
|
||||
|
|
@ -53,6 +57,8 @@ paths:
|
|||
get:
|
||||
summary: get the distributions available to this user
|
||||
operationId: getDistributions
|
||||
tags:
|
||||
- distribution
|
||||
responses:
|
||||
'200':
|
||||
description: |
|
||||
|
|
@ -74,6 +80,9 @@ paths:
|
|||
description: distribution for which to look up available architectures
|
||||
example: 'rhel-84'
|
||||
operationId: getArchitectures
|
||||
tags:
|
||||
- distribution
|
||||
- architecture
|
||||
responses:
|
||||
'200':
|
||||
description: a list of available architectures and their associated image types
|
||||
|
|
@ -90,6 +99,9 @@ paths:
|
|||
/composes:
|
||||
get:
|
||||
summary: get a collection of previous compose requests for the logged in user
|
||||
operationId: getComposes
|
||||
tags:
|
||||
- compose
|
||||
parameters:
|
||||
- in: query
|
||||
name: limit
|
||||
|
|
@ -137,6 +149,8 @@ paths:
|
|||
summary: get status of an image compose
|
||||
description: "status of an image compose"
|
||||
operationId: getComposeStatus
|
||||
tags:
|
||||
- compose
|
||||
responses:
|
||||
'200':
|
||||
description: compose status
|
||||
|
|
@ -166,6 +180,8 @@ paths:
|
|||
description: Id of compose metadata to get
|
||||
description: "metadata for an image compose"
|
||||
operationId: getComposeMetadata
|
||||
tags:
|
||||
- compose
|
||||
responses:
|
||||
'200':
|
||||
description: compose metadata
|
||||
|
|
@ -188,6 +204,8 @@ paths:
|
|||
required: true
|
||||
description: Id of compose to clone
|
||||
operationId: cloneCompose
|
||||
tags:
|
||||
- compose
|
||||
requestBody:
|
||||
required: true
|
||||
description: details of the new clone
|
||||
|
|
@ -232,6 +250,8 @@ paths:
|
|||
description: |
|
||||
Returns a list of all the clones which were started for a compose
|
||||
operationId: getComposeClones
|
||||
tags:
|
||||
- compose
|
||||
responses:
|
||||
'200':
|
||||
description: compose clones
|
||||
|
|
@ -253,6 +273,8 @@ paths:
|
|||
description: Id of clone status to get
|
||||
description: status of a clone
|
||||
operationId: getCloneStatus
|
||||
tags:
|
||||
- compose
|
||||
responses:
|
||||
'200':
|
||||
description: clone status
|
||||
|
|
@ -265,6 +287,8 @@ paths:
|
|||
summary: compose image
|
||||
description: "compose image"
|
||||
operationId: composeImage
|
||||
tags:
|
||||
- compose
|
||||
requestBody:
|
||||
required: true
|
||||
description: details of image to be composed
|
||||
|
|
@ -328,6 +352,9 @@ paths:
|
|||
default: 0
|
||||
minimum: 0
|
||||
description: packages page offset, default 0
|
||||
operationId: getPackages
|
||||
tags:
|
||||
- package
|
||||
responses:
|
||||
'200':
|
||||
description: a list of packages
|
||||
|
|
@ -351,6 +378,8 @@ paths:
|
|||
get:
|
||||
summary: get the available profiles for a given distribution. This is a temporary endpoint meant to be removed soon.
|
||||
operationId: getOscapProfiles
|
||||
tags:
|
||||
- oscap
|
||||
responses:
|
||||
'200':
|
||||
description: |
|
||||
|
|
@ -375,6 +404,8 @@ paths:
|
|||
get:
|
||||
summary: get the customizations for a given distribution and profile. This is a temporary endpoint meant to be removed soon.
|
||||
operationId: getOscapCustomizations
|
||||
tags:
|
||||
- oscap
|
||||
responses:
|
||||
'200':
|
||||
description: |
|
||||
|
|
@ -383,105 +414,13 @@ paths:
|
|||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Customizations'
|
||||
/experimental/blueprint:
|
||||
post:
|
||||
summary: create blueprint
|
||||
description: "create blueprint"
|
||||
operationId: createBlueprint
|
||||
requestBody:
|
||||
required: true
|
||||
description: details of blueprint
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/CreateBlueprintRequest"
|
||||
responses:
|
||||
'201':
|
||||
description: blueprint was saved
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/CreateBlueprintResponse'
|
||||
'400':
|
||||
description: blueprint is malformed
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/HTTPErrorList'
|
||||
'403':
|
||||
description: user is not allowed to create blueprints
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/HTTPErrorList'
|
||||
/experimental/blueprint/{id}:
|
||||
put:
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: '123e4567-e89b-12d3-a456-426655440000'
|
||||
required: true
|
||||
description: UUID of a blueprint
|
||||
summary: update blueprint
|
||||
description: "update blueprint"
|
||||
operationId: updateBlueprint
|
||||
requestBody:
|
||||
required: true
|
||||
description: details of blueprint
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/CreateBlueprintRequest"
|
||||
responses:
|
||||
'200':
|
||||
description: blueprint was update
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/CreateBlueprintResponse'
|
||||
'404':
|
||||
description: blueprint was not found
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/HTTPErrorList'
|
||||
/experimental/blueprint/{id}/compose:
|
||||
post:
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: '123e4567-e89b-12d3-a456-426655440000'
|
||||
required: true
|
||||
description: UUID of a blueprint
|
||||
summary: create new compose from blueprint
|
||||
description: "create new compose from blueprint"
|
||||
operationId: composeBlueprint
|
||||
responses:
|
||||
'201':
|
||||
description: compose was created
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/ComposeResponse'
|
||||
'403':
|
||||
description: user is not allowed to compose from blueprints
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/HTTPErrorList'
|
||||
/experimental/blueprints:
|
||||
get:
|
||||
summary: get a collection of blueprints
|
||||
description: "get a collection of blueprints, returns just the latest version of each blueprint"
|
||||
operationId: getBlueprints
|
||||
tags:
|
||||
- blueprint
|
||||
parameters:
|
||||
- in: query
|
||||
name: search
|
||||
|
|
@ -511,11 +450,131 @@ paths:
|
|||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/BlueprintsResponse'
|
||||
/experimental/blueprint/{id}/composes:
|
||||
post:
|
||||
summary: create blueprint
|
||||
description: "create blueprint"
|
||||
operationId: createBlueprint
|
||||
tags:
|
||||
- blueprint
|
||||
requestBody:
|
||||
required: true
|
||||
description: details of blueprint
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/CreateBlueprintRequest"
|
||||
responses:
|
||||
'201':
|
||||
description: blueprint was saved
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/CreateBlueprintResponse'
|
||||
'400':
|
||||
description: blueprint is malformed
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/HTTPErrorList'
|
||||
'403':
|
||||
description: user is not allowed to create blueprints
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/HTTPErrorList'
|
||||
/experimental/blueprints/{id}:
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: '123e4567-e89b-12d3-a456-426655440000'
|
||||
required: true
|
||||
description: UUID of a blueprint
|
||||
put:
|
||||
summary: update blueprint
|
||||
description: "update blueprint"
|
||||
operationId: updateBlueprint
|
||||
tags:
|
||||
- blueprint
|
||||
requestBody:
|
||||
required: true
|
||||
description: details of blueprint
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/CreateBlueprintRequest"
|
||||
responses:
|
||||
'200':
|
||||
description: blueprint was updated
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/CreateBlueprintResponse'
|
||||
'404':
|
||||
description: blueprint was not found
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/HTTPErrorList'
|
||||
get:
|
||||
summary: get detail of a blueprint
|
||||
description: "get a blueprint detail"
|
||||
operationId: getBlueprint
|
||||
tags:
|
||||
- blueprint
|
||||
responses:
|
||||
'200':
|
||||
description: detail of a blueprint
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/BlueprintResponse'
|
||||
'404':
|
||||
description: blueprint was not found
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/HTTPErrorList'
|
||||
/experimental/blueprints/{id}/compose:
|
||||
post:
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: '123e4567-e89b-12d3-a456-426655440000'
|
||||
required: true
|
||||
description: UUID of a blueprint
|
||||
summary: create new compose from blueprint
|
||||
description: "create new compose from blueprint"
|
||||
operationId: composeBlueprint
|
||||
tags:
|
||||
- blueprint
|
||||
responses:
|
||||
'201':
|
||||
description: compose was created
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/ComposeResponse'
|
||||
'403':
|
||||
description: user is not allowed to compose from blueprints
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/HTTPErrorList'
|
||||
/experimental/blueprints/{id}/composes:
|
||||
get:
|
||||
summary: get composes associated with a blueprint
|
||||
description: "get a collection of composes associated to a blueprint, allows for filtering by version"
|
||||
operationId: getBlueprintComposes
|
||||
tags:
|
||||
- blueprint
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
|
|
@ -861,7 +920,35 @@ components:
|
|||
description:
|
||||
type: string
|
||||
last_modified_at:
|
||||
type: string
|
||||
type: string
|
||||
BlueprintResponse:
|
||||
required:
|
||||
- id
|
||||
- name
|
||||
- description
|
||||
- distribution
|
||||
- image_requests
|
||||
- customizations
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
format: uuid
|
||||
name:
|
||||
type: string
|
||||
description:
|
||||
type: string
|
||||
distribution:
|
||||
$ref: '#/components/schemas/Distributions'
|
||||
image_requests:
|
||||
type: array
|
||||
minItems: 1
|
||||
items:
|
||||
$ref: '#/components/schemas/ImageRequest'
|
||||
uniqueItems: true
|
||||
description: |
|
||||
Array of image requests. Having more image requests in a single blueprint is currently not supported.
|
||||
customizations:
|
||||
$ref: '#/components/schemas/Customizations'
|
||||
Distributions:
|
||||
type: string
|
||||
description: |
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue