Merge pull request #570 from NYPL/SFR-2418/plural-noun-endpoints

SFR-2418: Update api endpoints to plural noun

CHANGELOG.md

@@ -5,6 +5,7 @@
 - Remove Kristo, Jiayong, and Olivia and add Kyle as codeowners
 - Deploy to new Terraform ECS cluster in production
 - Deploy only to the new Terraform ECS clusters
+- Update API endpoints to plural nouns
 
 ## [0.18.9]
 

config/appConfig.ts

@@ -13,11 +13,11 @@ const appConfig = {
       production: "http://drb-api-qa.nypl.org",
     },
     searchPath: "/search",
-    recordPath: "/work",
-    editionPath: "/edition",
-    readPath: "/link",
+    recordPath: "/works",
+    editionPath: "/editions",
+    readPath: "/links",
     languagesPath: "/utils/languages",
-    collectionPath: "/collection",
+    collectionPath: "/collections",
   },
   booksCount: {
     apiUrl: "/utils/counts",

mocks/mockEnv.ts

@@ -5,5 +5,5 @@ export const LIMITED_ACCESS_EDITION_PATH = "/edition/6977884";
 export const WORK_PATH = "/work/5950e6df-9d99-42fe-8924-1116166a2acb";
 export const DOWNLOAD_PATH = "/test-download-pdf";
 export const HOME_PATH = "/";
-export const COLLECTION_LIST_PATH = "/collection/list";
+export const COLLECTION_LIST_PATH = "/collections";
 export const INVALID_COLLECTION_PATH = "/collection/invalid-collection";

src/__tests__/fixtures/CollectionFixture.ts

@@ -188,7 +188,7 @@ export const oneCollectionListData: Opds2Feed = {
   ],
   links: [
     {
-      href: "/collection/list?page=1",
+      href: "/collections?page=1",
       rel: ["self", "first", "previous", "next", "last"],
       type: "application/opds+json",
     },
@@ -1721,7 +1721,7 @@ export const collectionListData: CollectionResult = {
     ],
     links: [
       {
-        href: "/collection/list?page=1",
+        href: "/collections?page=1",
         rel: ["self", "first", "previous", "next", "last"],
         type: "application/opds+json",
       },

src/lib/api/CollectionApi.ts

@@ -15,7 +15,10 @@ const collectionUrl = apiUrl + collectionPath;
 export const collectionFetcher = async (query: CollectionQuery) => {
   const collectionApiQuery = toApiCollectionQuery(query);
 
-  const url = new URL(collectionUrl + "/" + query.identifier);
+  const urlWithIdentifier = query.identifier
+    ? collectionUrl + "/" + query.identifier
+    : collectionUrl;
+  const url = new URL(urlWithIdentifier);
   url.search = new URLSearchParams(
     toLocationQuery(collectionApiQuery)
   ).toString();

src/pages/index.tsx

@@ -9,7 +9,6 @@ import Error from "./_error";
 export async function getServerSideProps() {
   // Fetch all collections
   const collectionResult: CollectionResult = await collectionFetcher({
-    identifier: "list",
     perPage: 8,
   });
 

src/types/CollectionQuery.ts

@@ -6,7 +6,7 @@ export type ApiCollectionQuery = {
 };
 
 export type CollectionQuery = {
-  identifier: string;
+  identifier?: string;
   page?: number;
   perPage?: number;
   sort?: string;