diff options
author | komels <komels@yandex-team.ru> | 2022-04-15 16:53:39 +0300 |
---|---|---|
committer | komels <komels@yandex-team.ru> | 2022-04-15 16:53:39 +0300 |
commit | 703a2fb6e100d202d1c7fcd052d73bd5affef408 (patch) | |
tree | 22b7320c06bb04d86dbf7b9af9ae44281331cd15 /contrib/libs/googleapis-common-protos/google/api/README.md | |
parent | 3375bbfda1e2afb03aa2072bf5f2f2c3a26026e8 (diff) | |
download | ydb-703a2fb6e100d202d1c7fcd052d73bd5affef408.tar.gz |
Move 'kikimr/yndx'-depending tests out of ydb/core
ref:0a380e13308d579e0545a76924330d1ca5129c43
Diffstat (limited to 'contrib/libs/googleapis-common-protos/google/api/README.md')
-rw-r--r-- | contrib/libs/googleapis-common-protos/google/api/README.md | 46 |
1 files changed, 0 insertions, 46 deletions
diff --git a/contrib/libs/googleapis-common-protos/google/api/README.md b/contrib/libs/googleapis-common-protos/google/api/README.md deleted file mode 100644 index 4aa4b50c90..0000000000 --- a/contrib/libs/googleapis-common-protos/google/api/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## API Protos - -This folder contains the schema of the configuration model for Google's -internal API serving platform, which handles routing, quotas, monitoring, -logging, and the like. - -Google refers to this configuration colloquially as the "service config", -and the `service.proto` file in this directory is the entry point for -understanding these. - -## Using these protos - -To be honest, we probably open sourced way too much of this (basically by -accident). There are a couple files in here you are most likely to be -interested in: `http.proto`, `documentation.proto`, `auth.proto`, and -`annotations.proto`. - -### HTTP and REST - -The `http.proto` file contains the `Http` message (which then is wrapped -in an annotation in `annotations.proto`), which provides a specification -for REST endpoints and verbs (`GET`, `POST`, etc.) on RPC methods. -We recommend use of this annotation for describing the relationship -between RPCs and REST endpoints. - -### Documentation - -The `documentation.proto` file contains a `Documentation` message which -provides a mechanism to fully describe an API, allowing a tool to build -structured documentation artifacts. - -### Authentication - -The `auth.proto` file contains descriptions of both authentication rules -and authenticaion providers, allowing you to describe what your services -expect and accept from clients. - -## api-compiler - -Google provides a tool called [api-compiler][], which is a tool that accepts -a protocol buffer descriptor and a YAML file specifying some of the -options described in `service.proto`, and outputs a much more thorough -`Service` descriptor based on the information it infers from the protos -themselves. - - [api-compiler]: https://github.com/googleapis/api-compiler |