swagger-api/swagger-ui

XML hints in the Model view show "OrderedMap"

Open

#3954 opened on Nov 28, 2017

View on GitHub
 (24 comments) (13 reactions) (0 assignees)JavaScript (25,447 stars) (8,801 forks)batch import
Good first issueP2type: bugversion: 3.x

Description

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.

Contributor guide

Tech stack
javascriptreact
Domain
frontenddocumentation
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Investigate the Model component responsible for rendering XML hints in the Model view. The XML hint should display formatted XML like `<photoUrl></photoUrl>` but currently shows the internal Immutable.js OrderedMap representation. Locate the relevant file (likely in `src/model.js` or similar) and modify the rendering to format the XML properties properly, possibly by extracting the `name` and `wrapped` attributes from the OrderedMap and constructing a string representation.