From df4deca2d17948d95973afac0ec9c59a0ae5a9ad Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 20 Jul 2023 12:00:56 +0300 Subject: [PATCH] chore(docs): Generated API Reference (#4558) Co-authored-by: olivermrbl Co-authored-by: Shahed Nasser --- docs/api/admin.oas.json | 12 ++++++++++++ .../schemas/AdminNotificationsListRes.yaml | 9 +++++++++ docs/api/store.oas.json | 16 ++++++++++++++++ .../StorePostCartsCartLineItemsItemReq.yaml | 5 +++++ .../components/schemas/StoreRegionsListRes.yaml | 9 +++++++++ 5 files changed, 51 insertions(+) diff --git a/docs/api/admin.oas.json b/docs/api/admin.oas.json index 4c8f5e3fa2..d025a0139f 100644 --- a/docs/api/admin.oas.json +++ b/docs/api/admin.oas.json @@ -25755,6 +25755,18 @@ "items": { "$ref": "#/components/schemas/Notification" } + }, + "count": { + "type": "integer", + "description": "The total number of notifications" + }, + "offset": { + "type": "integer", + "description": "The number of notifications skipped before these notifications" + }, + "limit": { + "type": "integer", + "description": "The number of notifications per page" } } }, diff --git a/docs/api/admin/components/schemas/AdminNotificationsListRes.yaml b/docs/api/admin/components/schemas/AdminNotificationsListRes.yaml index f114beaaf2..ef38b0fcaa 100644 --- a/docs/api/admin/components/schemas/AdminNotificationsListRes.yaml +++ b/docs/api/admin/components/schemas/AdminNotificationsListRes.yaml @@ -10,3 +10,12 @@ properties: type: array items: $ref: ./Notification.yaml + count: + type: integer + description: The total number of notifications + offset: + type: integer + description: The number of notifications skipped before these notifications + limit: + type: integer + description: The number of notifications per page diff --git a/docs/api/store.oas.json b/docs/api/store.oas.json index 4f9274338d..3ca6fed2cc 100644 --- a/docs/api/store.oas.json +++ b/docs/api/store.oas.json @@ -14169,6 +14169,10 @@ "quantity": { "type": "number", "description": "The quantity to set the Line Item to." + }, + "metadata": { + "type": "object", + "description": "An optional key-value map with additional details about the Line Item. If omitted, the metadata will remain unchanged.\"" } } }, @@ -14861,6 +14865,18 @@ "items": { "$ref": "#/components/schemas/Region" } + }, + "count": { + "type": "integer", + "description": "The total number of items available" + }, + "offset": { + "type": "integer", + "description": "The number of items skipped before these items" + }, + "limit": { + "type": "integer", + "description": "The number of items per page" } } }, diff --git a/docs/api/store/components/schemas/StorePostCartsCartLineItemsItemReq.yaml b/docs/api/store/components/schemas/StorePostCartsCartLineItemsItemReq.yaml index b2a49083e7..7bbbc6dcb6 100644 --- a/docs/api/store/components/schemas/StorePostCartsCartLineItemsItemReq.yaml +++ b/docs/api/store/components/schemas/StorePostCartsCartLineItemsItemReq.yaml @@ -5,3 +5,8 @@ properties: quantity: type: number description: The quantity to set the Line Item to. + metadata: + type: object + description: >- + An optional key-value map with additional details about the Line Item. If + omitted, the metadata will remain unchanged." diff --git a/docs/api/store/components/schemas/StoreRegionsListRes.yaml b/docs/api/store/components/schemas/StoreRegionsListRes.yaml index 429be83f52..a5a11f7153 100644 --- a/docs/api/store/components/schemas/StoreRegionsListRes.yaml +++ b/docs/api/store/components/schemas/StoreRegionsListRes.yaml @@ -15,3 +15,12 @@ properties: type: array items: $ref: ./Region.yaml + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before these items + limit: + type: integer + description: The number of items per page