@salesforce/b2c-tooling-sdk 2.3.0 → 2.5.0

package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/timeouts/v1.json

@@ -2,7 +2,8 @@
   "openapi": "3.0.1",
   "info": {
     "title": "Timeouts",
-    "version": "1.0.6",
+    "description": "[Download API specification](https://developer.salesforce.com/static/commercecloud/commerce-api/timeouts/timeouts-oas-v1-public.yaml)\n\n# API Overview\n\nUse the Timeouts API to manage SCAPI timeouts.\n\nYou can specify individual timeout values for specific APIs. Note that you can't set timeouts at the API family level.\n\n## Authentication & Authorization\n\nFor resource access, you must use a client ID and client secret from Account Manager to request an access token. The access token is used as a bearer token and added to the Authorization header of your API request. \n\nYou must include `sfcc.timeouts.rw` (read-write access) or `sfcc.timeouts` (read-only access) in the client ID used to generate the token. For a full list of permissions, see the [Authorization Scopes Catalog.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/auth-z-scope-catalog.html)\n\nFor detailed setup instructions, see the [Authorization for Admin APIs](https://developer.salesforce.com/docs/commerce/commerce-api/guide/authorization-for-admin-apis.html) guide.\n\n## Response Details\n\n### Timeouts\n\nAdmin API requests must respond within 60 seconds. If a response exceeds this threshold, an HTTP 504 status code is returned. For details, see [Timeouts and Limits.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/timeouts-limits.html)\n\n### Error Handling\n\nError responses follow the [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807) problem detail format. To trace errors, include a `correlation-id` header in your request — the response returns it as `x-correlation-id`. For details, see [HTTP Status Codes and Errors.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/error-response-codes.html)\n\n## Use Cases\n\n### Manage Timeouts\n\nUse the timeouts endpoint to retrieve, set, or delete your configuration for timeouts.\n\n## Usage Notes\n\n1. Timeout configuration is set per instance type (development, staging, and production), not per site. Updating the configuration for one instance type does not affect the others.\n2. Configure timeouts for an individual API, not an API family.\n3. Wildcards are not allowed.\n4. Max timeout value is 120 seconds.",
+    "version": "1.0.7",
     "x-api-type": "Admin",
     "x-api-family": "Configuration"
   },
@@ -11,6 +12,7 @@
       "url": "https://{shortCode}.api.commercecloud.salesforce.com/configuration/timeouts/v1",
       "variables": {
         "shortCode": {
+          "description": "An eight-character string assigned to a realm for routing purposes. See [Base URL and Request Formation.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html)",
           "default": "shortCode"
         }
       }
@@ -19,17 +21,21 @@
   "paths": {
     "/organizations/{organizationId}/timeouts": {
       "get": {
+        "summary": "Return a set of SCAPI timeout overrides.",
+        "description": "Return a set of SCAPI timeout overrides.",
         "operationId": "getTimeouts",
         "parameters": [
           {
             "name": "organizationId",
             "in": "path",
+            "description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
             "required": true,
             "style": "simple",
             "explode": false,
             "schema": {
               "$ref": "#/components/schemas/OrganizationId"
-            }
+            },
+            "example": "f_ecom_zzxy_prd"
           }
         ],
         "responses": {
@@ -39,6 +45,11 @@
               "application/json": {
                 "schema": {
                   "$ref": "#/components/schemas/TimeoutConfigurations"
+                },
+                "examples": {
+                  "TimeoutExample": {
+                    "$ref": "#/components/examples/TimeoutsExample"
+                  }
                 }
               }
             }
@@ -54,17 +65,21 @@
         ]
       },
       "put": {
+        "summary": "Create or replace the full set of SCAPI timeout overrides.",
+        "description": "Create or replace the full set of SCAPI timeout overrides.",
         "operationId": "putTimeouts",
         "parameters": [
           {
             "name": "organizationId",
             "in": "path",
+            "description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
             "required": true,
             "style": "simple",
             "explode": false,
             "schema": {
               "$ref": "#/components/schemas/OrganizationId"
-            }
+            },
+            "example": "f_ecom_zzxy_prd"
           }
         ],
         "requestBody": {
@@ -72,6 +87,11 @@
             "application/json": {
               "schema": {
                 "$ref": "#/components/schemas/TimeoutConfigurations"
+              },
+              "examples": {
+                "TimeoutExample": {
+                  "$ref": "#/components/examples/TimeoutsExample"
+                }
               }
             }
           },
@@ -84,6 +104,11 @@
               "application/json": {
                 "schema": {
                   "$ref": "#/components/schemas/TimeoutConfigurations"
+                },
+                "examples": {
+                  "TimeoutExample": {
+                    "$ref": "#/components/examples/TimeoutsExample"
+                  }
                 }
               }
             }
@@ -94,6 +119,11 @@
               "application/json": {
                 "schema": {
                   "$ref": "#/components/schemas/TimeoutConfigurations"
+                },
+                "examples": {
+                  "TimeoutExample": {
+                    "$ref": "#/components/examples/TimeoutsExample"
+                  }
                 }
               }
             }
@@ -104,6 +134,11 @@
               "application/json": {
                 "schema": {
                   "$ref": "#/components/schemas/ErrorResponse"
+                },
+                "examples": {
+                  "InvalidTimeoutExample": {
+                    "$ref": "#/components/examples/InvalidTimeoutsExample"
+                  }
                 }
               }
             }
@@ -118,17 +153,21 @@
         ]
       },
       "delete": {
+        "summary": "Delete all SCAPI timeout override values.",
+        "description": "Delete all SCAPI timeout override values.",
         "operationId": "deleteTimeouts",
         "parameters": [
           {
             "name": "organizationId",
             "in": "path",
+            "description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
             "required": true,
             "style": "simple",
             "explode": false,
             "schema": {
               "$ref": "#/components/schemas/OrganizationId"
-            }
+            },
+            "example": "f_ecom_zzxy_prd"
           }
         ],
         "responses": {
@@ -151,14 +190,18 @@
     "schemas": {
       "OrganizationId": {
         "type": "string",
+        "description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
+        "example": "f_ecom_zzxy_prd",
         "pattern": "^f_ecom_[a-z]{4}_(prd|stg|dev|s[0-9]{2}|[0-9]{3})$"
       },
       "TimeoutMappings": {
         "type": "object",
         "additionalProperties": {
           "type": "integer",
-          "format": "int32"
+          "format": "int32",
+          "description": "Map of APIs and their respective timeout values in seconds. Max timeout value is 120."
         },
+        "description": "Configuration object for timeout feature",
         "properties": {}
       },
       "TimeoutConfigurations": {
@@ -175,17 +218,25 @@
         "properties": {
           "title": {
             "type": "string",
+            "description": "A short, human-readable summary of the problem\ntype.  It will not change from occurrence to occurrence of the \nproblem, except for purposes of localization\n",
+            "example": "You do not have enough credit",
             "maxLength": 256
           },
           "type": {
             "type": "string",
+            "description": "A URI reference [RFC3986] that identifies the\nproblem type.  This specification encourages that, when\ndereferenced, it provide human-readable documentation for the\nproblem type (e.g., using HTML [W3C.REC-html5-20141028]).  When\nthis member is not present, its value is assumed to be\n\"about:blank\". It accepts relative URIs; this means\nthat they must be resolved relative to the document's base URI, as\nper [RFC3986], Section 5.\n",
+            "example": "NotEnoughMoney",
             "maxLength": 2048
           },
           "detail": {
-            "type": "string"
+            "type": "string",
+            "description": "A human-readable explanation specific to this occurrence of the problem.",
+            "example": "Your current balance is 30, but that costs 50"
           },
           "instance": {
             "type": "string",
+            "description": "A URI reference that identifies the specific\noccurrence of the problem.  It may or may not yield further\ninformation if dereferenced.  It accepts relative URIs; this means\nthat they must be resolved relative to the document's base URI, as\nper [RFC3986], Section 5.\n",
+            "example": "/account/12345/msgs/abc",
             "maxLength": 2048
           }
         },
@@ -200,17 +251,37 @@
       "organizationId": {
         "name": "organizationId",
         "in": "path",
+        "description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
         "required": true,
         "style": "simple",
         "explode": false,
         "schema": {
           "$ref": "#/components/schemas/OrganizationId"
+        },
+        "example": "f_ecom_zzxy_prd"
+      }
+    },
+    "examples": {
+      "TimeoutsExample": {
+        "value": {
+          "timeouts": {
+            "product/shopper-products": 77,
+            "checkout/orders": 88
+          }
+        }
+      },
+      "InvalidTimeoutsExample": {
+        "value": {
+          "title": "Bad Request",
+          "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/bad-request",
+          "detail": "Submitted content was invalid: API paths can only consist of an API family, followed by a slash, followed by a single API."
         }
       }
     },
     "securitySchemes": {
       "AmOAuth2": {
         "type": "oauth2",
+        "description": "Account Manager OAuth 2.0 bearer token authentication",
         "flows": {
           "clientCredentials": {
             "tokenUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
@@ -222,10 +293,8 @@
           "authorizationCode": {
             "authorizationUrl": "https://account.demandware.com/dwsso/oauth2/authorize",
             "tokenUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
-            "scopes": {
-              "sfcc.timeouts": "Timeouts READONLY scope",
-              "sfcc.timeouts.rw": "Timeouts scope"
-            }
+            "refreshUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
+            "scopes": {}
           }
         }
       }