Skip to:

  1. Skip to Jira Navigation
  2. Skip to Side Navigation
  3. Skip to Main Content

Provide REST API endpoint(s) that enumerate the available requisition URL handlers and make their contracts discoverable

Description

User story:

As a front-end developer creating a UI for configuring requisition definitions, I'd like to be able to query a REST service to learn the available requisition URL handlers and the contracts for their URL schemes, so that I can make my UI responsive when these handlers change.

Creating this epic in support of PE-107. please watch this epic.

Acceptance / Success Criteria

None

Lucidchart Diagrams

Activity

Show:

Bonnie Robinson June 20, 2022 at 6:38 PM

Not sure this requires documentation if it is part of the Swagger REST API docs.

Jesse White October 1, 2021 at 4:43 PM

The RequisitionProviderRegistry interface can be used to enumerate the known types and retrieve the implementations, but does not currently contain details about the URL contracts. See RequisitionProviderRegistry.java.

Types that are registered and enumerated may not implement URL handlers themselves, and may only be available via the generic URL handler. For example, for the file handler one could specify:

or alternatively:

For handlers that are dynamically registered via the OIA, say the 'opendaylight' handler, one must use:

Details

Assignee

Reporter

HB Grooming Date

HB Backlog Status

Docs Needed

Yes

Doc Backlog Status

Doc Backlog Grooming Date

Components

Affects versions

Priority

Epic Name

PagerDuty

Created October 1, 2021 at 4:33 PM
Updated June 20, 2022 at 6:38 PM
Configure