How do I report a bug?

Question

I think I've found a bug.In our Swagger Hub listing for our API, for “POST /v2/document”, for Properties, Parameters, Datasources, and DataSets (inside Datasources) it’s not doing the Property, … inside it for the request body as application/xml.&nbsp;For example it has:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;Properties&gt;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;Name&gt;string&lt;/Name&gt;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;Value&gt;string&lt;/Value&gt;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;/Properties&gt;&nbsp;When it should have:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;Properties&gt;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;Property&gt;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;Name&gt;string&lt;/Name&gt;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;Value&gt;string&lt;/Value&gt;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;/Property&gt;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;/Properties&gt;&nbsp;For application/json it appears to be correct (an array):&nbsp; "Properties": [&nbsp;&nbsp;&nbsp; {&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; "Name": "string",&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; "Value": "string"&nbsp;&nbsp;&nbsp; }&nbsp; ],&nbsp;Is this a bug in my yaml or a bug in SwaggerHub?&nbsp;Thanks - dave&nbsp;&nbsp;

hkosova · Accepted Answer

Hi Dave,
&nbsp;
You need to add a couple of XML-specific attributes to the schemas:
&nbsp;
1) In Template.Properties, add xml.wrapped=true:
&nbsp;
    Template:
      type: object
      properties:
        ...
        Properties:
          description: "Windward properties for this document. These override any properties set in the configuration file on the server side."
          type: array
          items:
            $ref: '#/components/schemas/Property'
          xml:
            wrapped: true
        ...
&nbsp;
&nbsp;
2) In the Property schema, add xml.name:
&nbsp;
    Property:
      type: object
      description: "A property set at the individual document generation level."
      properties:
        ...
      xml:
        name: Property
&nbsp;

davidthielen · Answer

That solved it.Out of curiosity, why is this needed? I would think it would happen automatically.thanks - dave

hkosova · Answer

Arrays are not wrapped by default, and XML element names are not inferred for singular/plural forms. This information needs to be added by using the xml keyword.
&nbsp;
For more information, please see:

"XML Object"&nbsp;section of the OpenAPI Specification
"Wrapping Arrays" section of the&nbsp;Representing XML&nbsp;guide

Forum Discussion

How do I report a bug?

3 Replies

Related Content

Flagging Known Bugs

Where do I report Testcomplete bugs?

How can I report the number of tests being blocked by a defect/bug?

Reporting a bug using the testcomplete code into the TFS

Missing 3.41 bug fixes

Recent Discussions

Help me solve this error

Adding Processing attribute to an XML spec

return multiple listings based on the criteria

How do I bypass the Available authorizations dialog?

Last-Modified header is invalid: api.swaggerhub.com