Skip to content

Commit

Permalink
address review feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
parthea committed May 22, 2024
1 parent 3db4698 commit a228cba
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions aip/client-libraries/4236.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ or HTTP header `X-Goog-Api-Version`, but a request **must not** contain both.
Generated documentation for a given service **may** include the value of
`google.api.api_version`, if it exists in the source protos.

Clients must treat the value of `google.api.api_version` as opaque to ensure
robust compatibility. This means that the specific format or structure of the
version string should not be parsed or interpreted for any purpose beyond identifying
the intended API version.

## Rationale

### Necessity for Versioning
Expand All @@ -32,13 +37,11 @@ or unexpected results due to incompatible changes.

### Importance of Opaque Treatment

Clients must treat the value of `google.api.api_version` as opaque to ensure robust
compatibility. This means that the specific format or structure of the version string
should not be parsed or interpreted for any purpose beyond identifying the intended API
version. By relying on this opaque identifier, clients avoid making assumptions about the
underlying versioning scheme, which may change independently of the API itself. This
flexibility allows service providers to evolve their versioning strategies without
impacting client compatibility.
Treating the `google.api.api_version` value as opaque is important for ensuring robust
compatibility guarantees. By relying on this opaque identifier, clients avoid making
assumptions about the underlying versioning scheme, which may change independently of
the API itself. This flexibility allows service providers to evolve their versioning
strategies without impacting client compatibility.

### Mutual Exclusivity of Query and Header

Expand Down

0 comments on commit a228cba

Please sign in to comment.