swagger-api/swagger-ui

XML hints in the Model view show "OrderedMap"

Open

Aperta il 28 nov 2017

Vedi su GitHub
 (24 commenti) (13 reazioni) (0 assegnatari)JavaScript (25.447 star) (8801 fork)batch import
Good first issueP2type: bugversion: 3.x

Descrizione

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.

Guida contributor

Tech stack
javascriptreact
Dominio
frontenddocumentation
Tipo issue
bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
half day
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65
Direzione di ricerca
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.