XML hints in the Model view show "OrderedMap"

[ponelat]

Q	A
Bug or feature request?	Bug
Which Swagger/OpenAPI version?	2.0/3.0.0 ( both )
Which Swagger-UI version?	g23fd8a4d (aka 3.5.0)
How did you install Swagger-UI?	petstore.swagger.io
Which browser & version?	Chrome 60
Which operating system?	Linux

Demonstration API definition

petstore.swagger.io ( using its default petstore 2.0 )

Expected Behavior

A UI indicating the XML behaviour that isn't a dump of the underlying immutablejs object. See screencap, look for OrderedMap

Current Behavior

Note: xml: OrderedMap { "name": "photoUrl", "wrapped": true }string]

Possible Solution

A: xml: <photoUrl></photoUrl> string] B: xml: <photoUrl> (wrapped) string]

Context

I noticed the word "OrderedMap" and realized this is a dump of the underlying immutablejs object. Its a fragile solution, affected by changes to the underlying object as well as how future versions of ImmutableJs convert to a string. If not very performant.

[shockey]

Yep, this is us not serializing the Immutable data correctly.

I wrangled something similar in extension value display ahead of v3.5.0 last week, in this commit: https://github.com/swagger-api/swagger-ui/pull/3945/commits/b42e2a7045543429fcaddc782d6103dfbabd2080

[mmamyan]

i have the same issue,, is there any solution?

[mmamyan]

@shockey help is needed. Please, look at this issue as soon as possible. Thank you.

[bbagno]

There is a workaround for the bug: pass XML you need as a string, e.g. "<tag>Quotes should be \" escaped</tag>"

[mmamyan]

@bbagno In my application i see this in the models when i add XmlAttribue, XmlElement and XmlType annotations to the properties of the model...

[mmamyan]

@shockey Can you look at this issue again? :\

[shockey]

FYI: this is still in my work queue!

[ahoehma]

I'm using springdoc-openapi 1.4.1 and I have this xml-stuff in my swagger-ui too. Any hint to ignore such internal data? In my case its the same as @mmamyan wrote. It have something todo with the Xml***annotations, I generate my classes with jaxb from xsd ... example: And then I have something like this:

[EduardSergeev]

Same problem happens with example in JSON:

[talatkuyuk]

The same, I see example: OrderedMap { ... } too, in the schema templates. It is annoyed to see the OrderedMap.

[ahoehma]

Any update here? Or hints where to look more closely? If so I could try to fix this?

Maybe this here is related to https://github.com/swagger-api/swagger-core/issues/3153 ?

[MrJuliuss]

Hi, any update ?

[MPiorunn]

Hi, any updates or ideas how to hide this?

[realjax]

I have this problem too.. is this really still a thing after 4 years??

[soma0506]

Hi, I am not sure whether this issue is fixed already , You can disabling skipOperationExample flag during openapi-generator to hide the "example: OrderedMap"

[conlaoch1]

still a problem.

[inkeytech]

Can this still be the same issue 6 years later? I'm also seeing "orderedMap" in my examples.

[C0DK]

same

[alexu-hbk]

bump

[realjax]

Someone? we are approaching the '6 year old bug, still not fixed' anniversary day rapidly!!

[Kile-Asmussen]

I'm affected by this, six year old bug.

[ahoehma]

I don't have this problem anymore. I'm using this stack:

springboot: 3.2.2 springdoc-openapi-starter-webmvc-ui: 2.3.0 springdoc-openapi-starter-webflux-ui: 2.3.0 javax.xml.bind:jaxb-api: 2.3.1 jdk17

I still generate some of my api-objects with jaxb and so there are referenced in my openapi schema ... So from my side everything is fine meanwhile :D

[cxx5208]

Hey Can you assign this to me? I will try to fix the issue Thank you