/**
* @swagger {components.schemas} RequestFileUpload {
"description": "Body of a file upload request.
A directory of file-parameter-IDs and upload-definitions.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/RequestFileUploadPart"
},
"example": {
"e6a576af-2e16-43cc-a78f-d74ae1154205": {
"format": "image/jpeg",
"size": "1234"
}
}
}
*/
/** Body of a file upload request.
A directory of file-parameter-IDs and upload-definitions. */
export type ShapeDiverRequestFileUpload = { [paramId: string]: ShapeDiverRequestFileUploadPart };
/**
* @swagger {components.schemas} RequestFileUploadPart {
"description": "Data for a single file parameter part of a file upload request.",
"type": "object"
}
*/
/** Data for a single file parameter part of a file upload request. */
export interface ShapeDiverRequestFileUploadPart {
/**
* @swagger {components.schemas.RequestFileUploadPart.properties} filename {
"description": "Name of the file to be uploaded.
When this property is set, then the actual file upload request must contain a Content-Disposition HTTP header with the value \"attachment; filename={filename}\". Otherwise, a signature mismatch will occur.",
"type": "string"
}
*/
/**
* Name of the file to be uploaded.
*
* When this property is set, then the actual file upload request must contain a
* Content-Disposition HTTP header with the value \"attachment; filename={filename}.\".
* Otherwise, a signature mismatch will occur.
*/
filename?: string;
/**
* @swagger {components.schemas.RequestFileUploadPart.properties} format {
"description": "Content-Type (MIME type) of the file to be uploaded.",
"type": "string"
}
* @swagger {components.schemas.RequestFileUploadPart} required [ "format" ]
*/
/** Content-Type (MIME type) of the file to be uploaded. */
format: string;
/**
* @swagger {components.schemas.RequestFileUploadPart.properties} size {
"description": "Size of the file to be uploaded, in bytes.",
"type": "number"
}
* @swagger {components.schemas.RequestFileUploadPart} required [ "size" ]
*/
/** Size of the file to be uploaded, in bytes. */
size: number;
}
/**
* @swagger {components.schemas} RequestSdtfUpload {
"description": "Body of a sdTF upload request.",
"type": "array",
"items": {
"$ref": "#/components/schemas/RequestSdtfUploadPart"
}
}
*/
/** Body of a sdTF upload request. */
export type ShapeDiverRequestSdtfUpload = ShapeDiverRequestSdtfUploadPart[];
/**
* @swagger {components.schemas} RequestSdtfUploadPart {
"description": "Data for a single file parameter part of a sdTF upload request.",
"type": "object"
}
*/
/** Data for a single file parameter part of a sdTF upload request. */
export interface ShapeDiverRequestSdtfUploadPart {
/**
* @swagger {components.schemas.RequestSdtfUploadPart.properties} content_encoding {
"description": "Encoding of the sdTF to be uploaded.",
"type": "string"
}
*/
/** Encoding of the sdTF to be uploaded. */
content_encoding?: string;
/**
* @swagger {components.schemas.RequestSdtfUploadPart.properties} content_length {
"description": "Size of the sdTF to be uploaded, in bytes.",
"type": "number"
}
* @swagger {components.schemas.RequestSdtfUploadPart} required [ "content_length" ]
*/
/** Size of the sdTF to be uploaded, in bytes. */
content_length: number;
/**
* @swagger {components.schemas.RequestSdtfUploadPart.properties} content_type {
"description": "Content-type of the sdTF to be uploaded.",
"$ref": "#/components/schemas/RequestSdtfUploadPartType"
}
* @swagger {components.schemas.RequestSdtfUploadPart} required [ "content_type" ]
*/
/** Content-type of the sdTF to be uploaded. */
content_type: ShapeDiverRequestSdtfUploadPartType;
/**
* @swagger {components.schemas.RequestSdtfUploadPart.properties} namespace {
"description": "Namespace the asset shall be created in.",
"type": "string"
}
* @swagger {components.schemas.RequestSdtfUploadPart} required [ "namespace" ]
*/
/** Namespace the asset shall be created in. */
namespace: string;
}
/**
* @swagger {components.schemas} RequestSdtfUploadPartType {
"description": "Content-Type (MIME type) of the sdTF to be uploaded.",
"type": "string",
"enum": [ "model/vnd.sdtf" ]
}
*/
/** Content-Type (MIME type) of the sdTF to be uploaded. */
export enum ShapeDiverRequestSdtfUploadPartType {
MODEL_SDTF = 'model/vnd.sdtf',
}