documentation-developer icon indicating copy to clipboard operation
documentation-developer copied to clipboard

REST /views enhancement: Renew examples

Open adriendupuis opened this issue 2 years ago • 1 comments

Question Answer
JIRA Ticket N/A
Versions 4.5.3
Edition All

Follow #2216, focuses on REST API Reference's examples

  • More complex examples with logical operators (a bit like in REST requests > Search (/views))
  • Make sure output examples are up to date (View.xml.v11.example had a <Result href="/content/views/view1234/results" making me think it was coming from deprecated /content/views)
  • Complete XML and JSON examples with and without version=1.1

Preview: https://ez-systems-developer-documentation--2217.com.readthedocs.build/en/2217/api/rest_api/rest_api_reference/rest_api_reference.html#searching-content-search-content

Checklist

  • [ ] Text renders correctly
  • [ ] Text has been checked with vale
  • [ ] Description metadata is up to date
  • [ ] Redirects cover removed/moved pages
  • [ ] Code samples are working
  • [ ] PHP code samples have been fixed with PHP CS fixer
  • [ ] Added link to this PR in relevant JIRA ticket or code PR

adriendupuis avatar Nov 07 '23 16:11 adriendupuis

Because it adds several examples to the same Response format, it made me discover a duplication bug fixed in #2443.

adriendupuis avatar Jul 18 '24 11:07 adriendupuis