adutra commented on code in PR #18254:
URL: https://github.com/apache/iceberg/pull/18254#discussion_r4512847134
##########
open-api/rest-catalog-open-api.yaml:
##########
@@ -5854,6 +5518,95 @@ components:
headers:
$ref: '#/components/schemas/MultiValuedMap'
+ RemoteSignBatchRequest:
+ description: >
+ A batch of requests to be signed remotely. `region`, `method`,
`provider` and
+ `properties` apply to every element of `requests`.
+ type: object
+ required:
+ - region
+ - method
+ - provider
+ - requests
+ properties:
+ region:
+ type: string
+ method:
+ type: string
+ enum: ["PUT", "GET", "HEAD", "POST", "DELETE", "PATCH", "OPTIONS"]
+ provider:
+ type: string
+ description: The storage provider for every element of the batch.
The provider should correspond
+ to the scheme used for a storage native URI. For example `s3` for
AWS S3 paths.
+ properties:
+ type: object
+ additionalProperties:
+ type: string
+ requests:
+ type: array
+ minItems: 1
+ items:
+ $ref: '#/components/schemas/RemoteSignBatchElement'
+
+ RemoteSignBatchElement:
+ description: The fields of one request in a batch that are not repeated
with the other requests.
+ type: object
+ required:
+ - uri
+ properties:
+ uri:
+ type: string
+ headers:
+ $ref: '#/components/schemas/MultiValuedMap'
+ body:
+ type: string
+ description: Optional body of the request to send to the signing
API, as in `RemoteSignRequest`.
+
+ CompletedSignResult:
+ description: A successfully signed batch element
+ allOf:
+ - $ref: '#/components/schemas/RemoteSignResult'
+ - type: object
+ required:
+ - index
+ properties:
+ index:
+ type: integer
+ minimum: 0
+ description: The 0-based position of the element in `requests`
+
+ FailedSignResult:
+ description: A batch element that could not be signed
+ type: object
+ required:
+ - index
+ - error
+ properties:
+ index:
+ type: integer
+ minimum: 0
+ description: The 0-based position of the element in `requests`
+ error:
+ $ref: '#/components/schemas/ErrorModel'
+
+ RemoteSignBatchResponse:
Review Comment:
I think the convention would be to name this object `RemoteSignBatchResult`.
##########
open-api/rest-catalog-open-api.yaml:
##########
@@ -5854,6 +5518,95 @@ components:
headers:
$ref: '#/components/schemas/MultiValuedMap'
+ RemoteSignBatchRequest:
+ description: >
+ A batch of requests to be signed remotely. `region`, `method`,
`provider` and
+ `properties` apply to every element of `requests`.
+ type: object
+ required:
+ - region
+ - method
+ - provider
+ - requests
+ properties:
+ region:
+ type: string
+ method:
+ type: string
+ enum: ["PUT", "GET", "HEAD", "POST", "DELETE", "PATCH", "OPTIONS"]
+ provider:
+ type: string
+ description: The storage provider for every element of the batch.
The provider should correspond
+ to the scheme used for a storage native URI. For example `s3` for
AWS S3 paths.
+ properties:
+ type: object
+ additionalProperties:
+ type: string
+ requests:
+ type: array
+ minItems: 1
+ items:
+ $ref: '#/components/schemas/RemoteSignBatchElement'
+
+ RemoteSignBatchElement:
+ description: The fields of one request in a batch that are not repeated
with the other requests.
+ type: object
+ required:
+ - uri
+ properties:
+ uri:
+ type: string
+ headers:
+ $ref: '#/components/schemas/MultiValuedMap'
+ body:
+ type: string
+ description: Optional body of the request to send to the signing
API, as in `RemoteSignRequest`.
+
+ CompletedSignResult:
+ description: A successfully signed batch element
+ allOf:
+ - $ref: '#/components/schemas/RemoteSignResult'
+ - type: object
+ required:
+ - index
+ properties:
+ index:
+ type: integer
+ minimum: 0
+ description: The 0-based position of the element in `requests`
+
+ FailedSignResult:
Review Comment:
Same, I'd rename to `FailedRemoteSignBatchElement`.
##########
open-api/rest-catalog-open-api.yaml:
##########
@@ -5854,6 +5518,95 @@ components:
headers:
$ref: '#/components/schemas/MultiValuedMap'
+ RemoteSignBatchRequest:
+ description: >
+ A batch of requests to be signed remotely. `region`, `method`,
`provider` and
+ `properties` apply to every element of `requests`.
+ type: object
+ required:
+ - region
+ - method
+ - provider
+ - requests
+ properties:
+ region:
+ type: string
+ method:
+ type: string
+ enum: ["PUT", "GET", "HEAD", "POST", "DELETE", "PATCH", "OPTIONS"]
+ provider:
+ type: string
+ description: The storage provider for every element of the batch.
The provider should correspond
+ to the scheme used for a storage native URI. For example `s3` for
AWS S3 paths.
+ properties:
+ type: object
+ additionalProperties:
+ type: string
+ requests:
+ type: array
+ minItems: 1
+ items:
+ $ref: '#/components/schemas/RemoteSignBatchElement'
+
+ RemoteSignBatchElement:
+ description: The fields of one request in a batch that are not repeated
with the other requests.
+ type: object
+ required:
+ - uri
+ properties:
+ uri:
+ type: string
+ headers:
+ $ref: '#/components/schemas/MultiValuedMap'
+ body:
+ type: string
+ description: Optional body of the request to send to the signing
API, as in `RemoteSignRequest`.
+
+ CompletedSignResult:
Review Comment:
Maybe rename to `CompletedRemoteSignBatchElement` for clarity.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
