Skip to content

Validate Match API by calling GET to auto-fill algorithm metadata (id/name/description) #2398

@filiperochalopes

Description

@filiperochalopes

User story

As a user, I want the Match API configuration to validate the endpoint by performing a GET request and auto-filling the algorithm metadata so configuration is easier and less error-prone.

Use case

Configure a Match API by providing API URL and token, then confirm the endpoint is reachable and populate fields automatically.

Requirements

  • After the user provides API URL and token, perform a GET request to the Match API endpoint.
  • The GET response must return: id (or ID), name, description.
  • Auto-fill the UI fields (id/name/description) from the GET response.
  • Keep POST on the same route for returning ranked candidates (current behavior).
  • Require Match API implementations to support GET on the same route used for POST. (@filiperochalopes can update it on docs)

Acceptance criteria

  • Given a valid API URL and token, when the user saves/tests configuration, then the system performs GET and auto-fills id/name/description from the response.
  • Given GET fails (e.g., auth/network/invalid endpoint), then the user sees a clear error and fields are not auto-filled.
  • POST continues to work on the same route for candidate retrieval.

Ref: https://openmrs.slack.com/archives/C0A99PV25NG/p1771856424673959

Metadata

Metadata

Projects

Status

No status

Status

Todo

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions