a followup PR to #24173 #24211
Conversation
There was a problem hiding this comment.
2 issues found across 183 files
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="samples/client/petstore/java/microprofile-rest-client-3.0-jackson-ignore-case/src/main/java/org/openapitools/client/api/DefaultApi.java">
<violation number="1" location="samples/client/petstore/java/microprofile-rest-client-3.0-jackson-ignore-case/src/main/java/org/openapitools/client/api/DefaultApi.java:64">
P2: The new `status` query parameter is modeled as `List<String>`, so callers can pass invalid values without compile-time checks. Modeling it as an enum list (or generated operation enum) would preserve the enum contract the sample is intended to demonstrate.</violation>
</file>
<file name="samples/client/petstore/java/microprofile-rest-client-3.0-jackson-ignore-case/docs/DefaultApi.md">
<violation number="1" location="samples/client/petstore/java/microprofile-rest-client-3.0-jackson-ignore-case/docs/DefaultApi.md:118">
P3: The `status` parameter on `poniesPost` is marked deprecated in the OpenAPI spec but the Notes column doesn't reflect it (no `[deprecated]` tag). Since this is auto-generated doc, check whether the generator template handles parameter-level `deprecated` — if not, the generated docs will silently drop this metadata and consumers won't see it.</violation>
</file>
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
| @POST | ||
|
|
||
| @Produces({ "application/json" }) | ||
| List<Pony> poniesPost(@QueryParam("status") List<String> status) throws ApiException, ProcessingException; |
There was a problem hiding this comment.
P2: The new status query parameter is modeled as List<String>, so callers can pass invalid values without compile-time checks. Modeling it as an enum list (or generated operation enum) would preserve the enum contract the sample is intended to demonstrate.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At samples/client/petstore/java/microprofile-rest-client-3.0-jackson-ignore-case/src/main/java/org/openapitools/client/api/DefaultApi.java, line 64:
<comment>The new `status` query parameter is modeled as `List<String>`, so callers can pass invalid values without compile-time checks. Modeling it as an enum list (or generated operation enum) would preserve the enum contract the sample is intended to demonstrate.</comment>
<file context>
@@ -30,19 +30,36 @@
+ @POST
+
+ @Produces({ "application/json" })
+ List<Pony> poniesPost(@QueryParam("status") List<String> status) throws ApiException, ProcessingException;
}
</file context>
|
|
||
| | Name | Type | Description | Notes | | ||
| |------------- | ------------- | ------------- | -------------| | ||
| | **status** | [**List<String>**](String.md)| Status values that need to be considered for filter | [enum: available, pending, sold] | |
There was a problem hiding this comment.
P3: The status parameter on poniesPost is marked deprecated in the OpenAPI spec but the Notes column doesn't reflect it (no [deprecated] tag). Since this is auto-generated doc, check whether the generator template handles parameter-level deprecated — if not, the generated docs will silently drop this metadata and consumers won't see it.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At samples/client/petstore/java/microprofile-rest-client-3.0-jackson-ignore-case/docs/DefaultApi.md, line 118:
<comment>The `status` parameter on `poniesPost` is marked deprecated in the OpenAPI spec but the Notes column doesn't reflect it (no `[deprecated]` tag). Since this is auto-generated doc, check whether the generator template handles parameter-level `deprecated` — if not, the generated docs will silently drop this metadata and consumers won't see it.</comment>
<file context>
@@ -65,5 +68,71 @@ No authorization required
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **status** | [**List<String>**](String.md)| Status values that need to be considered for filter | [enum: available, pending, sold] |
+
+### Return type
</file context>
a followup PR to #24173
PR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
Summary by cubic
Refocuses the MicroProfile Rest Client 3.0 Jackson sample on a minimal enum spec and expands
enum.yamlto exercise enum parameters and values. Removes legacy Petstore models/APIs from the sample and drops jersey3 builds from the JDK11 workflow.New Features
/ponieswith enum query paramstatus(form, explode=false, default, deprecated).Typeenum and extendIntegerEnum(values 1, 2, 4); updatePonymodel.DefaultApito/poniesGET/POST and switch base URL tohttp://localhost.Refactors
bin/configs/java-microprofile-rest-client-3.0-jackson-ignore-case.yamlto3_0/enum.yaml; regenerate outputs.microprofile-rest-client-3.0-jackson-ignore-case; update headers and POM description to "Sample API".samples/client/petstore/java/jersey3from the JDK11 workflow matrix.Written for commit 2cea1ae. Summary will update on new commits.