Skip to content
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.

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

Simplify: CRUDL AIPs by Teasing Out Child Collections into Separate AIP or Separate Subsections of their own Page #1286

Open
matttproud opened this issue Dec 15, 2023 · 0 comments

Comments

@matttproud
Copy link

Reviewing the various AIPs for CRUDL (resp. AIP 133, 131, 134, 135, and 132), they orient themselves around a collection of resources that live under a parent under a structure similar similar to /v1/publishers/1/books.

I think these AIPs would be better suited if their primary documentation was instead oriented around a top-level resource (e.g., /v1/books). Then, for handling resources under a collection, that could be discussed either as a separate AIP or as a dedicated subsection in each of the aforementioned AIPs.

The reason I suggest this is that putting the nested structure in the forefront of the documentation makes the overall context less accessible to new readers. Specifically, consider the example that option (google.api.http) each verb gets on the respective AIP document. It includes stringly-typed data like get: "/v1/{parent=publishers/*}/books". That's a bit of a mouthful for a newcomer to process. Something like "/v1/books" is a plain string literal that a reader does not have to interpret and connect to the sub-collection mention at the top of the AIP page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant