Generating a collection from a .yaml with deepObjects yields unexpected results

[ericdehmel]

Is there an existing issue for this?

• I have searched the tracker for existing similar issues

Describe the Issue

While generating a collection using an API specification I stumbled upon two issues with deepObjects:

• List nested inside deepObjects are generated as deepObject[list][0]=value and deepObject[list][1]=value. I would have expected it to be deepObject[list]=value,value
• If a deepObject has a property called length it will be interpreted as array and generate multiple parameters like deepObject[i] up to the number that is set as example for the length property.

Steps To Reproduce

1. Click on Import
2. Select the .yaml file:

openapi: 3.0.1
info:
  title: Demo
  version: "1.0"
paths:
  /get:
    get:
      operationId: someRequest
      parameters:
        - $ref: '#/components/parameters/DeepObjectNestedList'
        - $ref: '#/components/parameters/DeepObjectLengthParameter'
      responses:
        '200':
          description: Response on success.
components:
  parameters:
    DeepObjectNestedList:
      name: deepObjectNestedList
      in: query
      required: false
      style: deepObject
      schema:
        $ref: '#/components/schemas/DeepObjectNestedList'
      explode: true     
    DeepObjectLengthParameter:
      name: deepObjectLengthParameter
      in: query
      required: false
      style: deepObject
      schema:
        $ref: '#/components/schemas/DeepObjectLengthParameter'
      explode: true      
  schemas:
    DeepObjectLengthParameter:
      type: object
      properties:
        length:
          nullable: true
          type: integer
          format: int32
          minimum: 1
          example: 20    
    DeepObjectNestedList:
      type: object
      properties:
        nestedList:
          $ref: '#/components/schemas/NestedList'
          example: someValue,anotherValue  
    NestedList:
      nullable: true
      type: array
      items:
        type: string
        pattern: '[A-Z]{2}|[A-Z]{2}-[A-Z0-9]{1,3}'    

3. In advanced settings, use Example to generate request parameters

Screenshots or Videos

Environment Information

- Operating System: Windows 10
- Platform Type: Native App
- Postman Version: 9.14.0

Additional Context?

No response

[VShingala]

@ericdehmel Thanks for reporting the issue!

As I understand OpenAPI specification doesn't mention the behavior of array under deepObject style (source). This means currently, array is treated as an object and thus the behavior of each element is mentioned separately.

As for issue 2, Is the expected behavior to have the following key-value?

Key: deepObjectLengthParameter[length]
Value: 20

[ericdehmel]

As you have guessed I expected to get deepObjectLengthParameter[length]=20.

[VShingala]

@ericdehmel This issue should now be fixed. Feel free to reopen if you face any further problems.