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

Jump to bottom

XML hints in the Model view show "OrderedMap" #3954

Open
ponelat opened this issue Nov 28, 2017 · 9 comments
Open

XML hints in the Model view show "OrderedMap" #3954

ponelat opened this issue Nov 28, 2017 · 9 comments
Labels
Good first issue P2 type: bug version: 3.x

Comments

@ponelat
Copy link
Contributor

@ponelat ponelat commented Nov 28, 2017 •
edited

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

image
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
Copy link
Contributor

@shockey shockey commented Nov 29, 2017

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: b42e2a7

@mmamyan
Copy link

@mmamyan mmamyan commented Jan 8, 2019

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

@mmamyan
Copy link

@mmamyan mmamyan commented Jan 15, 2019

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

@bbagno
Copy link

@bbagno bbagno commented Jan 21, 2019

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

@mmamyan
Copy link

@mmamyan mmamyan commented Jan 21, 2019

@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
Copy link

@mmamyan mmamyan commented Jan 25, 2019

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

@shockey
Copy link
Contributor

@shockey shockey commented Mar 6, 2019

FYI: this is still in my work queue!

@ahoehma
Copy link

@ahoehma ahoehma commented Oct 22, 2020 •
edited

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:
image
And then I have something like this:
image

@EduardSergeev
Copy link

@EduardSergeev EduardSergeev commented Apr 21, 2021

Same problem happens with example in JSON:
image
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Good first issue P2 type: bug version: 3.x
Projects
None yet
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
7 participants
@webron @ahoehma @shockey @EduardSergeev @bbagno @ponelat @mmamyan