OpaqueAPI Endpoint Documentation¶

This folder serves two different purposes: as explicit documentation of the REST API exposed via the mc2api package, and as a source of truth for the codegen of that package. For the first purpose these documents are intended to be viewed through stoplight. Any edits to the yaml files in the V1 folder should also be done through stoplight to avoid accidentally breaking the stoplight spec. For the second purpose OpenAPI Generator is used to generate the opaqueapi package in /opaque/client/endpoints. For additional details regarding how updating these files impacts the opaqueapi package see /opaque/client/endpoints/README.md.