feat: SEO SPA Sites, Articles and Integration (4/4)

web/src/data/apiCatalogue.ts

@@ -60,6 +60,7 @@ export interface ErrorRow {
 	status: number
 	meaning: string
 	messages: string[]
+	note?: string
 }
 
 export interface EndpointExamples {
@@ -596,15 +597,6 @@ export const API_GROUPS: ApiGroup[] = [
 				json(article()),
 				{ query: [FORMAT_QUERY] },
 			),
-			endpoint(
-				'art-seo',
-				'GET',
-				'/v1/article/{id}/seo',
-				'Get the resolved SEO object of an article: title, description, canonical address, robots, Open Graph, Twitter, image, authors, dates and ready JSON-LD. Drafts answer 404 unless the caller is verified.',
-				'Public',
-				[e(400, ID_FORMAT), e(401, UNAUTHORIZED), e(404, 'Article not found')],
-				json(resolvedSeo()),
-			),
 			endpoint(
 				'art-create',
 				'POST',
@@ -821,6 +813,33 @@ export const API_GROUPS: ApiGroup[] = [
 			),
 		],
 	},
+	{
+		key: 'seo',
+		title: 'Search and sharing',
+		description:
+			"RenewCMS doesn't render pages or add meta tags. These endpoints give your frontend the resolved SEO data and the list of published URLs.",
+		endpoints: [
+			endpoint(
+				'art-seo',
+				'GET',
+				'/v1/article/{id}/seo',
+				'Get the resolved SEO object of an article: title with the site template applied, description, canonical_url, robots, og, twitter, image, authors, published_at, modified_at, fallbacks and json_ld. Drafts answer 404 to anonymous callers.',
+				'Public',
+				[e(400, ID_FORMAT), e(401, UNAUTHORIZED), e(404, 'Article not found')],
+				json(resolvedSeo()),
+			),
+			endpoint(
+				'site-sitemap',
+				'GET',
+				'/v1/site/{key}/sitemap',
+				'List the published URLs of a site, by id ascending, as an array of { url, modified_at, noindex }. The total is in the X-Total-Count header.',
+				'Public',
+				[e(400, BODY_MISMATCH), e(401, UNAUTHORIZED), e(404, 'site_not_found')],
+				json(sitemapPage()),
+				{ query: SITEMAP_QUERY },
+			),
+		],
+	},
 	{
 		key: 'media',
 		title: 'Media',
@@ -1199,7 +1218,7 @@ export const API_GROUPS: ApiGroup[] = [
 		key: 'sites',
 		title: 'Sites',
 		description:
-			'The sites an article can belong to. Any verified user can read them and anyone can read a sitemap; changes are made in the browser by the owner.',
+			'The sites an article can belong to. Any verified user can read them; changes are made in the browser by the owner.',
 		endpoints: [
 			endpoint(
 				'site-list',
@@ -1226,16 +1245,6 @@ export const API_GROUPS: ApiGroup[] = [
 					}),
 				]),
 			),
-			endpoint(
-				'site-sitemap',
-				'GET',
-				'/v1/site/{key}/sitemap',
-				'List the published URLs of a site, by id ascending, as an array. The total is in the X-Total-Count header.',
-				'Public',
-				[e(400, BODY_MISMATCH), e(401, UNAUTHORIZED), e(404, 'site_not_found')],
-				json(sitemapPage()),
-				{ query: SITEMAP_QUERY },
-			),
 		],
 	},
 	{
@@ -1407,6 +1416,7 @@ export const ERROR_ROWS: ErrorRow[] = [
 		status: 403,
 		meaning: 'Forbidden',
 		messages: [SESSION_REQUIRED_MESSAGE, OWNER_REQUIRED_MESSAGE, VERIFY_REQUIRED],
+		note: 'Site SEO defaults are owner only. Article SEO fields need only the right to edit the article.',
 	},
 	{
 		status: 404,