8000 origin/api at stage-137 · aiminho/origin · GitHub
[go: up one dir, main page]

Skip to content
  • Latest commit

     

    History

    History
     
     

    api

    Folders and files

    NameName
    Last commit message
    Last commit date

    parent directory

    ..
     
     
     
     
     
     
     
     

    OpenShift API Documentation

    This directory contains a Swagger 1.0 and OpenAPI (Swagger 2.0) API definition for the OpenShift and Kubernetes APIs. The swagger-spec, protobuf-spec and docs directories are generated automatically.

    When you add a new object or field to the REST API, you should do the following:

    • Ensure all of your fields and objects have the description tag
    • Run hack/update-generated-swagger-spec.sh

    To update the REST API documentation in the openshift-docs repo, first ensure it is up-to-date in origin. Then in the openshift-docs repo, run:

    $ ORIGIN_REPO=path/to/origin make
    
    0