[DOCU-2224] Confusing Example REST client configurations docs Created: 28/Jul/21  Updated: 13/Apr/22  Resolved: 13/Apr/22

Status: Closed
Project: Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Improvement Priority: Neutral
Reporter: Mikaël Geljić Assignee: Martin Drápela
Resolution: Duplicate Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Documentation page URL: https://docs.magnolia-cms.com/product-docs/6.2/Modules/List-of-modules/REST-Client-module/Example-REST-client-configurations.html

 Description   

Don't know where to start, the page seems to suffer from broken links, and/or broken snippet inclusions?

  • Not much REST Client example YAML configurations there
  • Instead, it rather shows way too much template/freemarker config (documented elsewhere anyway), whereas for this use case, the template-script snippet with restfn would suffice.
  • section 2's supposed to give an example with securityScheme? (a bearer auth would be useful actually)
  • and from there on, there are countries in JCR, fed by countries from a REST service; and the Magnolia templates consume those from JCR via a REST endpoint on the Magnolia instance (basically the instance talks to itself); one would better use plain cmsfn for that.
  • section 3: the expose note and the BookModel js snippet would suffice
  • section 4: just keep the REST Client config there? usage is similar to other sections above

Generated at Mon Feb 12 01:25:08 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.