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

Replace PATCH With Specific Limited PUT Endpoints #87

Closed
3 tasks done
Tracked by #82
brian-comply0 opened this issue Mar 20, 2024 · 1 comment
Closed
3 tasks done
Tracked by #82

Replace PATCH With Specific Limited PUT Endpoints #87

brian-comply0 opened this issue Mar 20, 2024 · 1 comment
Assignees

Comments

@brian-comply0
Copy link
Contributor

brian-comply0 commented Mar 20, 2024

Description

To simplify the implementation effort required for the OSCAL REST OpenAPI specification, we should eliminate the PATCH method and instead introduce a limited set of PUT endpoints.

Under the current Concept of Operations (ConOps), there are only a few reasons for modifying the content within the OSCAL content when sharing, managing attachments or producing snapshots.

The use cases for this include:

Acceptance Criteria

  • The PATCH method is removed from the OSCAL REST OpenAPI syntax
  • Issues in the Task List below are resolved
  • Remove patch heading and paragraphs from info/description as described below.

Updated Info Description

The revised info/description should simply include the following. (Replace all current content with the following):

    A draft proposal from [Easy Dynamics](https://www.easydynamics.com) of a REST API specification for exchanging 
    [OSCAL](https://pages.nist.gov/OSCAL/) content between tool instances and organizations.  

    Standardized data models like OSCAL lay the groundwork for interoperability of systems, and an ecosystem of
    meaningful integrations can be brought to life through a standardized REST API.  Such an API will likely see the most 
    success across various vendors and projects when maintained by a standards body or community, and we're looking 
    to get that conversation started with this effort.

    For an overview and more information, visit [https://docs.oscal.io/docs/oscal-rest-openapi](https://docs.oscal.io/docs/oscal-rest-openapi)
 

Tasks

  1. mpemy
  2. mpemy
  3. mpemy
@brian-comply0
Copy link
Contributor Author

Everything actionable in this issue is addressed in PR #72. The three linked issues are still pending work or review, but as they are being tracked separately I am good closing issue.

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

No branches or pull requests

2 participants