1## API Protos 2 3This folder contains the schema of the configuration model for Google's 4internal API serving platform, which handles routing, quotas, monitoring, 5logging, and the like. 6 7Google refers to this configuration colloquially as the "service config", 8and the `service.proto` file in this directory is the entry point for 9understanding these. 10 11## Using these protos 12 13To be honest, we probably open sourced way too much of this (basically by 14accident). There are a couple files in here you are most likely to be 15interested in: `http.proto`, `documentation.proto`, `auth.proto`, and 16`annotations.proto`. 17 18### HTTP and REST 19 20The `http.proto` file contains the `Http` message (which then is wrapped 21in an annotation in `annotations.proto`), which provides a specification 22for REST endpoints and verbs (`GET`, `POST`, etc.) on RPC methods. 23We recommend use of this annotation for describing the relationship 24between RPCs and REST endpoints. 25 26### Documentation 27 28The `documentation.proto` file contains a `Documentation` message which 29provides a mechanism to fully describe an API, allowing a tool to build 30structured documentation artifacts. 31 32### Authentication 33 34The `auth.proto` file contains descriptions of both authentication rules 35and authentication providers, allowing you to describe what your services 36expect and accept from clients. 37