Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion spectaql/config-merchandising.yml
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ introspection:

# URL of the GraphQL endpoint to hit if you want to generate the documentation based on live Introspection Query results
# NOTE: If not using introspection.url OR servers[], you need to provide x-url below
url: https://na1-sandbox.api.commerce.adobe.com/${TENANT_ID}/graphql # TENANT_ID should be set as an environment variable. This value was previously hardcoded for the Instructor Instance in the Adobe Commerce Optimizer org.
url: https://${API_HOST}/${TENANT_ID}/graphql # TENANT_ID should be set as an environment variable. This value was previously hardcoded for the Instructor Instance in the Adobe Commerce Optimizer org.
exclude:
excludeMutations: true
#
Expand Down
18 changes: 9 additions & 9 deletions spectaql/enhanced-schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@
"args": [
{
"name": "family",
"description": "**Required.** The catalog family identifier that determines which catalog's navigation structure to retrieve.\n\n**Typically:** Your store's catalog ID\n\n**Performance Optimizations:**\n- Entire family structure retrieved in single query\n- Heavily cached responses\n- Optimized for frequent navigation requests\n- Minimal database load for menu rendering",
"description": "The product family to retrieve the navigation tree for. For example, clothing, electronics or books",
"type": {
"name": null,
"kind": "NON_NULL",
Expand All @@ -150,7 +150,7 @@
"args": [
{
"name": "family",
"description": "**Required.** The catalog family identifier that determines which catalog's categories to retrieve.\n\n**Typically:** Your store's catalog ID",
"description": "The product family to retrieve the category tree for. Ex: clothing, electronics, books",
"type": {
"name": null,
"kind": "NON_NULL",
Expand All @@ -162,7 +162,7 @@
},
{
"name": "slugs",
"description": "Optional array of specific category slugs to retrieve.\n\n**When Provided:**\n- Returns only specified categories\n- Includes their hierarchical relationships (parents and children)\n- Enables targeted category tree queries\n\n**When Omitted:** All categories in the specified family are returned\n\n**Use Cases:**\n- Fetching specific category branches\n- Retrieving category subtrees\n- Targeted hierarchy queries",
"description": "The slugs of the categories to retrieve the category tree for. Ex: men/clothing/shorts",
"type": {
"name": null,
"kind": "LIST",
Expand All @@ -174,7 +174,7 @@
},
{
"name": "depth",
"description": "Optional maximum depth level to retrieve in the category tree structure.\n\n**Depth Levels:**\n- `0`: Root categories only\n- `1`: Root categories + immediate children\n- `2`: Root + children + grandchildren\n- And so on...\n\n**Benefits:**\n- Improves performance for large category trees\n- Controls response payload size\n- Enables progressive tree loading\n\n**Default:** All available levels are returned if omitted",
"description": "The depth of the category tree to retrieve. For example, depth 1 will retrieve only root categories (categories with level 1), depth 2 will retrieve root categories and their primary children (level 1 & level 2 categories).",
"type": {
"name": "Int",
"kind": "SCALAR",
Expand Down Expand Up @@ -60286,7 +60286,7 @@
"args": [
{
"name": "family",
"description": "**Required.** The catalog family identifier that determines which catalog's navigation structure to retrieve.\n\n**Typically:** Your store's catalog ID\n\n**Performance Optimizations:**\n- Entire family structure retrieved in single query\n- Heavily cached responses\n- Optimized for frequent navigation requests\n- Minimal database load for menu rendering",
"description": "The product family to retrieve the navigation tree for. For example, clothing, electronics or books",
"type": {
"kind": "NON_NULL",
"name": null,
Expand Down Expand Up @@ -60317,7 +60317,7 @@
"args": [
{
"name": "family",
"description": "**Required.** The catalog family identifier that determines which catalog's categories to retrieve.\n\n**Typically:** Your store's catalog ID",
"description": "The product family to retrieve the category tree for. Ex: clothing, electronics, books",
"type": {
"kind": "NON_NULL",
"name": null,
Expand All @@ -60331,7 +60331,7 @@
},
{
"name": "slugs",
"description": "Optional array of specific category slugs to retrieve.\n\n**When Provided:**\n- Returns only specified categories\n- Includes their hierarchical relationships (parents and children)\n- Enables targeted category tree queries\n\n**When Omitted:** All categories in the specified family are returned\n\n**Use Cases:**\n- Fetching specific category branches\n- Retrieving category subtrees\n- Targeted hierarchy queries",
"description": "The slugs of the categories to retrieve the category tree for. Ex: men/clothing/shorts",
"type": {
"kind": "LIST",
"name": null,
Expand All @@ -60349,7 +60349,7 @@
},
{
"name": "depth",
"description": "Optional maximum depth level to retrieve in the category tree structure.\n\n**Depth Levels:**\n- `0`: Root categories only\n- `1`: Root categories + immediate children\n- `2`: Root + children + grandchildren\n- And so on...\n\n**Benefits:**\n- Improves performance for large category trees\n- Controls response payload size\n- Enables progressive tree loading\n\n**Default:** All available levels are returned if omitted",
"description": "The depth of the category tree to retrieve. For example, depth 1 will retrieve only root categories (categories with level 1), depth 2 will retrieve root categories and their primary children (level 1 & level 2 categories).",
"type": {
"kind": "SCALAR",
"name": "Int",
Expand Down Expand Up @@ -77228,6 +77228,6 @@
}
},
"extensions": {
"request-id": "a75167ce-c2a3-4c78-82c4-d114a98c1411"
"request-id": "f42542dc-84eb-472c-8bf5-5d271fcf89e0"
}
}
34 changes: 1 addition & 33 deletions spectaql/metadata-merchandising.json
Original file line number Diff line number Diff line change
Expand Up @@ -4103,37 +4103,5 @@
"undocumented": true
}
}
},
"FIELD_ARGUMENT": {
"Query": {
"categoryTree": {
"family": {
"documentation": {
"description": "**Required.** The catalog family identifier that determines which catalog's categories to retrieve.\n\n**Typically:** Your store's catalog ID",
"undocumented": false
}
},
"slugs": {
"documentation": {
"description": "Optional array of specific category slugs to retrieve.\n\n**When Provided:**\n- Returns only specified categories\n- Includes their hierarchical relationships (parents and children)\n- Enables targeted category tree queries\n\n**When Omitted:** All categories in the specified family are returned\n\n**Use Cases:**\n- Fetching specific category branches\n- Retrieving category subtrees\n- Targeted hierarchy queries",
"undocumented": false
}
},
"depth": {
"documentation": {
"description": "Optional maximum depth level to retrieve in the category tree structure.\n\n**Depth Levels:**\n- `0`: Root categories only\n- `1`: Root categories + immediate children\n- `2`: Root + children + grandchildren\n- And so on...\n\n**Benefits:**\n- Improves performance for large category trees\n- Controls response payload size\n- Enables progressive tree loading\n\n**Default:** All available levels are returned if omitted",
"undocumented": false
}
}
},
"navigation": {
"family": {
"documentation": {
"description": "**Required.** The catalog family identifier that determines which catalog's navigation structure to retrieve.\n\n**Typically:** Your store's catalog ID\n\n**Performance Optimizations:**\n- Entire family structure retrieved in single query\n- Heavily cached responses\n- Optimized for frequent navigation requests\n- Minimal database load for menu rendering",
"undocumented": false
}
}
}
}
}
}
}
Loading
Loading