Skip to content

Commit 4f2fccc

Browse files
authored
Clarify service name vs endpoints (#1050)
Clarify service name vs endpoints
1 parent 63aa5ed commit 4f2fccc

1 file changed

Lines changed: 11 additions & 8 deletions

File tree

aip/general/0122.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ the leading slash:
4848
`book_id`). This field **must** apply the
4949
[`OUTPUT_ONLY`](./0203.md#output-only) field behavior classification.
5050
- Resources **may** expose a separate, system-generated unique ID field
51-
(`uid`). This field **must** apply the
51+
[(`uid`)](./0148.md#uid). This field **must** apply the
5252
[`OUTPUT_ONLY`](./0203.md#output-only) field behavior classification.
5353
- Resources **must not** expose tuples, self-links, or other forms of
5454
resource identification.
@@ -153,8 +153,8 @@ are used in contexts where the owning API is clear (for example,
153153

154154
However, sometimes it is necessary for services to refer to resources in an
155155
arbitrary API. In this situation, the service **should** use the _full resource
156-
name_, a schemeless URI with the owning API's service endpoint, followed by the
157-
relative resource name:
156+
name_, a schemeless URI with the owning [API's service name](./0009.md#api-service-name),
157+
followed by the relative resource name:
158158

159159
```
160160
//library.googleapis.com/publishers/123/books/les-miserables
@@ -168,8 +168,9 @@ resources in multiple APIs where ambiguity is possible.
168168
### Resource URIs
169169

170170
The full resource name is a schemeless URI, but slightly distinct from the full
171-
URIs we use to access a resource. The latter adds two components: the protocol
172-
(HTTPS) and the API version:
171+
URIs we use to access a resource. The latter includes the protocol
172+
(HTTPS), the API version, and the specific [service endpoint](./0009.md#api-service-endpoint)
173+
to target:
173174

174175
```
175176
https://library.googleapis.com/v1/publishers/123/books/les-miserables
@@ -182,9 +183,9 @@ surface may change between major versions, multiple major versions of the same
182183
API are expected to use the same underlying data.
183184

184185
**Note:** The correlation between the full resource name and the service's
185-
hostname is by convention. In particular, one service is able to have multiple
186-
hostnames (example use cases include regionalization or staging environments),
187-
and the full resource does not change between these.
186+
endpoint is by convention. In particular, one service is able to have multiple
187+
endpoints (example use cases include regionalization, MTLS, and private access),
188+
and the full resource name does not change between these.
188189

189190
### Fields representing resource names
190191

@@ -329,6 +330,8 @@ message Book {
329330

330331
## Changelog
331332

333+
- **2023-03-24**: Correction: full resource name contains the service name rather
334+
than the service endpoint
332335
- **2023-03-17**: Add `OUTPUT_ONLY` guidance for resource ID fields.
333336
- **2020-10-06**: Added declarative-friendly guidance, and tightened character
334337
set restrictions.

0 commit comments

Comments
 (0)