V10 - rework of Blob-Handling

This commit is contained in:
Nico Kroll 2025-08-20 10:33:58 +02:00
parent cec3fa68ad
commit 5b9a836c65
1 changed files with 51 additions and 6 deletions

View File

@ -1,7 +1,7 @@
openapi: 3.0.0 openapi: 3.0.0
info: info:
title: "TyrePro-API, Shop" title: "TyrePro-API, Shop"
version: "Version 9" version: "Version 10"
servers: servers:
- url: "https://musterreifen.com/api/shop" - url: "https://musterreifen.com/api/shop"
description: "Development server, customers domain" description: "Development server, customers domain"
@ -105,6 +105,7 @@ paths:
- "Settings" - "Settings"
parameters: parameters:
- $ref: "#/components/parameters/GuidOnlineService" - $ref: "#/components/parameters/GuidOnlineService"
- $ref: "#/components/parameters/BinaryObjectContentType"
responses: responses:
200: 200:
description: "successful operation" description: "successful operation"
@ -125,6 +126,7 @@ paths:
parameters: parameters:
- $ref: "#/components/parameters/GuidPath" - $ref: "#/components/parameters/GuidPath"
- $ref: "#/components/parameters/_HashValue" - $ref: "#/components/parameters/_HashValue"
- $ref: "#/components/parameters/BinaryObjectContentType"
requestBody: requestBody:
required: true required: true
content: content:
@ -319,6 +321,7 @@ paths:
tags: tags:
- "Menu" - "Menu"
parameters: parameters:
- $ref: "#/components/parameters/BinaryObjectContentType"
- name: "GuidModule" - name: "GuidModule"
in: "query" in: "query"
required: true required: true
@ -1098,6 +1101,35 @@ components:
example: example:
Message: "Ihr Anwender wurde nicht gefunden." Message: "Ihr Anwender wurde nicht gefunden."
Details: "Progress.Lang.AppError\n Ihr Anwender wurde nicht gefunden.\nat sourcecode.line 123" Details: "Progress.Lang.AppError\n Ihr Anwender wurde nicht gefunden.\nat sourcecode.line 123"
DbBlob:
type: "object"
required:
- "Designation"
- "MimeType"
- "CharacterSet"
- "LastFileModificationMoment"
- "Content"
- "ContentHashValue"
- "SizeInBytes"
properties:
Designation:
type: "string"
MimeType:
type: "string"
readOnly: true
CharacterSet:
type: "string"
LastFileModificationMoment:
type: "string"
format: "date-time"
Content:
type: "string"
ContentHashValue:
type: "string"
readOnly: true
SizeInBytes:
type: "integer"
readOnly: true
AddressState: AddressState:
type: "object" type: "object"
required: required:
@ -1559,8 +1591,8 @@ components:
OfferLayout: OfferLayout:
type: "object" type: "object"
properties: properties:
GuidDbBlobBackground: BackgroundImage:
type: "string" $ref: "#/components/schemas/DbBlob"
TopOffsetInPixel: TopOffsetInPixel:
type: "integer" type: "integer"
BottomOffsetInPixel: BottomOffsetInPixel:
@ -1747,13 +1779,13 @@ components:
type: "object" type: "object"
required: required:
- "Guid" - "Guid"
- "GuidDbBlob" - "File"
- "Type" - "Type"
properties: properties:
Guid: Guid:
type: "string" type: "string"
GuidDbBlob: File:
type: "string" $ref: "#/components/schemas/DbBlob"
Type: Type:
type: "string" type: "string"
enum: enum:
@ -1927,6 +1959,19 @@ components:
type: "string" type: "string"
default: null default: null
example: "2055516" example: "2055516"
BinaryObjectContentType:
name: "BinaryObjectContentType"
in: "query"
description: "Determines what you will find in the field content."
required: false
schema:
type: "string"
enum:
- "Base64"
- "UrlWithInlineContentDisposition"
- "UrlWithAttachmentContentDisposition"
default: "UrlWithInlineContentDisposition"
example: "UrlWithInlineContentDisposition"
responses: responses:
GenericError: GenericError:
description: "Unexpected error like 4XX or 5XX http errors." description: "Unexpected error like 4XX or 5XX http errors."