Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build a REST API Client #723

Open
2 tasks
laurelmay opened this issue Mar 8, 2023 · 1 comment
Open
2 tasks

Build a REST API Client #723

laurelmay opened this issue Mar 8, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@laurelmay
Copy link
Contributor

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 laurelmay added the enhancement New feature or request label Mar 8, 2023
@brian-comply0
Copy link
Contributor

brian-comply0 commented May 17, 2023

@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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants