github.com/rkt/rkt@v1.30.1-0.20200224141603-171c416fac02/api/v1alpha/README.md (about)

     1  # WARNING
     2  
     3  The API defined here is proposed, experimental, and (for now) subject to change at any time.
     4  
     5  If you think you want to use it, or for any other queries, contact <rkt-dev@googlegroups.com> or file an [issue](https://github.com/rkt/rkt/issues/new)
     6  
     7  For more information, see:
     8  - #1208
     9  - #1359
    10  - #1468
    11  - [API Service Subcommand](../../Documentation/subcommands/api-service.md)
    12  
    13  ## Protobuf
    14  
    15  The rkt gRPC API uses Protocol Buffers for its services.
    16  In order to rebuild the generated code make sure you have protobuf 3.0.0 installed (https://github.com/google/protobuf)
    17  and execute from the top-level directory:
    18  
    19  ```
    20  $ make protobuf
    21  ```
    22  
    23  ## Documentation
    24  
    25  HTML and Markdown Protobuf documentation is automatically generated and placed in [docs](docs/).