A given resource must have a unique
id combination. We are designing to a UUID for
id, however, I’m starting to see that this would not be a human manageable
id in a
GET /resources/65348dfe-d875-4146-99c1-e443c0f1b955 HTTP/1.1.
The resource response would have a more human readable
resourceId in its
data.attributes.resourceId, i.e., this might be a legacy sequence number,
Maybe I’m over thinking this, but this feels like an implementation detail for me to solve, i.e., if my resource endpoint looks like
GET /resources/12345 HTTP/1.1 it’s expected of me to perform the correct fetching on the repository.
This may seem pretty basic, but with
id being top level, the examples do suggest that a
articles and an
1 results in a resource endpoint of
GET /articles/1 HTTP/1.1. I would need specific implementation details to override that assumption.
Is there an OpenAPI example out there I might review?