SRI + Interop - Provide an openAPI specification file

[fleischr]

Overview

To enable integration to enterprise systems and for interop/standards testability purposes, SRI/BRI-3 should offer an openAPI specification file that documents its REST API endpoints and their associated request/response types and expected HTTP status codes

Reference

• Similar to: https://github.com/provideplatform/provide-postman/blob/master/spec/Baseline.yaml

Questions

• Let me know if this was already provided

Assumptions

• Server frameworks like Nest have libraries that should

Acceptance

• Create swagger file and add it to repo
• Use openAPI v3

Tasks

• Create swagger json or YAML file