oscal-react-library icon indicating copy to clipboard operation
oscal-react-library copied to clipboard

Build a REST API Client

Open laurelmay opened this issue 2 years ago • 1 comments
trafficstars

Description

As a developer working on tooling that supports the OSCAL REST API specification, I want to have a standard API client so that I can more easily make requests to the API following the specification

Acceptance Criteria

  • An API client is available in at least TypeScript and is usable within the OSCAL React Library

Proposed Solution

No response

Additional Notes

Swagger (and other tooling) allow automatically generating clients from the OpenAPI specification. This may be sufficient; however, we may also consider hand-rolling (but should be very careful about doing so).

If the client is automatically generated, we should have tooling to automatically update the generated client from the specification.

Implementation

  • [ ] I can (or plan to) submit a pull request to implement this
  • [ ] Implementing this may result in a breaking change

laurelmay avatar Mar 08 '23 19:03 laurelmay

@kylelaker Can you revise this ticket to reflect an client for the Transaction API instead of the REST API?
Or close it an open a new issue for that purpose?

brian-ruf-ezd avatar May 17 '23 01:05 brian-ruf-ezd