OSCAL REST API Definition

A draft proposal from Easy Dynamics of an OpenAPI REST specification for interacting with OSCAL models.

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. That interface needs to define simple CRUD operations, but should also describe how to manipulate relationships and make partial changes.

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.

Viewing / Editing

You can use a Swagger Editor, local (Docker works great) or online to view the specification:

Linting & Testing

1. Install yamllint
2. Run yamllint -c .yamllint.yaml .
   • This will lint all .yaml files

Contributing

For the process of Contributing to the project, please review CONTRIBUTING.md and adhere to the Code of Conduct.

Licensing

For information on the project's license, please review the LICENSE file.