GlcoinCore/googleapis
1
0
Fork 0
mirror of https://github.com/googleapis/googleapis.git synced 2026-08-16 13:00:34 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
googleapis/google/api
History
Google APIs c2d28894cb feat: add BackendRule.overrides_by_request_protocol 
feat: add `api_version` extension to `ServiceOptions`, for collaborative versioning
feat: add `Publishing.rest_reference_documentation_uri` to aid client library publication
feat: add `ErrorReason.LOCATION_POLICY_VIOLATED` enum value
docs: minor tweaks to various comments

PiperOrigin-RevId: 613962944
2024-03-08 09:47:44 -08:00
..
expr chore(php): remove non-ads php_grpc_library targets 2023-05-31 11:15:12 -07:00
annotations.proto chore: start preview directory 2021-12-01 15:08:14 +00:00
auth.proto feat: add FieldInfo + extension 2023-10-03 10:57:26 -07:00
backend.proto feat: add BackendRule.overrides_by_request_protocol 2024-03-08 09:47:44 -08:00
billing.proto feat: add FieldInfo + extension 2023-10-03 10:57:26 -07:00
BUILD.bazel feat: add FieldInfo + extension 2023-10-03 10:57:26 -07:00
client.proto feat: add BackendRule.overrides_by_request_protocol 2024-03-08 09:47:44 -08:00
config_change.proto feat: add FieldInfo + extension 2023-10-03 10:57:26 -07:00
consumer.proto chore: start preview directory 2021-12-01 15:08:14 +00:00
context.proto feat: add FieldInfo + extension 2023-10-03 10:57:26 -07:00
control.proto feat: add FieldInfo + extension 2023-10-03 10:57:26 -07:00
distribution.proto feat: add FieldInfo + extension 2023-10-03 10:57:26 -07:00
documentation.proto feat: add FieldInfo + extension 2023-10-03 10:57:26 -07:00
endpoint.proto feat: add FieldInfo + extension 2023-10-03 10:57:26 -07:00
error_reason.proto feat: add FieldInfo + extension 2023-10-03 10:57:26 -07:00
field_behavior.proto chore: set packed = false on field_behavior extension 2024-02-06 09:41:16 -08:00
field_info.proto feat: add BackendRule.overrides_by_request_protocol 2024-03-08 09:47:44 -08:00
http.proto feat: add FieldInfo + extension 2023-10-03 10:57:26 -07:00
httpbody.proto feat: add FieldInfo + extension 2023-10-03 10:57:26 -07:00
label.proto feat: add FieldInfo + extension 2023-10-03 10:57:26 -07:00
launch_stage.proto feat: add FieldInfo + extension 2023-10-03 10:57:26 -07:00
log.proto feat: add FieldInfo + extension 2023-10-03 10:57:26 -07:00
logging.proto feat: add FieldInfo + extension 2023-10-03 10:57:26 -07:00
metric.proto feat: add FieldInfo + extension 2023-10-03 10:57:26 -07:00
monitored_resource.proto feat: add BackendRule.overrides_by_request_protocol 2024-03-08 09:47:44 -08:00
monitoring.proto feat: add FieldInfo + extension 2023-10-03 10:57:26 -07:00
policy.proto feat: add FieldInfo + extension 2023-10-03 10:57:26 -07:00
quota.proto feat: add FieldInfo + extension 2023-10-03 10:57:26 -07:00
README.md chore: update README files 2023-10-11 10:16:30 -07:00
resource.proto feat: add FieldInfo + extension 2023-10-03 10:57:26 -07:00
routing.proto feat: add FieldInfo + extension 2023-10-03 10:57:26 -07:00
service.proto feat: add FieldInfo + extension 2023-10-03 10:57:26 -07:00
serviceconfig.yaml feat: add FieldInfo + extension 2023-10-03 10:57:26 -07:00
source_info.proto feat: add FieldInfo + extension 2023-10-03 10:57:26 -07:00
system_parameter.proto feat: add FieldInfo + extension 2023-10-03 10:57:26 -07:00
usage.proto feat: add FieldInfo + extension 2023-10-03 10:57:26 -07:00
visibility.proto feat: add FieldInfo + extension 2023-10-03 10:57:26 -07:00

README.md

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 authentication providers, allowing you to describe what your services expect and accept from clients.