rahulsmahadev commented on code in PR #17727:
URL: https://github.com/apache/iceberg/pull/17727#discussion_r4356383975
##########
open-api/rest-catalog-open-api.yaml:
##########
@@ -25,9 +25,37 @@ info:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: 0.0.1
- description:
+ description: |
Defines the specification for the first version of the REST Catalog API.
Implementations should ideally support all Iceberg table spec versions.
+
+ ## Client Identification
+
+ Clients SHOULD identify themselves to the catalog using the standard HTTP
+ `User-Agent` header (RFC 7231, Section 5.5.3). A consistent, parseable
+ format gives catalog operators usable telemetry for observability,
+ debugging, and support across the many engines and libraries that speak
+ this protocol. The recommended format is defined by the `User-Agent`
+ parameter in the components section of this document.
+
+ Client identification is advisory:
+
+ - Servers SHOULD NOT reject a request only because the header is absent,
+ incomplete, or malformed. Clients that do not send it remain fully
+ functional.
+ - The value is client-asserted and can be spoofed, so servers MUST NOT use
+ it for authentication or authorization.
+ - It is not a capability negotiation mechanism: clients do not advertise
Review Comment:
Made it precise: clients MUST NOT use the header to advertise features, and
servers MUST NOT infer from it which features a client supports. It also points
to the `endpoints` field of the config response, which is where feature support
is advertised.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
