fix(angular): avoid Angular type error when nullable

[soartec-lab]

Status

READY

Description

If we specify nullable: true in OpenAPI, | null" is added to the parameter type, but httpParams type in Angular doesn't support the null type.

As a result, the following type error will occur.

Type 'number | null' is not assignable to type 'string | number | boolean | readonly (string | number | boolean)[]'.

See also angular/angular#20564

So I fixed it so that it doesn't add the nullable type when the client is angular.

Related PRs

Todos

• Tests
• Documentation
• Changelog Entry (unreleased)

Steps to Test or Reproduce

Outline the steps to test or reproduce the PR here.

1. Specify nullable: true for the parameter

paths:
  /pets:
    get:
      summary: List all pets
      operationId: listPets
      tags:
        - pets
      parameters:
        - name: limit
          in: query
          description: How many items to return at one time (max 100)
          schema:
            type: integer
            nullable: true
            maximum: 100
            format: int32
      responses:
        '200':
          description: A paged array of pets
          headers:
            x-next:
              description: A link to the next page of responses
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pets'
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Pet:
      type: object
      required:
        - id
        - name
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        tag:
          type: string
    Pets:
      type: array
      maxItems: 100
      items:
        $ref: '#/components/schemas/Pet'
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string

2. specify angular to client

module.exports = {
  'petstore-file': {
    input: {
      target: './petstore.yaml',
    },
    output: {
      mode: 'tags-split',
      client: 'angular',
      target: 'src/gen/endpoints',
      schemas: 'src/gen/model',
    },
  },
};

3 execute orval

orval

4. check the generated code

Before

export type ListPetsParams = {
  /**
   * How many items to return at one time (max 100)
   */
  limit?: number | null;
};

After

export type ListPetsParams = {
  /**
   * How many items to return at one time (max 100)
   */
  limit?: number;
};

[melloware]

Ahh I read the ticket. Too bad angular has this issue to make us work around it but I understand.