Skip to content

fix(122): always use full resource path for API references #343

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

fix(122): always use full resource path for API references #343

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 5 additions & 12 deletions aep/general/0122/aep.md.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,24 +147,17 @@ all data returned from the API **must** use the canonical resource path.

### Full resource paths

In most cases, resource paths are used within a single API only, or else they
are used in contexts where the owning API is clear (for example,
`string pubsub_topic`).

However, sometimes it is necessary for services to refer to resources in an
arbitrary API. In this situation, the service **should** use the _full resource
path_, a schemeless URI with the owning API's service endpoint, followed by the
relative resource path:
In most cases, resource paths are used within a single API only. However,
sometimes it is necessary for services to refer to resources in an arbitrary
API. In this situation, the service **must** use the _full resource path_, a
schemeless URI with the owning API's service endpoint, followed by the relative
resource path:

```
//apis.example.com/library/publishers/123/books/les-miserables
//apis.example.com/calendar/users/vhugo1802
```

**Note:** The full resource path **should not** be used for cross-API
references where the owning API is clear; it is only used if a field refers to
resources in multiple APIs where ambiguity is possible.

### Resource URIs

The full resource path is a schemeless URI, but slightly distinct from the full
Expand Down