IT45612: ACE TOOLKIT DOES NOT ALLOW IMPORTING SWAGGER 2.0 REST API DOCUMENT IF PARAMETERS SECTION IS NOT AT THE BEGINNING OF A PATH

APAR status

• Closed as program error.

Error description

• Trying to import a Swagger 2.0 REST API Document into the ACE12
  Toolkit might throw the below Error if the parameters section is
  not at the beginning of a Path
  
  Error:
  The Operation Object for <getReq> does not contain a Parameter
  Object for <id>. The Operation Object must contain a Parameter
  Object for all of the path parameters that are defined in the
  path of the Path Object for </request/{id}>
  

Local fix

• This can be resolved by moving the 'parameters' section under a
  Path to the beginning of that Path. If the 'parameters' section
  is placed in-between Operations, the above Error is encountered.
  Another way to work around this is to move the 'parameters'
  section under each Operation in a Path
  

Problem summary

• ****************************************************************
  USERS AFFECTED:
  All Users of IBM App Connect Enterprise v12 who import Swagger
  REST API Document into ACE Toolkit
  
  
  Platforms affected:
  MultiPlatform
  
  ****************************************************************
  PROBLEM DESCRIPTION:
  Trying to import a Swagger 2.0 REST API Document into the ACE12
  Toolkit might throw the below error if the parameters section is
  not at the beginning of a Path.
  
  Error:
  The Operation Object for <> does not contain a Parameter Object
  for <>. The Operation Object must contain a Parameter Object for
  all of the path parameters that are defined in the path of the
  Path Object for <>
  
  This can be resolved by moving the "parameters" section under a
  Path to the beginning of that Path. If the "parameters" section
  is placed in-between Operations, the above error is encountered.
  For example, the below Swagger Document definition for a Path
  will throw error:
  
  paths:
    /getOrder/{id}:
      get:
        responses:
          200:
            description: "200 OK"
        operationId: "getOrder"
      parameters:
      - name: "id"
        type: "string"
        required: true
        in: "path"
      put:
        responses:
          200:
            description: "200 OK"
        operationId: "putOrder"
  
  Error - The Operation Object for 'getOrder' does not contain a
  Parameter Object for 'id'. The Operation Object must contain a
  Parameter Object for all of the path parameters that are defined
  in the path of the Path Object for '/getOrder/{id}'.
  
  However, if we move the Parameters section to the beginning of a
  Path, it should work fine. For example, the below definition
  works correctly
  
  paths:
    /getOrder/{id}:
      parameters:
      - name: "id"
        type: "string"
        required: true
        in: "path"
      get:
        responses:
          200:
            description: "200 OK"
        operationId: "getOrder"
      put:
        responses:
          200:
            description: "200 OK"
        operationId: "putOrder"
  
  Another way to work around this is to move the "parameters"
  section under each Operation in a Path. For example, the below
  definition also works correctly
  
  paths:
    /getOrder/{id}:
      get:
        responses:
          200:
            description: "200 OK"
        operationId: "getOrder"
        parameters:
        - name: "id"
          type: "string"
          required: true
          in: "path"
      put:
        responses:
          200:
            description: "200 OK"
        operationId: "putOrder"
        parameters:
        - name: "id"
          type: "string"
          required: true
          in: "path"
  

Problem conclusion

• The Product has been modified to correctly import the Swagger
  2.0 REST API Document into the Toolkit and as such the
  "parameters" section can now be placed anywhere under a
  particular Path.
  
  ---------------------------------------------------------------
  The fix is targeted for delivery in the following PTFs:
  
  Version    Maintenance Level
  v12.0      12.0.12.2
  
  The latest available maintenance can be obtained from:
  http://www-01.ibm.com/support/docview.wss?rs=849&uid=swg27006041
  
  If the maintenance level is not yet available,information on
  its planned availability can be found on:
  http://www-1.ibm.com/support/docview.wss?rs=849&uid=swg27006308
  ---------------------------------------------------------------
  

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

  APP CONN ENT TL

• Fixed component ID

  5724J0561

Applicable component levels