Skip to content

Conversation

adriendupuis
Copy link
Contributor

@adriendupuis adriendupuis commented Mar 18, 2025

🎫 Issue IBX-9058

Related PRs:

Description:

  • Fix JSON examples (see below)
  • Add LocationQuery (which extend Query)
  • Fix typo "visibile" → "visible"
About JSON examples

In Redocly output, while XML examples are OK, JSON examples are one-lined with \n. It seems that an object example should be a YAML object, not a single JSON string. I didn't find an example: example but this is how examples: works according to specifications and https://redocly.com/learn/openapi/openapi-visual-reference/example. The fix help to have JSON well interpreted in the Redocly output, an unfoldable object easier to navigate.

Before, without the fix:
An hard to read single string (copy is OK)

After, with the fix:
An unfoldable object (copy is still OK)

For QA:

Documentation:

adamwojs and others added 2 commits March 26, 2025 13:47
Fix "json_decode expects string, string|false given."
@adriendupuis adriendupuis requested review from tischsoic and barw4 March 28, 2025 08:34
@adriendupuis adriendupuis requested a review from barw4 March 31, 2025 15:11
Copy link

Quality Gate Failed Quality Gate failed

Failed conditions
C Maintainability Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

@barw4 barw4 requested a review from a team March 31, 2025 15:15
@adamwojs adamwojs merged commit db70999 into main Apr 17, 2025
10 of 11 checks passed
@adamwojs adamwojs deleted the complete-rest-api-ref branch April 17, 2025 10:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants