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

REST /views enhancement: Renew examples #2217

Draft
wants to merge 11 commits into
base: master
Choose a base branch
from

Conversation

adriendupuis
Copy link
Contributor

@adriendupuis adriendupuis commented Nov 7, 2023

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 adriendupuis mentioned this pull request Nov 7, 2023
7 tasks
@adriendupuis adriendupuis changed the title ez-views.raml: Renew examples REST /views enhancement: Renew examples Nov 7, 2023
@adriendupuis adriendupuis added the Wait with merge PRs that shouldn't be merged instantly label Nov 7, 2023
Base automatically changed from enh_rest_views to master November 10, 2023 10:20
…ples

# Conflicts:
#	docs/api/rest_api/rest_api_reference/input/ibexa.raml
#	docs/api/rest_api/rest_api_reference/rest_api_reference.html
@adriendupuis
Copy link
Contributor Author

adriendupuis commented Jul 18, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Wait with merge PRs that shouldn't be merged instantly
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant