LI81142: OPEN API VALIDATION ERRORS OF AN API IN PORTAL EXTRA 'VALUE' GETS ADDED TO SWAGGER DEFINITION

APAR status

• Closed as program error.

Error description

• Steps to reproduce:
  
  1) import the customer yaml
  2) publish the
  API
  3) check on the portal UI --> API products
  4) select the
  product --> select the API
  5) It shows "Overview" page fine
  6)
  down load "Open API Document" --> all good
  7) navigate to any of
  the operations of API
  8) now go back to Overview page
  9) it
  shows validations error as below: https://ecurep.ibm.com/rest/do
  wnload/TS002850890/2019-10-11/swagger_definition_validation_erro
  r.pdf?fileSize=94229&clientId=ae5
  
  Open API Validation
  Errors
  The Open API document does not conform to the OAI V2.0
  specification.
  Swagger schema validation failed. Data does not
  match any schemas from 'oneOf' at #/parameters/x-requested-with
  Missing required property: schema at
  #/parameters/x-requested-with Data does not match any schemas
  from 'oneOf' at #/parameters/x-requested-with Additional
  properties not allowed: value at #/ Additional properties not
  allowed: value at #/ Additional properties not allowed: value at
  #/ Additional properties not allowed: value at #/ Data does not
  match any schemas from 'oneOf' at #/parameters/dhs-subjectIdType
  Missing required property: schema at
  #/parameters/dhs-subjectIdType Data does not match any schemas
  from 'oneOf' at #/parameters/dhs-subjectIdType Additional
  properties not allowed: value at #/ Additional properties not
  allowed: value at #/ Additional properties not allowed: value at
  #/ Additional properties not allowed: value at #/ Data does not
  match any schemas from 'oneOf' at #/parameters/dhs-productId
  Missing required property: schema at #/parameters/dhs-productId
  Data does not match any schemas from 'oneOf' at
  #/parameters/dhs-productId Additional properties not allowed:
  value at #/ Additional properties not allowed: value at #/
  Additional properties not allowed: value at #/ Additional
  properties not allowed: value at #/ Data does not match any
  schemas from 'oneOf' at #/parameters/dhs-correlationId Missing
  required property: schema at #/parameters/dhs-correlationId Data
  does not match any schemas from 'oneOf' at
  #/parameters/dhs-correlationId Additional properties not
  allowed: value at #/ Additional properties not allowed: value at
  #/ Additional properties not allowed: value at #/ Additional
  properties not allowed: value at #/ Data does not match any
  schemas from 'oneOf' at #/parameters/dhs-auditIdType Missing
  required property: schema at #/parameters/dhs-auditIdType Data
  does not match any schemas from 'oneOf' at
  #/parameters/dhs-auditIdType Additional properties not allowed:
  value at #/ Additional properties not allowed: value at #/
  Additional properties not allowed: value at #/ Additional
  properties not allowed: value at #/ Data does not match any
  schemas from 'oneOf' at #/parameters/dhs-messageId Missing
  required property: schema at #/parameters/dhs-messageId Data
  does not match any schemas from 'oneOf' at
  #/parameters/dhs-messageId Additional properties not allowed:
  value at #/ Additional properties not allowed: value at #/
  Additional properties not allowed: value at #/ Additional
  properties not allowed: value at #/ Data does not match any
  schemas from 'oneOf' at #/parameters/dhs-subjectId Missing
  required property: schema at #/parameters/dhs-subjectId Data
  does not match any schemas from 'oneOf' at
  #/parameters/dhs-subjectId Additional properties not allowed:
  value at #/ Additional properties not allowed: value at #/
  Additional properties not allowed: value at #/ Additional
  properties not allowed: value at #/ Data does not match any
  schemas from 'oneOf' at #/parameters/dhs-auditId Missing
  required property: schema at #/parameters/dhs-auditId Data does
  not match any schemas from 'oneOf' at #/parameters/dhs-auditId
  Additional properties not allowed: value at #/ Additional
  properties not allowed: value at #/ Additional properties not
  allowed: value at #/ Additional properties not allowed: value at
  #/ Data does not match any schemas from 'oneOf' at
  #/parameters/Authorization Missing required property: schema at
  #/parameters/Authorization Data does not match any schemas from
  'oneOf' at #/parameters/Authorization Additional properties not
  allowed: value at #/ Additional properties not allowed: value at
  #/ Additional properties not allowed: value at #/ Additional
  properties not allowed: value at #/
  JSON_OBJECT_VALIDATION_FAILED
  
  10) after getting below error -->
  close the validation errors
  11) down load "Open API Document"
  --> you will see below empty string: (attached download API yaml
  from portal after getting error)
   value: ' '
  for below
  parameters:
  parameters:
   - $ref: '#/parameters/Authorization'
   -
  $ref: '#/parameters/dhs-auditId'
   - $ref:
  '#/parameters/dhs-subjectId'
   - $ref:
  '#/parameters/dhs-messageId'
   - $ref:
  '#/parameters/dhs-auditIdType'
   - $ref:
  '#/parameters/dhs-correlationId'
   - $ref:
  '#/parameters/dhs-productId'
   - $ref:
  '#/parameters/dhs-subjectIdType'
   - $ref:
  '#/parameters/x-requested-with'
  

Local fix

Problem summary

• <span style="background-color:rgb(255, 255, 255)">Viewing the
  API documentation of an OAI2 api using parameter references
  shows validation errors on the overview page after viewing one
  of the operations.  An additional property field call "value" is
  added to each parameter definition in the yaml download.</span>
  

Problem conclusion

• Fix is targeted to be included in API Connect v2018.4.1.9.
  

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