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

Updated to newer openapi-generator-cli #415

Merged
merged 2 commits into from
Oct 20, 2024
Merged

Conversation

nils-work
Copy link
Member

Added new jar and removed/replaced older jars.
Addresses #414

Added new jar and removed older jars
@nils-work nils-work modified the milestone: v1.32.0 Jul 25, 2024
@nils-work nils-work requested a review from HemangCDR July 29, 2024 08:52
Copy link
Member

@markverstege markverstege left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not approved until we review the Swagger file outputs and understand API contract impacts.

Clearly distinguishing the specific JAR versions used in each step of the build process and updated to the newer JAR for validation only.
@nils-work
Copy link
Member Author

The newer version of the openapi-generator-cli (openapi-generator-cli-6.6.0.jar) provides recommendations in relation to the validity of the spec files that were not provided by the version used in previous builds.

Examples from build logs with previous version stating No validation issues detected:

*** Input Swagger:  api/cds_dcr.json
*** Output Format:  openapi
*** Output Extension json
*** Output Dir: ../slate/source/includes/swagger
*** Checking OAS Validator ***
 No validation issues detected.spec (api/cds_dcr.json)
*** Input Swagger:  api/cds_telco.json
*** Output Format:  openapi
*** Output Extension json
*** Output Dir: ../slate/source/includes/swagger
*** Checking OAS Validator ***
 No validation issues detected.spec (api/cds_telco.json)

Examples from build logs with updated version stating [info] Spec has ... recommendation(s):

*** Input Swagger:  api/cds_dcr.json
*** Output Format:  openapi
*** Output Extension json
*** Output Dir: ../slate/source/includes/swagger
*** Checking OAS Validator ***
 [info] Spec has 1 recommendation(s).api/cds_dcr.json)

In the DCR spec., this recommendation appears to relate to the ClientRegistration definition being declared but not used (not directly referenced by an endpoint).

*** Input Swagger:  api/cds_telco.json
*** Output Format:  openapi
*** Output Extension json
*** Output Dir: ../slate/source/includes/swagger
*** Checking OAS Validator ***
 [info] Spec has 7 recommendation(s).tResponseontactson)

In the Telco spec., these recommendations appear to refer to unused definitions:

  • TelcoServiceUsageListResponse
  • TelcoServiceDetail
  • CommonPhysicalAddress
  • TelcoAccountDetailAuthorisedContacts

Validation of the OpenAPI spec. files early in the testing and build process helps to avoid redundant detail and errors at the final build stage.

@nils-work nils-work merged commit d1e525e into release/1.32.0 Oct 20, 2024
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.

4 participants