[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

OpenAPI schema (swagger 2.0), generated protobufs, and updated Swagger 1.2 docs



PR #10983 has merged to master and will be in v1.4.0-alpha.1.  It contains the following:

* Updated Swagger 1.2 API specs in https://github.com/openshift/origin/tree/master/api/swagger-spec that now have correctly updated unique names (fixing the problem Graham and others hit)
* The new OpenAPI / Swagger 2.0 schema in openshift-openapi-spec.json - this is a JSONSchema document as well as an update of swagger and contains more information in general about the APIs.  Going forward, consider this our canonical spec.
* We have published the Protobuf IDLs for talking to OpenShift and Kubernetes here: https://github.com/openshift/origin/tree/master/api/protobuf-spec.  These are considered stable and should be backwards compatible in the same fashion as our JSON.  You can use the content type "application/vnd.kubernetes.protobuf" to tell the server you want to receive protobuf responses.

We intend over the course of 1.4 and 1.5 to add more information to the OpenAPI schema including default values and validation information.  Please open issues related to problems you find.

[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]