API: Update image-builder API

This commit updates the image-builder API due to these two recent
changes:

A new type added for the ClientId, used when differentiating between API
and UI users.
fce3d1c355

OpenSCAP profile names and descriptions.
1d292917d1
This commit is contained in:
lucasgarfield 2023-12-01 18:34:16 +01:00 committed by Lucas Garfield
parent 31d286aac3
commit c7dd831645
2 changed files with 18 additions and 5 deletions

View file

@ -602,8 +602,7 @@ components:
example: "MyImageDescription" example: "MyImageDescription"
maxLength: 250 maxLength: 250
client_id: client_id:
type: string $ref: '#/components/schemas/ClientId'
example: "ui"
image_requests: image_requests:
type: array type: array
minItems: 1 minItems: 1
@ -771,7 +770,11 @@ components:
image_name: image_name:
type: string type: string
client_id: client_id:
type: string $ref: '#/components/schemas/ClientId'
ClientId:
type: string
enum: ["api", "ui"]
default: "api"
ComposeResponse: ComposeResponse:
required: required:
- id - id
@ -1172,6 +1175,13 @@ components:
profile_id: profile_id:
type: string type: string
example: "xccdf_org.ssgproject.content_profile_cis" example: "xccdf_org.ssgproject.content_profile_cis"
description: "The policy reference ID"
profile_name:
type: string
description: "The policy type"
profile_description:
type: string
description: "The longform policy description"
ClonesResponse: ClonesResponse:
required: required:
- meta - meta

View file

@ -209,6 +209,7 @@ export type Distributions =
| "fedora-38" | "fedora-38"
| "fedora-39" | "fedora-39"
| "fedora-40"; | "fedora-40";
export type ClientId = "api" | "ui";
export type ImageTypes = export type ImageTypes =
| "aws" | "aws"
| "azure" | "azure"
@ -294,6 +295,8 @@ export type CustomRepository = {
}; };
export type OpenScap = { export type OpenScap = {
profile_id: string; profile_id: string;
profile_name?: string;
profile_description?: string;
}; };
export type Filesystem = { export type Filesystem = {
mountpoint: string; mountpoint: string;
@ -317,7 +320,7 @@ export type ComposeRequest = {
distribution: Distributions; distribution: Distributions;
image_name?: string; image_name?: string;
image_description?: string; image_description?: string;
client_id?: string; client_id?: ClientId;
image_requests: ImageRequest[]; image_requests: ImageRequest[];
customizations?: Customizations; customizations?: Customizations;
}; };
@ -326,7 +329,7 @@ export type ComposesResponseItem = {
request: ComposeRequest; request: ComposeRequest;
created_at: string; created_at: string;
image_name?: string; image_name?: string;
client_id?: string; client_id?: ClientId;
}; };
export type ComposesResponse = { export type ComposesResponse = {
meta: { meta: {