openrmf-api-save

As of version 1.8, this functionality is moved into the openrmf-api-read project to reduce the footprint and number of components.

This is the OpenRMF Save API for saving a checklist and its metadata. It has two calls.

POST to / to save a new document
PUT to /artifact/{id} to update an artifact record
PUT to /artifact/{artifactId}/vulnid/{vulnid} to update a vulnerability record in a checklist
POST to upgradechecklist/system/{systemGroupId}/artifact/{artifactId} to upgrade a checklist to a new version
DELETE to /artifact/{id} to remove an artifact
DELETE to /system/{id} to remove a system and all artifacts
DELETE to system/{id}/artifacts to remove 1 or more artifact records in a system
POST to /system to make a new system record
PUT to /system/{systemGroupId} to update a system record
/swagger/ gives you the API structure.

Making your local Docker image

~/mongodb/bin/mongo 'mongodb://root:myp2ssw0rd@localhost'
use admin
db.createUser({ user: "openrmf" , pwd: "openrmf1234!", roles: ["readWriteAnyDatabase"]});
use openrmf
db.createCollection("Artifacts");

~/mongodb/bin/mongo 'mongodb://openrmf:openrmf1234!@localhost/openrmf?authSource=admin'

Using NATS from Synadia to have a messaging backbone and eventual consistency. Currently publishing to these known items: