OData 4 produces invalid JSON about odata-openapi

[ralfhandl]

Both TripPinRESTierService and foo.xml work for me, using transform.cmd from a Windows command line, result is TripPinRestier.openapi3.zip

Which conversion tool did you use?

[devgoon]

I'm on Linux and I used both transform and odata2openapi and they both yielded the same results. Sent from Yahoo Mail on Android On Thu, Apr 26, 2018 at 3:37 PM, Ralf Handl<[email protected]> wrote: Both TripPinRESTierService and foo.xml work for me, using transform.cmd from a Windows command line, result is TripPinRestier.openapi3.zip foo.xml in foo.zip is identical to TripPinRestier $metadata, and it also works (no wonder :-) Which conversion tool did you use? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub, or mute the thread.

[devgoon]

I'm going to try Windows as well. Thanks for your time and help Sent from Yahoo Mail on Android On Thu, Apr 26, 2018 at 3:37 PM, Ralf Handl<[email protected]> wrote: Both TripPinRESTierService and foo.xml work for me, using transform.cmd from a Windows command line, result is TripPinRestier.openapi3.zip foo.xml in foo.zip is identical to TripPinRestier $metadata, and it also works (no wonder :-) Which conversion tool did you use? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub, or mute the thread.

[ralfhandl]

Try ./transform while in folder tools to make sure you start the right command.

[devgoon]

Switch to Windows and I can't seem to generate pretty json on any of the examples. Here are my installation steps and the results of executing People.xml. I must be missing a step somewhere, perhaps you can spot it. Note: I did not install additional tools to run transform on Windows (yet) I wanted to just run Node and see what happens.

odata-openapi3 notes

1. https://github.com/oasis-tcs/odata-openapi/blob/master/tools/README.md
2. Install node-gyp
   a. Install tools per OS
3. Install xslt4node via NPM
4. Clone https://github.com/oasis-tcs/odata-openapi.git
5. Install odata-openapi3 via NPM
6. run odata-openapi3 -drp People.xml

Results:

C:\Users\vminnocci\Documents\code\odata-openapi\examples>odata2openapi` -drp People.xml
undefined:1
{"openapi":"3.0.0","info":{"title":"OData Service for namespace PeopleService","version":"","description":"This OData service is located at http://localhost/service-root/\n\n## Entity Data Model\n\n\n## References\n- ProductService"},"servers":[{"url":"http://localhost/service-root"}],"tags":[{"name":"Suppliers"},{"name":"People"},{"name":"PersonDetails"}],"paths":{"/Suppliers":{"get":{"summary":"Get entities from Suppliers","tags":["Suppliers"],"parameters":[{"$ref":"#/components/parameters/top"},{"$ref":"#/components/parameters/skip"},{"$ref":"#/components/p

SyntaxError: Unexpected token : in JSON at position 13377
at JSON.parse ()
at xslt4node.transform (C:\Users\vminnocci\Documents\code\odata-openapi\tools\transform.js:142:66)

P.S. Not sure why it's rendering a diagram. I trying wrapping with "code", but no luck

[ralfhandl]

Should be fixed with 9b131d0, please check

[devgoon]

I'll give it a try. Thanks for you help

[devgoon]

Hello Ralf!  Thanks for the fix, unfortunately I see new errors regarding missing schemas.  On a side note we are trying to convert OData 4 metadata to OpenAPI3 json.  Is your tool in a place where we can do that?  On Wednesday, May 2, 2018, 11:46:27 AM EDT, Ralf Handl <[email protected]> wrote: Should be fixed with 9b131d0, please check — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub, or mute the thread.

[ralfhandl]

OData V4 is the preferred input format. In fact V2 and V3 require an additional transformation step to an intermediate V4 metadata file, which is done under the hood by the scripts.

[devgoon]

OK.  Here is the error I'm getting when running the attached file with the following transform.txt parse error: unallowed token at this point in JSON text                                        {"openapi":"3.0.0","info":{"ti                     (right here) ------^parse error: unallowed token at this point in JSON text                                        {"swagger":"2.0","info":{"titl                     (right here) ------^ Thanks again for your help! Ralf! On Friday, May 4, 2018, 10:06:51 AM EDT, Ralf Handl <[email protected]> wrote: OData V4 is the preferred input format. In fact V2 and V3 require an additional transformation step to an intermediate V4 metadata file, which is done under the hood by the scripts. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub, or mute the thread. # XML metadata files to transform into OpenAPI JSON # file scheme host service-root odata-version # specification example services #csdl-16.1.xml http localhost /service-root #csdl-16.2.xml http localhost /examples #ExampleService.xml http localhost /service-root #miscellaneous.xml http localhost /service-root #aggregation.xml http localhost /Sales.svc # cross-service examples #People.xml http localhost /People.svc #Products.xml http localhost /Products.svc # live services at www.odata.org #example.xml http services.odata.org /V4/OData/(S(nsga2k1tyctb0cn0ofcgcn4o))/OData.svc #Northwind.xml http services.odata.org /V4/Northwind/Northwind.svc #TripPin.xml http services.odata.org /V4/(S(cnbm44wtbc1v5bgrlek5lpcc))/TripPinServiceRW # live V2 service at www.odata.org #odata-rw-v2.xml http services.odata.org /V2/(S(j4g3x2g225evharuxieq0ay3))/OData/OData.svc V2 #Northwind-V2.xml http services.odata.org /V2/Northwind/Northwind.svc V2 # live V3 service at www.odata.org #odata-rw-v3.xml http services.odata.org /V3/(S(1urrjxgkuh4r30yqim0hqrtj))/OData/OData.svc V3 #Northwind-V3.xml http services.odata.org /V3/Northwind/Northwind.svc V3 # key-as-segment examples #Northwind-key-as-segment.xml http services.odata.org /V4/Northwind/Northwind.svc # live V4 services #graph.xml https graph.microsoft.com /v1.0 V4 qa-4-metadata.xml http localhost /test V4

[ralfhandl]

Can you please send me the metadata file, I can't find an attachment.

[devgoon]

Sorry - Here you go. On Friday, May 4, 2018, 12:10:07 PM EDT, Ralf Handl <[email protected]> wrote: Can you please send me the metadata file, I can't find an attachment. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub, or mute the thread.

[ralfhandl]

Sorry, still no attachment. Can you upload it to this issue, similar to foo.zip on the initial post on this issue?
I'll look into it on Monday.

[devgoon]

It must be a security thing.  I posted it on the #2 issue.  Have a good weekend! On Friday, May 4, 2018, 1:06:06 PM EDT, Ralf Handl <[email protected]> wrote: Sorry, still no attachment. Can you upload it to this issue, similar to foo.zip on the initial post on this issue? I'll look into it on Monday. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub, or mute the thread.

[ralfhandl]

Hi Vico,

Cause of the error was an entity set with an entity type without a key definition: neither AL7_REPORT_FORMAT nor its abstract base type REPORT_FORMAT defines a key, and REPORT_FORMAT also doesn't have a base type. Without a key you can't have an entity set in OData.

The transformation now detects and logs this modeling error and produces well-formed JSON with ERROR: neither key nor base type strings as stand-in for the missing key.

The transformation now also deals more gracefully with invalid default values: 0, 1, no, No, and Yes aren't valid default values for Edm.Boolean, only true, false, and null are allowed. In general default values have to be type-compatible, so e.g. Now isn't valid for Edm.DateTimeOffset even if it doesn't lead to XML or JSON validation errors.

Please try out 16c8114.

Thanks!
Ralf

[devgoon]

Awesome Ralf!  Sent from Yahoo Mail on Android On Sun, May 6, 2018 at 8:48 AM, Ralf Handl<[email protected]> wrote: Hi Vico, Cause of the error was an entity set with an entity type without a key definition: neither AL7_REPORT_FORMAT nor its abstract base type REPORT_FORMAT defines a key, and REPORT_FORMAT also doesn't have a base type. Without a key you can't have an entity set in OData. The transformation now detects and logs this modeling error and produces well-formed JSON with ERROR: neither key nor base type strings as stand-in for the missing key. The transformation now also deals more gracefully with invalid default values: 0, 1, no, No, and Yes aren't valid default values for Edm.Boolean, only true, false, and null are allowed. In general default values have to be type-compatible, so e.g. Now isn't valid for Edm.DateTimeOffset even if it doesn't lead to XML or JSON validation errors. Please try out 16c8114. Thanks! Ralf — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub, or mute the thread.

[devgoon]

Ralf,It looks like it generated a 3 spec file.  My next goal is to view the file in Swagger.  Do you recommend other tools for generating Swagger UI from OpenAPI3?-Vico On Sunday, May 6, 2018, 1:42:29 PM EDT, Vico Minnocci <[email protected]> wrote: Awesome Ralf!  Sent from Yahoo Mail on Android On Sun, May 6, 2018 at 8:48 AM, Ralf Handl<[email protected]> wrote: Hi Vico, Cause of the error was an entity set with an entity type without a key definition: neither AL7_REPORT_FORMAT nor its abstract base type REPORT_FORMAT defines a key, and REPORT_FORMAT also doesn't have a base type. Without a key you can't have an entity set in OData. The transformation now detects and logs this modeling error and produces well-formed JSON with ERROR: neither key nor base type strings as stand-in for the missing key. The transformation now also deals more gracefully with invalid default values: 0, 1, no, No, and Yes aren't valid default values for Edm.Boolean, only true, false, and null are allowed. In general default values have to be type-compatible, so e.g. Now isn't valid for Edm.DateTimeOffset even if it doesn't lead to XML or JSON validation errors. Please try out 16c8114. Thanks! Ralf — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub, or mute the thread.

[ralfhandl]

Swagger UI 3.x, available at https://github.com/swagger-api/swagger-ui, already supports OpenAPI 3.0.1 out of the box.

[devgoon]

Resolved. Thanks Ralf.