@spree/docs 0.1.77 → 0.1.79
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api-reference/admin-api/authentication.md +2 -2
- package/dist/api-reference/admin-api/errors.md +2 -2
- package/dist/api-reference/admin-api/introduction.md +2 -1
- package/dist/api-reference/admin-api/querying.md +2 -2
- package/dist/api-reference/store.yaml +6091 -6091
- package/dist/developer/admin/admin.md +1 -1
- package/dist/developer/admin/extending-ui.md +1 -0
- package/dist/developer/admin/tables.md +1 -0
- package/dist/developer/core-concepts/slugs.md +1 -1
- package/package.json +1 -1
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "
|
|
2
|
+
title: "Authenticate Admin API requests with keys and JWTs"
|
|
3
3
|
sidebarTitle: "Authentication"
|
|
4
|
-
description: "
|
|
4
|
+
description: "Authenticate Spree Admin API requests using secret API keys for server-to-server calls or JWT bearer tokens for interactive admin sessions."
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
The Admin API supports two authentication methods: **secret API keys** for server-to-server integrations, and **JWT bearer tokens** for admin SPA / interactive sessions. Every request must include credentials — there is no public surface.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
|
-
title:
|
|
3
|
-
description:
|
|
2
|
+
title: "Admin API error responses, status codes, and handling"
|
|
3
|
+
description: "Reference for the Spree Admin API Stripe-style error response format, HTTP status codes, and admin-specific error codes returned by endpoints."
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
The Admin API uses the same Stripe-style error format as the rest of the Spree v3 API. Every error response carries a machine-readable `code` and a human-readable `message`.
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Admin API"
|
|
2
|
+
title: "Spree Admin API introduction and SDK quick start"
|
|
3
3
|
sidebarTitle: "Introduction"
|
|
4
|
+
description: "Overview of the Spree Admin REST API for managing products, orders, customers, and fulfillments, with SDK install and quick start examples."
|
|
4
5
|
---
|
|
5
6
|
|
|
6
7
|
import { Since } from '/snippets/since.mdx';
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "
|
|
2
|
+
title: "Filter, sort, paginate, and expand Admin API responses"
|
|
3
3
|
sidebarTitle: "Querying"
|
|
4
|
-
description: "
|
|
4
|
+
description: "Query Spree Admin API list endpoints with Ransack filters, sorting, pagination parameters, and the expand option to include related resources."
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
The Admin API uses [Ransack](https://activerecord-hackery.github.io/ransack/) for filtering and sorting on collection endpoints. All filter conditions go through the `q` parameter; sorting and pagination are top-level params.
|