Skip to content

Commit c0dd962

Browse files
authored
fix: Fix OpenAPI schema errors (#2270)
- Fix OpenAPI schema errors reported by `express-openapi-validator` - Change `style` of several `query` from `simple` to `form` to be compliant with the spec Closes: #2269 <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Documentation/schema-only change that adjusts OpenAPI parameter metadata; runtime API behavior should be unaffected aside from client generation/validation. > > **Overview** > Fixes OpenAPI spec validation issues by changing the `signature` query parameter serialization from `style: simple` to `style: form` on several storage endpoints (`datasets/{datasetId}/items`, `key-value-stores/{storeId}/keys`, and `key-value-stores/{storeId}/records/{recordKey}`). This aligns the schema with OpenAPI rules and should stop `express-openapi-validator` from reporting errors for these routes. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 5bdc897. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY -->
1 parent 59dce5e commit c0dd962

3 files changed

Lines changed: 3 additions & 3 deletions

File tree

apify-api/openapi/paths/datasets/datasets@{datasetId}@items.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -371,7 +371,7 @@ get:
371371
in: query
372372
description: Signature used to access the items.
373373
required: false
374-
style: simple
374+
style: form
375375
schema:
376376
type: string
377377
example: 2wTI46Bg8qWQrV7tavlPI

apify-api/openapi/paths/key-value-stores/key-value-stores@{storeId}@keys.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ get:
5151
in: query
5252
description: Signature used to access the keys.
5353
required: false
54-
style: simple
54+
style: form
5555
schema:
5656
type: string
5757
example: 2wTI46Bg8qWQrV7tavlPI

apify-api/openapi/paths/key-value-stores/key-value-stores@{storeId}@records@{recordKey}.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ get:
4040
in: query
4141
description: Signature used to access the record.
4242
required: false
43-
style: simple
43+
style: form
4444
schema:
4545
type: string
4646
example: 2wTI46Bg8qWQrV7tavlPI

0 commit comments

Comments
 (0)