Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

docs: improve SEO metadata on Admin API reference pages (#14139)

mintlify[bot]05cf43f19fb9
diff --git a/docs/api-reference/admin-api/authentication.mdx b/docs/api-reference/admin-api/authentication.mdx
index 6978811563..73f63fce9b 100644
--- a/docs/api-reference/admin-api/authentication.mdx
+++ b/docs/api-reference/admin-api/authentication.mdx
@@ -1,7 +1,7 @@
---
-title: "Authentication"
+title: "Authenticate Admin API requests with keys and JWTs"
sidebarTitle: "Authentication"
-description: "How to authenticate requests to the Admin API"
+description: "Authenticate Spree Admin API requests using secret API keys for server-to-server calls or JWT bearer tokens for interactive admin sessions."
---
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.
diff --git a/docs/api-reference/admin-api/errors.mdx b/docs/api-reference/admin-api/errors.mdx
index 45df281d89..044c65919c 100644
--- a/docs/api-reference/admin-api/errors.mdx
+++ b/docs/api-reference/admin-api/errors.mdx
@@ -1,6 +1,6 @@
---
-title: Errors
-description: Error response format and admin-specific error codes
+title: "Admin API error responses, status codes, and handling"
+description: "Reference for the Spree Admin API Stripe-style error response format, HTTP status codes, and admin-specific error codes returned by endpoints."
---
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`.
diff --git a/docs/api-reference/admin-api/introduction.mdx b/docs/api-reference/admin-api/introduction.mdx
index a49c0897ed..ca2e9ca075 100644
--- a/docs/api-reference/admin-api/introduction.mdx
+++ b/docs/api-reference/admin-api/introduction.mdx
@@ -1,6 +1,7 @@
---
-title: "Admin API"
+title: "Spree Admin API introduction and SDK quick start"
sidebarTitle: "Introduction"
+description: "Overview of the Spree Admin REST API for managing products, orders, customers, and fulfillments, with SDK install and quick start examples."
---
import { Since } from '/snippets/since.mdx';
diff --git a/docs/api-reference/admin-api/querying.mdx b/docs/api-reference/admin-api/querying.mdx
index de9902a349..33fe09be1d 100644
--- a/docs/api-reference/admin-api/querying.mdx
+++ b/docs/api-reference/admin-api/querying.mdx
@@ -1,7 +1,7 @@
---
-title: "Querying"
+title: "Filter, sort, paginate, and expand Admin API responses"
sidebarTitle: "Querying"
-description: "Filter, sort, paginate, and expand Admin API list responses"
+description: "Query Spree Admin API list endpoints with Ransack filters, sorting, pagination parameters, and the expand option to include related resources."
---
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.