Skip to content

Payload/Request Examples no longer generated #444

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

Closed
bfs-natewallman opened this issue Feb 18, 2020 · 1 comment
Closed

Payload/Request Examples no longer generated #444

bfs-natewallman opened this issue Feb 18, 2020 · 1 comment
Labels
bug Something isn't working

Comments

@bfs-natewallman
Copy link

When upgrading from 1.2.28 to 1.2.31 I noticed the Example Payloads stopped being generated.

Here is psuedo code of an interface I've defined that documents an endpoint that works perfectly fine in 1.2.28 but fails in 1.2.31:

`@Tag(name = "Examples", description = "Endpoints supporting creating and managing Items")
public interface CreateItemSwaggerDefinition {

@operation(
description = "Creates a item")
@RequestBody(
description = "Details of the Item to be created",
required = true,
content = @content(
schema = @Schema(implementation = ViewModel.class),
mediaType = MediaType.APPLICATION_JSON_VALUE,
examples = {
@ExampleObject(
name = "An example request with the minimum required fields to create.",
value = Examples.MINIMUM,
summary = "Minimal request"),
@ExampleObject(
name = "An example request with all fields provided with example values.",
value = Examples.FULL,
summary = "Full request") }))
ResponseEntity create(ViewModel viewModel);
}
`

@bnasslahsen
Copy link
Collaborator

Hi @bfs-natewallman,

Thank you for your feedback.
A fix for this issue, will be available on v1.2.32.

@bnasslahsen bnasslahsen added the bug Something isn't working label Jan 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants