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

build(connector-corda): fix various Unresolved reference kotlin compiler errors #2878

Merged
merged 1 commit into from
Nov 14, 2023

Conversation

petermetz
Copy link
Contributor

  1. Started overriding a specific template (dataClass.mustache) in the
    main-server sub-package of the corda connector because of issues that
    are further explained here [1] and here [2].
  2. Also had to update generator configuration to specifically exclude
    spring-doc generation because it seems to be broken within the template
    as well: it does not provide updated dependencies for the grandle and
    maven manifests and so the io.swagger.core.v3:swagger-annotations package
    was missing and failing the build in a second way.
  3. The example value for the return array of ListFlowsV1Response in
    the openapi.json spec file of the corda connector was containing dollar
    signs ($) which ended up being appended to the kotlin code's annotations
    as documentation, but the dollar signs have a special meaning in kotlin
    and lead to syntax errors. Updating the examples to not have dollar signs
    in the openapi.json specification document resulted in fixing this issue.
  4. Also updated the artifact version in the openapi generator configuration
    file. This is just a temporary fix, what we really need is scripts bumping
    this up as part of the automated release process.

[1] OpenAPITools/openapi-generator#8366 (comment)
[2] OpenAPITools/openapi-generator#17008

Fixes #2662

Signed-off-by: Peter Somogyvari [email protected]

Pull Request Requirements

  • Rebased onto upstream/main branch and squashed into single commit to help maintainers review it more efficient and to avoid spaghetti git commit graphs that obfuscate which commit did exactly what change, when and, why.
  • Have git sign off at the end of commit message to avoid being marked red. You can add -s flag when using git commit command. You may refer to this link for more information.
  • Follow the Commit Linting specification. You may refer to this link for more information.

Character Limit

  • Pull Request Title and Commit Subject must not exceed 72 characters (including spaces and special characters).
  • Commit Message per line must not exceed 80 characters (including spaces and special characters).

A Must Read for Beginners
For rebasing and squashing, here's a must read guide for beginners.

Copy link
Contributor

@outSH outSH left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@jagpreetsinghsasan jagpreetsinghsasan left a comment

Choose a reason for hiding this comment

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

LGTM

…ler errors

1. Started overriding a specific template (dataClass.mustache) in the
main-server sub-package of the corda connector because of issues that
are further explained here [1] and here [2].
2. Also had to update generator configuration to specifically exclude
spring-doc generation because it seems to be broken within the template
as well: it does not provide updated dependencies for the grandle and
maven manifests and so the `io.swagger.core.v3:swagger-annotations` package
was missing and failing the build in a second way.
3. The example value for the return array of `ListFlowsV1Response` in
the openapi.json spec file of the corda connector was containing dollar
signs ($) which ended up being appended to the kotlin code's annotations
as documentation, but the dollar signs have a special meaning in kotlin
and lead to syntax errors. Updating the examples to not have dollar signs
in the openapi.json specification document resulted in fixing this issue.
4. Also updated the artifact version in the openapi generator configuration
file. This is just a temporary fix, what we really need is scripts bumping
this up as part of the automated release process.

[1] OpenAPITools/openapi-generator#8366 (comment)
[2] OpenAPITools/openapi-generator#17008

Fixes hyperledger-cacti#2662

Signed-off-by: Peter Somogyvari <[email protected]>
@petermetz petermetz merged commit 74f3292 into hyperledger-cacti:main Nov 14, 2023
39 of 69 checks passed
@petermetz petermetz deleted the petermetz/issue2662 branch November 14, 2023 07:10
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.

build(connector-corda): fix various Unresolved reference kotlin compiler errors
4 participants