No ref/phase 3 endpoints #258
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| import { NextResponse } from "next/server"; | ||
| import collectionsLandingPageSchema from "../../../../src/data/schemas/collectionsLandingPageSchema"; | ||
|
|
||
| export const GET = async () => { | ||
| return NextResponse.json(collectionsLandingPageSchema, { status: 200 }); | ||
| }; | ||
|
|
||
| // http://localhost:3000/api/schema/collections/:uuid |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| import { NextResponse } from "next/server"; | ||
| import collectionsStructureSchema from "../../../../../src/data/schemas/collectionsStructureSchema"; | ||
|
|
||
| export const GET = async () => { | ||
| return NextResponse.json(collectionsStructureSchema, { status: 200 }); | ||
| }; | ||
|
|
||
| // http://localhost:3000/api/schema/collections/:uuid/structure |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| import { NextResponse } from "next/server"; | ||
| import collectionsSchema from "../../../src/data/schemas/collectionsSchema"; | ||
|
|
||
| export const GET = async () => { | ||
| return NextResponse.json(collectionsSchema, { status: 200 }); | ||
| }; | ||
|
|
||
| // http://localhost:3000/api/schema/collections/:uuid |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| import { NextResponse } from "next/server"; | ||
| import searchFacetsSchema from "../../../../src/data/schemas/searchFacetsSchema"; | ||
|
|
||
| export const GET = async () => { | ||
| return NextResponse.json(searchFacetsSchema, { status: 200 }); | ||
| }; | ||
|
|
||
| // http://localhost:3000/api/schema/search/facets | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| import { NextResponse } from "next/server"; | ||
| import searchSchema from "../../../src/data/schemas/searchSchema"; | ||
|
|
||
| export const GET = async () => { | ||
| return NextResponse.json(searchSchema, { status: 200 }); | ||
| }; | ||
|
|
||
| // http://localhost:3000/api/schema/search |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| const collectionObject = { | ||
|
There was a problem hiding this comment. Where is this being used? Or is it for reference? There was a problem hiding this comment. just for reference |
||
| uuid: "string", | ||
| recordType: "collection | sub-collection", | ||
| title: "string", | ||
| url: "string", | ||
| imageID: "string | null", | ||
| imageURL: "string", | ||
| numberOfDigitizedItems: "number", | ||
| containsOnSiteMaterials: "boolean", | ||
| highlights: "{ highlighted_field_name:[ string ] }", | ||
| firstIndexed_dt: "date", | ||
| }; | ||
|
|
||
| export default collectionObject; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| const collectionsLandingPageSchema = { | ||
| response: { | ||
| numResults: "6", | ||
| page: "1", | ||
| perPage: "40", | ||
|
Comment on lines
+3
to
+5
There was a problem hiding this comment. For consistency, use "string" instead of specific values. There was a problem hiding this comment. But |
||
| items: [ | ||
| { | ||
| uuid: "string", | ||
| recordType: "item", | ||
| title: "string", | ||
| url: "string", | ||
| imageID: "string | null", | ||
| imageURL: "string", | ||
| contentType: "image | multiple images | audio | video | pdf", | ||
|
There was a problem hiding this comment. Is there a way for this to express that these are the 5 strings we're interested in, but that we expect (I think) that there are actually more content types returned on the item. So we just want a string here, then on the model we would transform it as needed? |
||
| onSiteOnly: "boolean", | ||
|
There was a problem hiding this comment. would an item have an 'isAVMaterial' field There was a problem hiding this comment. Or would that be covered by |
||
| }, | ||
| { | ||
| uuid: "string", | ||
| recordType: "item", | ||
| title: "string", | ||
| url: "string", | ||
| imageID: "string | null", | ||
| imageURL: "string", | ||
| contentType: "image | multiple images | audio | video | pdf", | ||
| onSiteOnly: "boolean", | ||
| }, | ||
| { | ||
| uuid: "string", | ||
| recordType: "item", | ||
| title: "string", | ||
| url: "string", | ||
| imageID: "string | null", | ||
| imageURL: "string", | ||
| contentType: "image | multiple images | audio | video | pdf", | ||
| onSiteOnly: "boolean", | ||
| }, | ||
| ], | ||
| }, | ||
| }; | ||
|
|
||
| export default collectionsLandingPageSchema; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| const collectionsSchema = { | ||
| response: { | ||
| numResults: "6", | ||
| page: "1", | ||
| perPage: "40", | ||
| // move from "collection" to "collections" | ||
| collections: [ | ||
| { | ||
| title: "string", | ||
| uuid: "string", | ||
| url: "string", | ||
| imageID: "string", | ||
| numberOfDigitizedItems: "string", // remove numItems | ||
| containsAVMaterial: "boolean", | ||
| constainsOnSiteMaterials: "boolean", | ||
|
Comment on lines
+14
to
+15
There was a problem hiding this comment. These will always be either |
||
| }, | ||
| { | ||
| title: "string", | ||
| uuid: "string", | ||
| url: "string", | ||
| imageID: "string", | ||
| numberOfDigitizedItems: "string", | ||
| containsAVMaterial: "boolean", | ||
| constainsOnSiteMaterials: "boolean", | ||
|
There was a problem hiding this comment. nit but contains, not constains. Just in case this is what gets copy pasted into new api |
||
| }, | ||
| { | ||
| title: "string", | ||
| uuid: "string", | ||
| url: "string", | ||
| imageID: "string", | ||
| numberOfDigitizedItems: "string", | ||
| containsAVMaterial: "boolean", | ||
| constainsOnSiteMaterials: "boolean", | ||
| }, | ||
| { | ||
| title: "string", | ||
| uuid: "string", | ||
| url: "string", | ||
| imageID: "string", | ||
| numberOfDigitizedItems: "string", | ||
| containsAVMaterial: "boolean", | ||
| constainsOnSiteMaterials: "boolean", | ||
| }, | ||
| ], | ||
| }, | ||
| }; | ||
|
|
||
| export default collectionsSchema; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| const collectionsStructureSchema = { | ||
| response: { | ||
| numResults: "6", | ||
| page: "1", | ||
| perPage: "40", | ||
| }, | ||
| }; | ||
|
|
||
| export default collectionsStructureSchema; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| const itemObject = { | ||
|
There was a problem hiding this comment. This is also not being used yet. There was a problem hiding this comment. I don't think either of these will be "used" until they exist in new repo api but the idea was have an expected shape to base models off of |
||
| uuid: "string", | ||
| recordType: "item", | ||
| title: "string", | ||
| url: "string", | ||
| imageID: "string | null", | ||
| imageURL: "string", | ||
| contentType: "image | multiple images | audio | video | pdf", | ||
| onSiteOnly: "boolean", | ||
| highlights: "{ highlighted_field_name:[ string ] }", | ||
|
There was a problem hiding this comment. "highlights" is plural but the value is a single object. Is that right? There was a problem hiding this comment. I'm also a little confused by this one. Can you give an example of what this might return as |
||
| firstIndexed_dt: "date", | ||
| }; | ||
|
|
||
| export default itemObject; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| const searchFacetsSchema = { | ||
| response: { | ||
| numResults: "6", | ||
| page: "1", | ||
| perPage: "40", | ||
| }, | ||
| }; | ||
|
|
||
| export default searchFacetsSchema; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| const searchSchema = { | ||
| response: { | ||
| // Keyword included in search | ||
| keyword: "string", | ||
| // Pagination fields | ||
| numResults: "integer", | ||
| page: "integer", | ||
| perPage: "integer", | ||
|
There was a problem hiding this comment. reiterating comment from collectionsSchema: |
||
| // Sort fields | ||
| sort: "string ie: title DESC", | ||
| // Filter fields | ||
| filterField: "string", | ||
|
There was a problem hiding this comment. Is this an array of strings? Can you give an example of what this might return as |
||
| // Results | ||
| results: [ | ||
| { | ||
|
There was a problem hiding this comment. after reading the requirements for the modal in the brd, I think we can include the list of filter categories and the first 10 filters per category in this endpoint. each category would have a field for the total count of filters so the app knows when to display the "View all" button that loads the modal. |
||
| uuid: "string", | ||
| recordType: "collection | sub-collection | item", | ||
| title: "string", | ||
| url: "string", | ||
| imageID: "string | null", | ||
| imageURL: "string", | ||
| numberOfDigitizedItems: "number", | ||
| containsOnSiteMaterials: "boolean | null if type is `item`", | ||
| contentType: "image | multiple images | audio | video | pdf | null", | ||
| onSiteOnly: | ||
| "boolean | null if type is `collection` or `sub-collection`", | ||
|
There was a problem hiding this comment. We briefly talked about this but it might be easier to make it more typescript-y and give each object "collection", "sub-collection", and "item" a type. Then it's could be There was a problem hiding this comment. I like this idea. In general, this schema makes it really clear what the search results row card will have available to it |
||
| highlights: "{ highlighted_field_name:[ string ] }", | ||
| firstIndexed_dt: "date", | ||
| }, | ||
| { | ||
| uuid: "string", | ||
| recordType: "collection | sub-collection | item", | ||
| title: "string", | ||
| url: "string", | ||
| imageID: "string | null", | ||
| imageURL: "string", | ||
| numberOfDigitizedItems: "number", | ||
| containsOnSiteMaterials: "boolean | null if type is `item`", | ||
| contentType: "image | multiple images | audio | video | pdf | null", | ||
| onSiteOnly: | ||
| "boolean | null if type is `collection` or `sub-collection`", | ||
| highlights: "{ highlighted_field_name:[ string ] }", | ||
| firstIndexed_dt: "date", | ||
| }, | ||
| { | ||
| uuid: "string", | ||
| recordType: "collection | sub-collection | item", | ||
| title: "string", | ||
| url: "string", | ||
| imageID: "string | null", | ||
| imageURL: "string", | ||
| numberOfDigitizedItems: "number", | ||
| containsOnSiteMaterials: "boolean | null if type is `item`", | ||
| contentType: "image | multiple images | audio | video | pdf | null", | ||
| onSiteOnly: | ||
| "boolean | null if type is `collection` or `sub-collection`", | ||
| highlights: "{ highlighted_field_name:[ string ] }", | ||
| firstIndexed_dt: "date", | ||
| }, | ||
| ], | ||
| }, | ||
| }; | ||
|
|
||
| export default searchSchema; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is the intended api to use for the modal.
idk if
facetsis the right term to use here?filtersis kind of more implicit of what is actually being searched.regardless, interacting with the api to get the list of the filters in the modal would require a keyword search ie.
q=and a way to identify the category we are searching, ie.category=.