Skip to content
This repository was archived by the owner on Aug 15, 2025. It is now read-only.

Commit 3e25998

Browse files
github-actions[bot]github-actions[bot]
committed
chore(bot): update openapi3 schema
1 parent a48a1b6 commit 3e25998

File tree

2 files changed

+98
-0
lines changed

2 files changed

+98
-0
lines changed

‎build/3.0.0/polyproto.core-v1.0-beta.1.yaml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -794,6 +794,14 @@ paths:
794794
schema:
795795
$ref: '#/components/schemas/Models.ResourceListSorting'
796796
explode: false
797+
- name: previews
798+
in: query
799+
required: false
800+
description: Whether to request content previews for supported file formats
801+
schema:
802+
type: boolean
803+
default: false
804+
explode: false
797805
responses:
798806
'200':
799807
description: The request has succeeded.
@@ -811,6 +819,47 @@ paths:
811819
format: uint64
812820
access:
813821
$ref: '#/components/schemas/Models.ResourceAccessProperties'
822+
preview:
823+
type: object
824+
required:
825+
- contents
826+
properties:
827+
contentType:
828+
type: string
829+
description: |-
830+
The allowed media (MIME) types of the file contents.
831+
832+
In file bodies, this value comes from the `Content-Type` header of the request or response. In JSON bodies,
833+
this value is serialized as a field in the response.
834+
835+
NOTE: this is not _necessarily_ the same as the `Content-Type` header of the request or response, but
836+
it will be for file bodies. It may be different if the file is serialized as a JSON object. It always refers to the
837+
_contents_ of the file, and not necessarily the way the file itself is transmitted or serialized.
838+
title: The allowed media (MIME) types of the file contents.
839+
filename:
840+
type: string
841+
description: |-
842+
The name of the file, if any.
843+
844+
In file bodies, this value comes from the `filename` parameter of the `Content-Disposition` header of the response
845+
or multipart payload. In JSON bodies, this value is serialized as a field in the response.
846+
847+
NOTE: By default, `filename` cannot be sent in request payloads and can only be sent in responses and multipart
848+
payloads, as the `Content-Disposition` header is not valid in requests. If you want to send the `filename` in a request,
849+
you must extend the `File` model and override the `filename` property with a different location defined by HTTP metadata
850+
decorators.
851+
title: The name of the file, if any.
852+
contents:
853+
type: string
854+
format: byte
855+
description: |-
856+
The contents of the file.
857+
858+
In file bodies, this value comes from the body of the request, response, or multipart payload. In JSON bodies,
859+
this value is serialized as a field in the response.
860+
title: The contents of the file.
861+
description: Only present, if `previews` was set to `true` in the request, and if the response contains preview-supported file types.
862+
title: A file in an HTTP request, response, or multipart payload.
814863
required:
815864
- resourceId
816865
- size

‎build/3.1.0/polyproto.core-v1.0-beta.1.yaml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -795,6 +795,14 @@ paths:
795795
schema:
796796
$ref: '#/components/schemas/Models.ResourceListSorting'
797797
explode: false
798+
- name: previews
799+
in: query
800+
required: false
801+
description: Whether to request content previews for supported file formats
802+
schema:
803+
type: boolean
804+
default: false
805+
explode: false
798806
responses:
799807
'200':
800808
description: The request has succeeded.
@@ -812,6 +820,47 @@ paths:
812820
format: uint64
813821
access:
814822
$ref: '#/components/schemas/Models.ResourceAccessProperties'
823+
preview:
824+
type: object
825+
required:
826+
- contents
827+
properties:
828+
contentType:
829+
type: string
830+
description: |-
831+
The allowed media (MIME) types of the file contents.
832+
833+
In file bodies, this value comes from the `Content-Type` header of the request or response. In JSON bodies,
834+
this value is serialized as a field in the response.
835+
836+
NOTE: this is not _necessarily_ the same as the `Content-Type` header of the request or response, but
837+
it will be for file bodies. It may be different if the file is serialized as a JSON object. It always refers to the
838+
_contents_ of the file, and not necessarily the way the file itself is transmitted or serialized.
839+
title: The allowed media (MIME) types of the file contents.
840+
filename:
841+
type: string
842+
description: |-
843+
The name of the file, if any.
844+
845+
In file bodies, this value comes from the `filename` parameter of the `Content-Disposition` header of the response
846+
or multipart payload. In JSON bodies, this value is serialized as a field in the response.
847+
848+
NOTE: By default, `filename` cannot be sent in request payloads and can only be sent in responses and multipart
849+
payloads, as the `Content-Disposition` header is not valid in requests. If you want to send the `filename` in a request,
850+
you must extend the `File` model and override the `filename` property with a different location defined by HTTP metadata
851+
decorators.
852+
title: The name of the file, if any.
853+
contents:
854+
type: string
855+
contentEncoding: base64
856+
description: |-
857+
The contents of the file.
858+
859+
In file bodies, this value comes from the body of the request, response, or multipart payload. In JSON bodies,
860+
this value is serialized as a field in the response.
861+
title: The contents of the file.
862+
description: Only present, if `previews` was set to `true` in the request, and if the response contains preview-supported file types.
863+
title: A file in an HTTP request, response, or multipart payload.
815864
required:
816865
- resourceId
817866
- size

0 commit comments

Comments
 (0)