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.

Sign up for GitHub

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

Jump to bottom

Review OpenAPI annotations in our examples for correct example value format #6040

Closed
tjquinno opened this issue Feb 1, 2023 · 0 comments · Fixed by #6782
Closed

Review OpenAPI annotations in our examples for correct example value format #6040

tjquinno opened this issue Feb 1, 2023 · 0 comments · Fixed by #6782
Assignees
@tjquinno
Labels
3.x Issues for 3.x version branch bug Something isn't working examples MP open-api P2

Comments

@tjquinno
Copy link
Member

tjquinno commented Feb 1, 2023

Environment Details

  • Helidon Version: 3.x
  • Helidon SE or Helidon MP MP
  • JDK version:
  • OS:
  • Docker version (if applicable):

Problem Description

The MP OpenAPI @ExampleObject annotation has a value attribute to show what the transmitted data should look like.

The MP OpenAPI example application in our rep shows this in plaintext but it should be expressed in JSON because that's the response format.

We need also to double-check any other uses of @ExampleObject to make sure they are correct.
@tjquinno tjquinno added bug Something isn't working MP examples open-api 3.x Issues for 3.x version branch labels Feb 1, 2023
@tjquinno tjquinno self-assigned this Feb 1, 2023
@m0mus m0mus added the P2 label Feb 6, 2023
Captain1653 added a commit to Captain1653/helidon that referenced this issue May 7, 2023
@Captain1653
[3.x]: Fix params of @ExampleObject annotation in examples (helidon-i…
299b915 
…o#6040)
@Captain1653 Captain1653 mentioned this issue May 7, 2023
Merged
1 task
tjquinno pushed a commit that referenced this issue May 8, 2023
@Captain1653
[3.x]: Fix params of @ExampleObject annotations in examples (#6040) (#…
0271285 
…6782)

* [3.x]: Fix params of @ExampleObject annotation in examples (#6040)

* Fix json syntax (#6064)
This was referenced May 9, 2023
Closed
Closed
@m0mus m0mus added this to Backlog Aug 12, 2024
@m0mus m0mus moved this to Closed in Backlog Aug 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tjquinno tjquinno

Labels
3.x Issues for 3.x version branch bug Something isn't working examples MP open-api P2
Projects
Backlog
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[3.x]: Fix params of @ExampleObject annotations in examples (#6040) Captain1653/helidon
2 participants
@m0mus @tjquinno