Springboot Archetype - YAML doesn't have definitions

[Thaxton Mauzy]

I'm really new to all of this but hopefully someone is willing to help with a small question: I'm trying to generate the maven spring-boot project from the latest archetype (found here):

$ mvn archetype:generate \ -DarchetypeGroupId=org.kie.kogito \ -DarchetypeArtifactId=kogito-spring-boot-archetype \ -DgroupId=org.acme -DartifactId=sample-kogito \ -DarchetypeVersion=1.13.0.Final \ -Dversion=1.0-SNAPSHOT

And it works fine, except that the object definitions are not included in the api-docs YAML.

But when Matteo does this in his March 2021 video, the definitions are included there on the swagger-ui.html page and I assume they are in the api-docs YAML.

I noticed he was using -DarchetypeArtifactId=kogito-springboot-archetype (no "-" between spring and boot) and Version = 2.0.0-SNAPSHOT...did something change between the Artifact Id change and the version that would cause the Definitions to not be included in the generated api-docs YAML?  I see some issues logged for something similar on the Quarkus side, but I don't see anything for the Spring-Boot side...

Thanks in advance for any help anyone can provide!  There is so much great content for Kogito - very exciting!

-Thaxton Mauzy

[Ricardo Zanini]

Hi!

What do you mean by "And it works fine, except that the object definitions are not included in the api-docs YAML."?

Can you share the generated project?

--

Zanini

--
You received this message because you are subscribed to the Google Groups "Kogito development mailing list" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kogito-developm...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/kogito-development/287d909b-87ff-48b4-a8c6-a4d489a3cdbcn%40googlegroups.com.

[Thaxton Mauzy]

Thank you so much for the response!

Here is the project generated fresh from the archetype:

https://github.com/moziator/kog-archetype-test

And here is the YAML in question that is generated by swagger:

https://github.com/moziator/kog-archetype-test/blob/main/kogito_springboot_archetype_api-docs.yml

The problem is that the $ref path for dmnDefinitions.json isn't valid, which might be an easy fix...but I would actually expect the parameters for the REST operations to be included inline in the YAML under the components heading.

Much like this YAML has a components > schema entry for input and output parameters like Quote and QuoteResponse

https://quotes.rest/yaml/theysaidso.quotes.openapi.yaml?v1.1

Does that make sense?

[Ricardo Zanini]

Thaxton,

I've tried with the latest (1.14.1), and my generated OpenAPI definition is exactly the same as yours. And the UI is working fine, with all the data structure well defined in the request form:

InputSet{

Violation*	tViolation{ Code string Date string($date) Type tViolation__TypestringEnum: Array [ 3 ] Speed Limit number Actual Speed number }
Driver*	tDriver{ Name string Age number State string City string Points number }

}

Can you please clarify when you say that the path for the schema is wrong? 

You can see the schema here: http://localhost:8080/dmnDefinitions.json#/definitions/OutputSet (just append the path in the ap URL).

I can't speak for DMN, so I'm not sure if they changed something in the Swagger generation for SB. But looking as an outsider, in this case, it seems fine to me.

@Matteo Mortari do you have any hints? :)

Cheers!

--

Zanini

To view this discussion on the web visit https://groups.google.com/d/msgid/kogito-development/30253794-074b-4217-bb42-8fb9d276dbf6n%40googlegroups.com.

[Matteo Mortari]

Hi Thaxton,

I'm a bit confused about what is allegedly "not working" please?

I've checked out your git repo also on this end, and much like Ricardo experienced, everything seems to be working as expected.

Swagger-ui working.

OpenAPI correctly generated.

$ref in OpenAPI resolving correctly per Swagger/OAS specification --please notice it is completely valid by OAS to have reference on JSON Schema such as "$ref":"/dmnDefinitions.json etc

There is nothing specific to DMN here, just standard OpenAPI (Swagger).

Maybe by "not working" you actually meant to obtain a definition more adherent to your specific use-case, expectations, completely dereferenced ?

You can achieve it via standard swagger-cli for instance by bundling and dereference

See: https://github.com/APIDevTools/swagger-cli#combine-multiple-files

It would produce as attached. Was this what you were looking for?

Please notice Swagger-UI tools and the likes, normally do these operations internally, by navigating $ref(s) per the OAS Specification, that is the reason why from your "GUI experience" it is seamless, but if you download the OAS manually you need to re-enact the same logic; the swagger-cli can be a handy tool to avoid doing those operations manually or instead of hand-coding.

Hope this helps, let us know.

MM

--

Matteo Mortari

linkedin.com/in/matteomortari

youtube.com/MatteoMortari

[francisco boato]

Hello, is it possibile to configure KOGITO to generate the code without the creation of an static resource (in this case dmnDefinitions.json) ? it could work using references (but inside the the same OpenAPi root or "main" file)  because this  auto-generated  static resource is causing some problems during deploy.

Francisco.

[Matteo Mortari]

Hi Francisco

> because this  auto-generated  static resource is causing some problems during deploy

You are likely hitting either of the problems we detected with:

https://issues.redhat.com/browse/KOGITO-6531

https://issues.redhat.com/browse/KOGITO-6538

One I already fixed and backported too, the other Toshiya has been working on it and that requires some bugfixing in the underlying Quarkus actually.

My suggestion is to use a previous Kogito+Quarkus version, or a version where the problem is solved, or apply the documented workaround from the JIRAs.

If you are using instead Kogito+SpringBoot, or you are experiencing another issue not documented in those jiras, please report the details of the issue you are facing --so we can understand more.

Hope this helps,

MM

To view this discussion on the web visit https://groups.google.com/d/msgid/kogito-development/7ceb1645-5b91-4bac-8a70-511b459234fen%40googlegroups.com.

[Thaxton Mauzy]

I just wanted to close this out and say thanks to everyone for their help! The problem ended up being an issue with the consuming application and its ability to parse a YAML. So bottom line: the Spring Boot Maven Archetype is a great place to start for a rules or process project!

Thanks,
Thaxton