/** * This file was auto-generated by openapi-typescript. * Do not make direct changes to the file. */ export interface paths { "/organizations/{organizationId}/schemas": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a list of available SCAPI schemas. * @description List available SCAPI schema definitions with optional filtering by API family, name, version, or status. */ get: operations["getSchemas"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/organizations/{organizationId}/schemas/{apiFamily}/{apiName}/{apiVersion}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a specific SCAPI schema. * @description Retrieve the detailed OpenAPI schema specification for a specific SCAPI API. */ get: operations["getSchema"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; } export type webhooks = Record; export interface components { schemas: { /** * @description An identifier for the organization the request is being made by * @example f_ecom_zzxy_prd */ OrganizationId: string; /** * @example current * @enum {string} */ SchemaStatus: "current" | "deprecated"; /** * Format: int32 * @description Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria). * @default 10 * @example 10 */ Limit: number; /** * Format: int32 * @description The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are paginated. * @default 0 * @example 10 */ Total: number; /** @description Schema defining generic list result. Each response schema of a resource requiring a list response should extend this schema. */ ResultBase: { limit: components["schemas"]["Limit"]; total: components["schemas"]["Total"]; }; SchemaListFilter: { /** @example shopper */ apiFamily?: string; /** @example products */ apiName?: string; /** @example v1 */ apiVersion?: string; status?: components["schemas"]["SchemaStatus"]; }; SchemaListItem: { /** * @description Semantic version of the schema (e.g., "1.0.0") * @example 1.0.0 */ schemaVersion?: string; /** * @description The API family (e.g., shopper, admin) * @example shopper */ apiFamily?: string; /** * @description The API name (e.g., products, orders) * @example products */ apiName?: string; /** * @description The API version (e.g., v1) * @example v1 */ apiVersion?: string; status?: components["schemas"]["SchemaStatus"]; /** * @description URL to the schema detail endpoint * @example /organizations/f_ecom_zzxy_prd/schemas/shopper/products/v1 */ link?: string; }; SchemaListResult: { filter?: components["schemas"]["SchemaListFilter"]; data?: components["schemas"]["SchemaListItem"][]; } & components["schemas"]["ResultBase"]; /** @description An OpenAPI 3.0 schema specification */ OpenApiSchema: { /** * @description OpenAPI version * @example 3.0.3 */ openapi?: string; info?: { title?: string; version?: string; description?: string; } & { [key: string]: unknown; }; paths?: { [key: string]: unknown; }; components?: { [key: string]: unknown; }; } & { [key: string]: unknown; }; ErrorResponse: { /** * @description A short, human-readable summary of the problem type. * @example Bad Request */ title: string; /** * @description A URI reference that identifies the problem type. * @example https://api.commercecloud.salesforce.com/documentation/error/v1/errors/bad-request */ type: string; /** * @description A human-readable explanation specific to this occurrence of the problem. * @example Invalid value for filter parameter. */ detail: string; /** @description A URI reference that identifies the specific occurrence of the problem. */ instance?: string; } & { [key: string]: unknown; }; }; responses: never; parameters: { /** * @description An identifier for the organization the request is being made by * @example f_ecom_zzxy_prd */ organizationId: components["schemas"]["OrganizationId"]; /** @description Filter by API family (e.g., shopper, admin) */ apiFamily: string; /** @description Filter by API name (e.g., products, orders) */ apiName: string; /** @description Filter by API version (e.g., v1) */ apiVersion: string; /** @description Filter by schema status */ status: components["schemas"]["SchemaStatus"]; /** @description The API family (e.g., shopper, admin) */ apiFamilyPath: string; /** @description The API name (e.g., products, orders) */ apiNamePath: string; /** @description The API version (e.g., v1) */ apiVersionPath: string; /** @description Comma-separated list of sections to expand (e.g., "custom_properties") */ expand: string; }; requestBodies: never; headers: never; pathItems: never; } export type $defs = Record; export interface operations { getSchemas: { parameters: { query?: { /** @description Filter by API family (e.g., shopper, admin) */ apiFamily?: components["parameters"]["apiFamily"]; /** @description Filter by API name (e.g., products, orders) */ apiName?: components["parameters"]["apiName"]; /** @description Filter by API version (e.g., v1) */ apiVersion?: components["parameters"]["apiVersion"]; /** @description Filter by schema status */ status?: components["parameters"]["status"]; }; header?: never; path: { /** * @description An identifier for the organization the request is being made by * @example f_ecom_zzxy_prd */ organizationId: components["parameters"]["organizationId"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SchemaListResult"]; }; }; /** @description Invalid or malformed filter parameter */ 400: { headers: { [name: string]: unknown; }; content: { "application/problem+json": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized - invalid or missing authentication */ 401: { headers: { [name: string]: unknown; }; content: { "application/problem+json": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden - insufficient permissions */ 403: { headers: { [name: string]: unknown; }; content: { "application/problem+json": components["schemas"]["ErrorResponse"]; }; }; }; }; getSchema: { parameters: { query?: { /** @description Comma-separated list of sections to expand (e.g., "custom_properties") */ expand?: components["parameters"]["expand"]; }; header?: never; path: { /** * @description An identifier for the organization the request is being made by * @example f_ecom_zzxy_prd */ organizationId: components["parameters"]["organizationId"]; /** @description The API family (e.g., shopper, admin) */ apiFamily: components["parameters"]["apiFamilyPath"]; /** @description The API name (e.g., products, orders) */ apiName: components["parameters"]["apiNamePath"]; /** @description The API version (e.g., v1) */ apiVersion: components["parameters"]["apiVersionPath"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful operation - returns OpenAPI schema */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OpenApiSchema"]; }; }; /** @description Invalid parameter value */ 400: { headers: { [name: string]: unknown; }; content: { "application/problem+json": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized - invalid or missing authentication */ 401: { headers: { [name: string]: unknown; }; content: { "application/problem+json": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden - insufficient permissions */ 403: { headers: { [name: string]: unknown; }; content: { "application/problem+json": components["schemas"]["ErrorResponse"]; }; }; /** @description Schema not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/problem+json": components["schemas"]["ErrorResponse"]; }; }; }; }; }