Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Glue concept page #1998

Merged
merged 24 commits into from
Jul 19, 2023
Merged
Show file tree
Hide file tree
Changes from 21 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
167 changes: 134 additions & 33 deletions _data/sidebars/scos_dev_sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -658,35 +658,114 @@ entries:
- "202005.0"
- "202009.0"
- "202108.0"






- title: Glue API guides
url: /docs/scos/dev/glue-api-guides/glue-api-guides.html
nested:
- title: Glue REST API
url: /docs/scos/dev/glue-api-guides/glue-rest-api.html
include_versions:
- "201811.0"
- "201903.0"
- "201907.0"
- "202001.0"
- "202005.0"
- "202009.0"
- "202108.0"
- "202204.0"
include_versions:
- "201811.0"
- "201903.0"
- "201907.0"
- "202001.0"
- "202005.0"
- "202009.0"
- "202108.0"
- "202204.0"
- title: Glue Spryks
url: /docs/scos/dev/glue-api-guides/glue-spryks.html
- title: Decoupled Glue API
url: /docs/scos/dev/glue-api-guides/decoupled-glue-api.html
include_versions:
- "202212.0"
- title: Glue infrastructure
url: /docs/scos/dev/glue-api-guides/glue-infrastructure.html
include_versions:
- "201811.0"
- "201903.0"
- "201907.0"
- "202001.0"
- "202005.0"
- "202009.0"
- "202108.0"
- "202204.0"
- title: Decoupled Glue infrastructure
include_versions:
- "202204.0"
- "202212.0"
nested:
- title: Backend and Storefront API module differences
url: /docs/scos/dev/glue-api-guides/decoupled-glue-infrastructure/backend-and-storefront-api-module-differences.html
include_versions:
- "202204.0"
- title: Create Glue API applications
url: /docs/scos/dev/glue-api-guides/decoupled-glue-infrastructure/create-glue-api-applications.html
include_versions:
- "202204.0"
- title: Authentication and authorization
url: /docs/scos/dev/glue-api-guides/decoupled-glue-infrastructure/authentication-and-authorization.html
include_versions:
- "202204.0"
- title: Security and authentication
url: /docs/scos/dev/glue-api-guides/decoupled-glue-infrastructure/security-and-authentication.html

include_versions:
- "202204.0"
- title: Backend and Storefront API module differences
url: /docs/scos/dev/glue-api-guides/backend-and-storefront-api-module-differences.html
include_versions:
- "202212.0"
- title: Create Glue API applications
url: /docs/scos/dev/glue-api-guides/create-glue-api-applications.html
include_versions:
- "202212.0"
- title: Authentication and authorization
url: /docs/scos/dev/glue-api-guides/authentication-and-authorization.html
include_versions:
- "202212.0"
- title: Security and authentication
url: /docs/scos/dev/glue-api-guides/security-and-authentication.html
include_versions:
- "202212.0"
- title: Old Glue infrastructure
include_versions:
- "202212.0"
nested:
- title: Glue REST API
url: /docs/scos/dev/glue-api-guides/old-glue-infrastructure/glue-rest-api.html
include_versions:
- "202212.0"
- title: Glue infrastructure
url: /docs/scos/dev/glue-api-guides/old-glue-infrastructure/glue-infrastructure.html
include_versions:
- "202212.0"
- title: Handling concurrent REST requests and caching with entity tags
url: /docs/scos/dev/glue-api-guides/old-glue-infrastructure/handling-concurrent-rest-requests-and-caching-with-entity-tags.html
include_versions:
- "202212.0"
- title: Resolving search engine friendly URLs
url: /docs/scos/dev/glue-api-guides/old-glue-infrastructure/resolving-search-engine-friendly-urls.html
include_versions:
- "202212.0"
- title: Reference information - GlueApplication errors
url: /docs/scos/dev/glue-api-guides/old-glue-infrastructure/reference-information-glueapplication-errors.html
include_versions:
- "202212.0"
- title: REST API B2B Demo Shop reference
url: /docs/scos/dev/glue-api-guides/old-glue-infrastructure/rest-api-b2b-reference.html
include_versions:
- "202212.0"
- title: REST API B2C Demo Shop reference
url: /docs/scos/dev/glue-api-guides/old-glue-infrastructure/rest-api-b2c-reference.html
include_versions:
- "202212.0"
- title: Routing
include_versions:
- "202204.0"
Expand All @@ -698,14 +777,16 @@ entries:
url: /docs/scos/dev/glue-api-guides/routing/create-backend-resources.html
- title: Create routes
url: /docs/scos/dev/glue-api-guides/routing/create-routes.html

- title: Create and change Glue API conventions
url: /docs/scos/dev/glue-api-guides/create-and-change-glue-api-conventions.html
include_versions:
- "202204.0"
- "202212.0"
- title: Create Glue API authorization strategies
url: /docs/scos/dev/glue-api-guides/create-glue-api-authorization-strategies.html
include_versions:
- "202204.0"
- "202212.0"
- title: Create Glue API resources with parent-child relationships
url: /docs/scos/dev/glue-api-guides/create-glue-api-resources-with-parent-child-relationships.html
include_versions:
Expand All @@ -717,12 +798,12 @@ entries:
- "202204.0"
- "202212.0"
- title: Create JSON:API relationships
url: /docs/scos/dev/glue-api-guides/create-json-api-relationships.html
url: /docs/scos/dev/glue-api-guides/create-protected-glue-api-endpoints.html
VadymSachenko marked this conversation as resolved.
Show resolved Hide resolved
include_versions:
- "202204.0"
- "202212.0"
- title: Create protected Glue API endpoints
url: /docs/scos/dev/glue-api-guides/create-protected-glue-api-endpoints.html
url: /docs/scos/dev/glue-api-guides/create-json-api-relationships.html
VadymSachenko marked this conversation as resolved.
Show resolved Hide resolved
include_versions:
- "202204.0"
- "202212.0"
Expand All @@ -733,8 +814,21 @@ entries:
- "202212.0"
- title: Handling concurrent REST requests and caching with entity tags
url: /docs/scos/dev/glue-api-guides/handling-concurrent-rest-requests-and-caching-with-entity-tags.html
include_versions:
- "201907.0"
- "202001.0"
- "202005.0"
- "202009.0"
- "202108.0"
- "202204.0"
- title: Resolving search engine friendly URLs
url: /docs/scos/dev/glue-api-guides/resolving-search-engine-friendly-urls.html
include_versions:
- "202001.0"
- "202005.0"
- "202009.0"
- "202108.0"
- "202204.0"
- title: Use authentication servers with Glue API
url: /docs/scos/dev/glue-api-guides/use-authentication-servers-with-glue-api.html
include_versions:
Expand Down Expand Up @@ -784,17 +878,14 @@ entries:
- "202009.0"
- "202108.0"
- "202204.0"
- "202212.0"
- title: REST API B2C Demo Shop reference
url: /docs/scos/dev/glue-api-guides/rest-api-b2c-reference.html
include_versions:
- "202204.0"
- "202212.0"
- title: REST API B2B Demo Shop reference
url: /docs/scos/dev/glue-api-guides/rest-api-b2b-reference.html
include_versions:
- "202204.0"
- "202212.0"
- title: Managing customers
url: /docs/scos/dev/glue-api-guides/managing-customers/managing-customers.html
include_versions:
Expand All @@ -806,14 +897,25 @@ entries:
- "202009.0"
- "202108.0"
- "202204.0"
nested:
- title: Managing customer addresses
url: /docs/scos/dev/glue-api-guides/managing-customers/managing-customer-addresses.html
include_versions:
- "202009.0"
- "202108.0"
- "202204.0"
- title: Retrieving customer orders
url: /docs/scos/dev/glue-api-guides/managing-customers/retrieving-customer-orders.html
include_versions:
- "201811.0"
- "201903.0"
- "202005.0"
- "202009.0"
- "202108.0"
- "202204.0"
- title: Managing B2B account
url: /docs/scos/dev/glue-api-guidesmanaging-b2b-account/managing-b2b-account.html
url: /docs/scos/dev/glue-api-guides/managing-b2b-account/managing-b2b-account.html
include_versions:
- "201907.0"
- "202001.0"
- "202005.0"
- "202009.0"
- "202108.0"
- "202204.0"
nested:
- title: Searching by company users
Expand All @@ -828,15 +930,21 @@ entries:
url: /docs/scos/dev/glue-api-guides/managing-b2b-account/retrieving-company-roles.html
- title: Retrieving business unit addresses
url: /docs/scos/dev/glue-api-guides/managing-b2b-account/retrieving-business-unit-addresses.html


- title: Retrieve related products
url: /docs/scos/dev/glue-api-guides/retrieve-related-products.html
- title: Retrieving store configuration
url: /docs/scos/dev/glue-api-guides/retrieving-store-configuration.html
include_versions:
- "202009.0"
- "201811.0"
- "201903.0"
- "201907.0"
- "202001.0"
- "202005.0"
- "202009.0"
- "202108.0"
- "202204.0"
- title: Retrieve related products
url: /docs/scos/dev/glue-api-guides/retrieve-related-products.html
include_versions:
- "202204.0"
- title: Searching the product catalog
url: /docs/scos/dev/glue-api-guides/searching-the-product-catalog.html
include_versions:
Expand All @@ -858,13 +966,6 @@ entries:
- "201907.0"
- "202108.0"
- "202204.0"







- title: Feature integration guides
url: /docs/scos/dev/feature-integration-guides/feature-integration-guides.html
nested:
Expand Down Expand Up @@ -4701,4 +4802,4 @@ entries:
url: /docs/scos/dev/updating-spryker/troubleshooting-updates.html
- title: Code contribution guide
url: /docs/scos/dev/code-contribution-guide.html
...
...
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Activate the following plugins:

{% info_block infoBox %}

`OrdersResourceRoutePlugin` GET verb is a protected resource. For more details, see the `configure` function [Resource routing](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-infrastructure.html#resource-routing).
`OrdersResourceRoutePlugin` GET verb is a protected resource. For more details, see the `configure` function [Resource routing](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastucture/glue-infrastructure.html#resource-routing).

{% endinfo_block %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ The result should be 0 records.

* `CartPermissionGroupsResourceRoutePlugin` is a protected resource for the `GET` request.

For more details, see the `configure` function in [Resource Routing](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-infrastructure.html#resource-routing).
For more details, see the `configure` function in [Resource Routing](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastucture/glue-infrastructure.html#resource-routing).

{% endinfo_block %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ SELECT COUNT(*) FROM spy_shopping_list_item WHERE uuid IS NULL;

{% info_block infoBox %}

`ShoppingListsResourcePlugin` GET, POST, PATCH and DELETE, `ShoppingListItemsResourcePlugin` POST, PATCH and DELETE verbs are protected resources. For details, refer to the Configure section of [Glue Infrastructure documentation](/docs/scos/dev/glue-api-guides/{{page.version}}/glue-infrastructure.html#resource-routing).
`ShoppingListsResourcePlugin` GET, POST, PATCH and DELETE, `ShoppingListItemsResourcePlugin` POST, PATCH and DELETE verbs are protected resources. For details, refer to the Configure section of [Glue Infrastructure documentation](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastucture/glue-infrastructure.html#resource-routing).

{% endinfo_block %}

Expand Down
2 changes: 1 addition & 1 deletion _scripts/sidebar_checker/sidebar_checker.sh
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ SIDEBARS=("_data/sidebars/acp_user_sidebar.yml" "_data/sidebars/cloud_dev_sideba
TITLES=("ACP User" "Cloud Dev" "Marketplace Dev" "Marketplace User" "PBC All" "SCOS Dev" "SCOS User" "SCU Dev" "SDK Dev")

# Define the folders to ignore
IGNORED_FOLDERS=("201811.0" "201903.0" "201907.0" "202001.0" "202005.0" "202009.0" "202108.0" "202304.0")
IGNORED_FOLDERS=("201811.0" "201903.0" "201907.0" "202001.0" "202005.0" "202009.0" "202108.0", "202304.0", "202400.0")

# Define output file path
OUTPUT_FILE="_scripts/sidebar_checker/missing-documents.yml"
Expand Down
2 changes: 1 addition & 1 deletion docs/acp/user/developing-an-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ For more details, see [App Configuration Translation](/docs/acp/user/app-configu
The command defines Sync API and Async API.

##### Sync API
The Sync API defines the app's synchronous endpoints, or [Glue](/docs/scos/dev/glue-api-guides/{{site.version}}/glue-rest-api.html) endpoints. The workflow creates a boilerplate that you need to update with the required endpoints your app should have. See the [current OpenAPI specification](https://spec.openapis.org/oas/v3.1.0).
The Sync API defines the app's synchronous endpoints, or [Glue](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/glue-rest-api.html) endpoints. The workflow creates a boilerplate that you need to update with the required endpoints your app should have. See the [current OpenAPI specification](https://spec.openapis.org/oas/v3.1.0).

For more details about the Sync API with information specific to Spryker, see [Sync API](/docs/acp/user/sync-api.html).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -171,4 +171,4 @@ Using the information from the response and the Glue server name, you can constr
| 404 | The provided URL does not exist. |
| 422 | The `url` parameter is missing. |

To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html).
To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html).
Original file line number Diff line number Diff line change
Expand Up @@ -1800,7 +1800,7 @@ To retrieve a search suggestion, send the request:

{% info_block infoBox "SEO-friendly URLs" %}

The `url` attribute of categories and abstract products exposes a SEO-friendly URL of the resource that represents the respective category or product. For information about how to resolve such a URL and retrieve the corresponding resource, see [Resolving search engine friendly URLs](/docs/scos/dev/glue-api-guides/{{page.version}}/resolving-search-engine-friendly-urls.html).
The `url` attribute of categories and abstract products exposes a SEO-friendly URL of the resource that represents the respective category or product. For information about how to resolve such a URL and retrieve the corresponding resource, see [Resolving search engine friendly URLs](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/resolving-search-engine-friendly-urls.html).

{% endinfo_block %}

Expand All @@ -1810,4 +1810,4 @@ Although CMS pages also expose the `url` parameter, resolving of CMS page SEF UR

{% endinfo_block %}

To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html).
To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html).
Original file line number Diff line number Diff line change
Expand Up @@ -352,4 +352,4 @@ To retrieve detailed information about an order, send the following request:
|002| Access token is missing. |
|801| Order with the given order reference is not found. |

To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html).
To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html).
Original file line number Diff line number Diff line change
Expand Up @@ -3076,4 +3076,4 @@ If the cart is deleted successfully, the endpoint returns the `204 No Content` s
| 118 | Price mode is missing. |
| 119 | Price mode is incorrect. |

To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html).
To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html).
Original file line number Diff line number Diff line change
Expand Up @@ -3245,4 +3245,4 @@ If the item is deleted successfully, the endpoint returns the “204 No Content
| 4006 | The configured bundle cannot be updated. |
| 4007 | The configured bundle cannot be removed. |

To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html).
To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html).
Original file line number Diff line number Diff line change
Expand Up @@ -3314,4 +3314,4 @@ If the item is deleted successfully, the endpoint returns the “204 No Content
| 4006 | The configured bundle cannot be updated. |
| 4007 | The configured bundle cannot be removed. |

To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html).
To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html).
Original file line number Diff line number Diff line change
Expand Up @@ -1193,4 +1193,4 @@ In a **single cart** environment, items from the guest cart have been added to
| 118 | Price mode is missing. |
| 119 | Price mode is incorrect. |

To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html).
To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html).
Original file line number Diff line number Diff line change
Expand Up @@ -1625,4 +1625,4 @@ For the attributes of the included resources, see:
| 402 | Customer with the specified ID was not found. |
| 802 | Request is unauthorized. |

To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html).
To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{page.version}}/reference-information-glueapplication-errors.html).
Original file line number Diff line number Diff line change
Expand Up @@ -3077,4 +3077,4 @@ If the cart is deleted successfully, the endpoint returns the `204 No Content` s
| 118 | Price mode is missing. |
| 119 | Price mode is incorrect. |

To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/reference-information-glueapplication-errors.html).
To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/scos/dev/glue-api-guides/{{site.version}}/old-glue-infrastructure/reference-information-glueapplication-errors.html).
Loading