bloomreach / docs-feedback

1 stars 0 forks source link

context-aware example OoB urls #107

Open ItGumby opened 2 years ago

ItGumby commented 2 years ago

https://xmdocumentation.bloomreach.com/library/concepts/rest/restful-api-support---content-context-aware-jax-rs-services.html

At the end of the page, there is a section for #scroll_6-built-in-jax-rs-components (section 6) that implies there are out-of-box components that may do some work for us. However, it doesn't provide any example URLs for leveraging those components and seeing what output they provide. Saying if you have document X at path Y, then observe built in component via URL Z.

nvankampenhout commented 2 years ago

That table refers to these Java classes:

https://github.com/bloomreach/brxm/tree/brxm-15.1.0/site-toolkit/components/jaxrs/src/main/java/org/hippoecm/hst/jaxrs/services/content

I'm not 100% sure but I think those are just provided as-is, with no out-of-the-box working example you can run. The wording on the documentation page may be a bit misleading.

Alternatively you may use the Essentials REST services setup tool to generate endpoints for your document types and look at the generated code and configuration in your project. That is probably an easier way to see a working example.

Hope this helps.