plone / plone.restapi

RESTful API for Plone.
http://plonerestapi.readthedocs.org/
84 stars 73 forks source link

Is expansion an endpoint or a usage technique? #1677

Closed stevepiercy closed 11 months ago

stevepiercy commented 11 months ago

I just realized that expansion might not actually belong in Endpoints, but instead might belong in Usage, because expansion is more of technique to return a collection endpoints but is not an endpoint itself. This should be discussed with the maintainers.

Originally posted by @stevepiercy in https://github.com/plone/plone.restapi/issues/1374#issuecomment-1666430379

davisagli commented 11 months ago

@stevepiercy Yes, https://6.docs.plone.org/plone.restapi/docs/source/endpoints/expansion.html should be moved to the Usage section.

It's okay for the pages about specific endpoints to include examples of how to use them via expansion, if they support it. https://6.docs.plone.org/plone.restapi/docs/source/endpoints/navroot.html is a page that was added recently which shows how to use the endpoint both standalone and via expansion.

stevepiercy commented 11 months ago

Looking at the http request/response examples, it appears that there are currently eight components that support expansion. Is that right?

actions
aliases
breadcrumbs
contextnavigation
navigation
navroot
types
workflow
davisagli commented 11 months ago

@stevepiercy Yeah, that looks right (with the addition of translations in #1676)