LI80439: EXAMPLE GENERATOR DOES NOT HONOUR SWAGGER XML TAGS IN DEFINITIONS

5.0.8.5-APIConnect-Portal-Ubuntu16-20181213-2319
5.0.8.5-APIConnect-Portal-Ubuntu16-20181213-2319.ova
APIConnect_Management_5.0.8.5_20181213-2323_1f4a906ea6b4_d559cbc.ova
APIConnect_Management_5.0.8.5_20181213-2323_1f4a906ea6b4_d559cbc.vcrypt2
apiconnect-3.0.17
microgateway-1.6.8

APAR status

• Closed as program error.

Error description

• The API Connect Explorer does not support the xml extensions in
  swagger 2.0
  
  For example with a definition like this in the API swagger yaml
  file:
  
  ---
  bookresponse:
      type: object
      properties:
        id:
          type: integer
          xml:
            name: x-id
            namespace: 'http://examplebookid.com/schema'
        title:
          type: string
          xml:
            name: x-title
        author:
          type: string
          xml:
            name: x-author
      xml:
        name: book
        prefix: bk
        namespace: 'http://examplebook.com/schema'
  ---
  
  You would expect to get a generated example such as:
  
  ---
  <bk:book xmlns:bk="http://examplebook.com/schema">
  <x-id
  xmlns="http://examplebookid.com/schema">57694004</x-id>
  <x-title>Les Miserables</x-title>
  <x-author>Victor Hugo</x-author>
  </bk:book>
  ---
  
  but instead you get :
  
  --
  <id>57694004</id>
  <title>Les Miserables</title>
  <author>Victor Hugo</author>
  ---
  

Local fix

• Use an example tag in your definition to include the expected
  xml example to be generated
  ...
        name: book
        prefix: bk
        namespace: 'http://examplebook.com/schema'
      example: "<bk:book
  xmlns:bk=\"http://examplebook.com/schema\">\n\t<x-id
  xmlns=\"http://examplebookid.com/schema\">57694004\n\t<x-
  title >Les Miserables\n\tVictor
  Hugo\n"
  

Problem summary

• The examples generated in the Developer Portal do not show xml
  extensions as expected.
  

Problem conclusion

• Fix targeted for release in v2018.4.1.1 and v5085.
  

Temporary fix

Comments

APAR Information

• APAR is sysrouted FROM one or more of the following:

• APAR is sysrouted TO one or more of the following:

Fix information

• Fixed component name

  API CONNECT ENT

• Fixed component ID

  5725Z2201

Applicable component levels

• R18X PSY

     UP