[L] Search by Legal Name or ParkID - API

[ashley-dhillon]

Developer who picks up #26 to add Acceptance Criteria details to this ticket - as well as a t-shirt size/estimate.

Note - this ticket blocks #26 and needs to be completed in parallel.

T-shirt size:

Acceptance Criteria / Dev Tasks:

• Setup a search service that can receive a query string (OpenSearch)
• Search service will return results with scores based on hits against all the data in the records
• Setup API endpoints to hook up to OpenSearch
• Documentation in the repo

Testing:

Example request (dev)

Headers Required:

• Authorization: None

URI: HTTP GET https://zloys5cfvf.execute-api.ca-central-1.amazonaws.com/api/search?text=Taku

Returns:

{
    "code": 200,
    "data": {
        "total": {
            "value": 1,
            "relation": "eq"
        },
        "max_score": 0.66301036,
        "hits": [
            {
                "_index": "main-index",
                "_id": "9522#Details",
                "_score": 0.66301036,
                "_source": {
                    "legalName": "Taku River/T’aḵú Téix̱ Conservancy",
                    "updateDate": "2023-09-18T16:54:12.574Z",
                    "phoneticName": "",
                    "displayName": "Taku River/T’aḵú Téix̱ Conservancy",
                    "sk": "Details",
                    "pk": "9522",
                    "effectiveDate": "2012-06-22",
                    "createDate": "2023-09-15T17:13:14.633Z",
                    "status": "current"
                }
            }
        ]
    },
    "msg": "Success",
    "error": null
}

[manuji]

Tested on Dev & TEST: Failed

• When tried to do a search I get the following result; { "message": "Unauthorized" }

FYI @marklise

[marklise]

You have omitted the required header flag as specified in the description:

Headers Required:

Authorization: None

[manuji]

@marklise could you please be kind enough to let me know how to add that header details from my browser? I understand how to pass that from the Postman, but not from the browser. I am sorry for the inconvieneice.

[manuji]

Tested on both TEST and Dev using Postman: Failed

• When I try the Dev environment I get a null response.
• When I try with TEST environment I get a meaningless response.

@marklise , when you are sending this back to QA please be kind enough to add a comment about your fix. Also please add notes about anything that I should do to get this right if I am doing this wrong.

[marklise]

This hasn't been deployed to TEST.. so your testing there will be invalid for sure. When testing the DEV environment, can you paste the null response? I'm not sure exactly what you're seeing. @manuji

[manuji]

Until I do the deployment to TEST here is what I see on the DEV environment.

When I try the exact same link provided by you @marklise , as the example it works on Dev, but if I search for another park name, like "Golden" I get a null response like below. I made sure that park is there on Dev DynamoDB.

[marklise]

This is a successful api call, returning you NO results. Expected.

[manuji]

But if there should be results for this search?

[manuji]

Tested on Dev: passed

• Verified that this feature is working fine on the Dev environment
• When trying to test on TEST, I experienced errors unrelated to this ticket as per @marklise and it has been reported in this ticket: https://github.com/bcgov/parks-data-register/issues/191. I will verify this again when I get that bug fixed.
• Passing this to PO review.

[JLWade]

Thanks Manuji! WIll move this one to done and track error in #191