API MVP to utilize Amazon OpenSearch Serverless

[tloubrieu-jpl]

💡 Description

• Identifier resolvers
• Search query q
• Keyword search (see also keyword search can not be combined with other search parameters #430)
• Pagination
• Membership (see also As a user, I want to apply an additional query filter (q=) to members of an aggregate product (/products/{identifier}/members) #298)
• classes endpoints supporting q , and only showing latest products
• properties - @jordanpadams - I don't think this is absolutely necessary for an MVP if we can't get to it
• healthcheck - @jordanpadams - I don't think this is absolutely necessary for an MVP if we can't get to it

⚔️ Sub-tasks

Must-have

• As a user, I want to get all the products for a specific PDS4 product class #511
• As a user, by default, I want to resolve the latest version of a product when given a product logical_identifier (LID) (/products/{logical_identifier} endpoint) #503
• As a user, by default, I want to search only for the latest versions of all products on the /products endpoint #426
• As a user, by default, I want to search for the latest versions of all products on the /classes/{class} endpoint unless explicitly requested #488
• As a user, I want to get a description of the API when I request it from its base URL in a web browser #516
• Registry-sweeper upgrade for multitenant registry registry-sweepers#120
• q= query with or does not work as expected #520

Support for Latest Version of Products Only

• As a user, by default, I want to search for only the latest versions of all products on the /products/{identifier}/members endpoint #484
• As a user, by default, I want to search for only the latest versions of all products on the /products/{identifier}/members/members endpoint #485
• As a user, by default, I want to search for only the latest versions of all products on the /products/{identifier}/member-of endpoint #486
• As a user, by default, I want to search only for the latest versions of all products on the /products/{identifier}/member-of/member-of endpoint #487
• As a user, by default, I want to search for the latest versions of all products on the /classes/{class} endpoint unless explicitly requested #488

Support basic comparators with q=

• As a user, I want to filter the products by any available PDS4 property using comparison operators #494
• As a user, I want to receive metadata only in the API responses (no binary blobs) #497
• As a user, I want to apply an additional query filter (q=) to members of an aggregate product (/products/{identifier}/members) #298

Support for q= Across All Endpoints

• As a user, I want to apply an additional query filter (q=) to members of the members of an aggregate product (/products/{identifier}/members/members) #490
• As a user, I want to apply an additional query filter (q=) to the /products/{identifier}/member-of result set #491
• As a user, I want to apply an additional query filter (q=) to the /products/{identifier}/member-of/member-of result set #492
• As a user, I want to apply an additional query filter (q=) to the /classes/{class} result set #493

Could-have

• As a user, I want to know what are all the possible properties I can search against (/properties) #506
• Upgrade /healthcheck endpoint to support AOSS #507
• As a web developer, I want to access read-only any feature provided by opensearch #433

[tloubrieu-jpl]

Checked tasks so far per #470

[tloubrieu-jpl]

@alexdunnjpl ,

I assigned this ticket to you since the already made development, on develop branch are assigned to ticket #470.

[jordanpadams]

Status: @alexdunnjpl starting to dig into this design and upgrade

[tloubrieu-jpl]

@alexdunnjpl is making progress on membership end-points.

[alexdunnjpl]

Membership item implemented in #499 and NASA-PDS/registry#298

Moving on to keyword search

[alexdunnjpl]

@jordanpadams @tloubrieu-jpl per #430 (comment), which requirement should be my next priority?

This'n? Is that actually blocking our deployment to serverless, given that we didn't already have it?

[jordanpadams]

@alexdunnjpl probably this parent task: #420, more specifically #425. This will require an update to the product data types to support this. I don't know which requirements are yet to be implemented, but I will try to dig through that later this week.

[jordanpadams]

📆 07/2024 status: New tasks split from NASA-PDS/registry#185 but very tightly coupled. In work. On schedule for 8/22

[jordanpadams]

Stand-up status: Nearing completion. 1 task remaining for a stable release.

[jordanpadams]

All must-have MVP requirements implemented and presented to API WG.