PH55468: The z/OS Connect build toolkit does not log errors when a Swagger document contains a Content-Type header parameter.

APAR status

• Closed as unreproducible in next release.

Error description

• When building an ARA with a Swagger document that contains a
  specification for the unsupported Authorization or Accept header
  parameters, the build toolkit outputs message BAQB0049W.
  Specifying the unsupported Content-Type header parameter does
  not issue the message and allows for the creation of an ARA
  that uses a different content type than is expected.
  
  At runtime this causes problems when a content type other than
  application/json is used and the following message is returned:
  BAQR1154E: Unsupported response media type application/json is
  returned when operation (relativePath: /.../..., method: POST)
  is invoked.
  
  Additional search words: msgBAQR1154E msgBAQR1154 BAQR1154
  zconbt msgBAQB0049W msgBAQB0049 BAQB0049
  

Local fix

• The swagger specification states that it "has special keywords
  for some headers" which include Content-Type and Accept.
  https://swagger.io/docs/specification/2-0/describing-parameters
  /#header-parameters
  Specifying these parameters is invalid and the appropriate
  Swagger keywords and definitions must be used.  For Content-Type
  parameters, the "consumes" and "produces" definitions must be
  used.
  A Swagger specification that defines a header parameter similar
  to the following example should remove the definition and add
  the appropriate keywords:
          {
             "name": "Content-Type",
             "in": "header",
             "required": true,
             "type": "string",
             "description": "Content-Types that are sent in the
  request"
           }
  
  If a Swagger specification is edited, the ARA artifact must be
  rebuilt and redeployed to the z/OS Connect server.
  

Problem summary

• ****************************************************************
  * USERS AFFECTED: All users of the z/OS Connect build toolkit. *
  ****************************************************************
  * PROBLEM DESCRIPTION: The z/OS Connect build toolkit does not *
  *                      log an error when a Content-Type header *
  *                      parameter is specified.                 *
  ****************************************************************
  The z/OS Connect build toolkit does not log an error when a
  Swagger document contains a Content-Type header parameter
  instead of the Swagger keywords "produces" and "consumes".
  

Problem conclusion

Temporary fix

Comments

• When a Swagger document contains a Content-Type header
  parameter, the following warning message will be logged by the
  build toolkit:
  BAQB0049W: Specifying a header parameter with the name
  Content-Type is not supported, the header parameter is ignored.
  
  The build toolkit level has been updated to V1.16.
  
  The fix for this APAR is expected to be delivered by the PTF for
  z/OS Connect V3.0.72.0 (PH55842).
  

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

  Z/OS CONNECT EE

• Fixed component ID

  5655CE300

Applicable component levels