Skip to content

Latest commit

 

History

History
11 lines (7 loc) · 509 Bytes

openapi_spec.md

File metadata and controls

11 lines (7 loc) · 509 Bytes

Generate OpenAPI spec

Setup

Controller REST API specifications are generated according to Open API 2.0 standards. All the models and handle functions to be part of controller API which are inside package pkg/restapi are annotated according to Open API 2.0 standards.

Controller REST API spec can be generated using those annotations by running following make target from project root directory.

make generate-openapi-spec

Generated spec can be found under build/rest/openapi/spec/openAPI.yml