LI81796: API DESIGNER GENERATES DUPLICATE ENTRIES FOR PATH PARAMETERS

APAR status

• Closed as program error.

Error description

• API Designer generates duplicate entries for path parameters
  when the same parameter is also defined the global API setup.
  Users have to manually remove the duplicate path parameters.
  This happens if you parameter declaration does not match with
  the parameter name in the definition
  Steps to reproduce:
  1- Create an API (eg: hello-world)
  2- Go to paths and add the new path with some parameter and
  operation like below
  3- Go to API Setup and create the parameter with same name as
  in path
  parameters:
    test-parameter:
      name: test-parameter
      in: query
      type: integer
      format: int32
  paths:
    /check:
      get:
        responses:
          '200':
            schema:
              type: string
            description: success
      parameters:
        - name: test-parameter
          in: query
          required: false
          type: integer
          format: int32
  4- Edit the parameter definition name in source
  parameters:
    test-parameters:
      name: test-parameter
      in: query
      type: integer
      format: int32
  paths:
    /check:
      get:
        responses:
          '200':
            schema:
              type: string
            description: success
      parameters:
        - name: test-parameter
          in: query
          required: false
          type: integer
          format: int32
  5- Editing the basepath (edit, remove the edited and save it)
  every time produce duplicates in path parameters like this
  parameters:
    test-parameters:
      name: test-parameter
      in: query
      type: integer
      format: int32
  paths:
    /check:
      get:
        responses:
          '200':
            schema:
              type: string
            description: success
      parameters:
        - name: test-parameter
          in: query
          required: false
          type: integer
          format: int32
        - name: test-parameter
          in: query
          type: integer
          format: int32
  

Local fix

• Workaround
  Manually change the declaration of the parameter definition to
  be matching the parameter name ie:
  ===
  test-parameter:
    name: test-parameter
    in: query
    type: integer
    format: int32
  =====
  

Problem summary

• <span style="background-color:rgb(255, 255, 255)">When API
  Connect users who have matching definitions for a global
  parameter and a path specific parameter change the key of the
  global parameter to be different than the parameter name, making
  changes to the draft API and saving causes duplicate entries of
  the global parameter to be added to path specific
  parameters.</span>
  

Problem conclusion

• <span style="background-color:rgb(255, 255, 255)">The issue is
  fixed in API Connect versions 2018.4.1.16 and 10.0.2. The fix
  will be included in an upcoming 10.0.1.x fixpack.</span>
  

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