smi-spec icon indicating copy to clipboard operation
smi-spec copied to clipboard

Add swagger definitions for APIs

Open adleong opened this issue 4 years ago • 3 comments

It would be great to have some kind of formal specification for the APIs in this repo; swagger, for example.

adleong avatar Mar 23 '20 20:03 adleong

A formal specification for the APIs (except for metrics) is here: https://github.com/servicemeshinterface/smi-sdk-go/tree/master/crds I've added OpenAPI schema to all CRDs.

stefanprodan avatar Mar 26 '20 09:03 stefanprodan

We could move the CRDs in this repo or move the metrics OpenAPI definition in the SDK, it's going to be very confusing if we don't use a single repo for all definitions.

stefanprodan avatar Mar 26 '20 09:03 stefanprodan

I think that sounds fair to have the definition in this repo.

tomkerkhove avatar Mar 26 '20 09:03 tomkerkhove