Skip to content

Discriminator in OpenApi schema not recognized correctly #993

Closed
#1267
Closed
Discriminator in OpenApi schema not recognized correctly#993
#1267
Labels
bug 🔥Broken or incorrect behavior.important 📌This issue is important and will be addressed when capacity allows.
Milestone
Parser
@markosandalj

Description

@markosandalj
markosandalj
opened on Aug 30, 2024

Description

Given this OpenApi schema yaml

components:
  schemas:
    FrontofficePageBlock:
      oneOf:
      - $ref: '#/components/schemas/FrontofficePageBlockLinkWithIconBlockList'
      - $ref: '#/components/schemas/FrontofficePageBlockCourseListingBlock'
      discriminator:
        propertyName: type
        mapping:
          link_with_icon_list: '#/components/schemas/FrontofficePageBlockLinkWithIconBlockList'
          course_listing: '#/components/schemas/FrontofficePageBlockCourseListingBlock'
    FrontofficePageBlockCourseListingBlock:
      allOf:
      - $ref: '#/components/schemas/FrontofficePageBlockShared'
      - $ref: '#/components/schemas/CourseListingBlock'
    FrontofficePageBlockLinkWithIconBlockList:
      allOf:
      - $ref: '#/components/schemas/FrontofficePageBlockShared'
      - $ref: '#/components/schemas/LinkWithIconBlockList'
    FrontofficePageBlockShared:
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/FrontofficePageBlockSharedTypeEnum'
      required:
      - id
      - type
    FrontofficePageBlockSharedTypeEnum:
      enum:
      - link_with_icon_list
      - course_listing
      type: string

I would expect the generated types to look like this

export type FrontofficePageBlock =
	| ({ type: 'course_listing' } & FrontofficePageBlockCourseListingBlock)
	| ({ type: 'link_with_icon_list' } & FrontofficePageBlockLinkWithIconBlockList)

but this is what we are getting

export type FrontofficePageBlock = FrontofficePageBlockLinkWithIconBlockList | FrontofficePageBlockCourseListingBlock ;

export type FrontofficePageBlockCourseListingBlock = FrontofficePageBlockShared & CourseListingBlock;
export type FrontofficePageBlockLinkWithIconBlockList = FrontofficePageBlockShared & LinkWithIconBlockList;

export type FrontofficePageBlockShared = {
    id: string;
    type: FrontofficePageBlockSharedTypeEnum;
};

export enum FrontofficePageBlockSharedTypeEnum {
    LINK_WITH_ICON_LIST = 'link_with_icon_list',
    COURSE_LISTING = 'course_listing',
}

At first it seems like types are correct but when trying to narrow the block type inside a switch statement by field "type" it is impossible since each block is not strictly connected to its "type" field.

An example:

switch (block.type) {
    case FrontofficePageBlockSharedTypeEnum.COURSE_LISTING:
        // typescript doesn't recognize this as FrontofficePageBlockCourseListingBlock but as FrontofficePageBlock
        ...
        break
    case FrontofficePageBlockSharedTypeEnum.LINK_WITH_ICON_LIST:
        // typescript doesn't recognize this as FrontofficePageBlockLinkWithIconBlockList but as FrontofficePageBlock
        ...
        break
}

It seems like the generator is ignoring the discriminator field from open api schema.

Reproducible example or configuration

https://stackblitz.com/edit/hey-api-client-fetch-example-emxls6?file=src%2FApp.tsx

OpenAPI specification (optional)

openapi: 3.0.3
info:
  title: Bug API
  version: 1.0.0
  description: API endpoints for bug
components:
  schemas:
    CourseListingBlock:
      type: object
      properties:
        foo:
          type: string
        id:
          type: string
      required:
      - id
      - foo
    LinkWithIconBlockList:
      type: object
      properties:      
        bar:
          type: string    
        id:
          type: string
      required:
      - id
      - bar
    FrontofficePageBlock:
      oneOf:
      - $ref: '#/components/schemas/FrontofficePageBlockLinkWithIconBlockList'
      - $ref: '#/components/schemas/FrontofficePageBlockCourseListingBlock'
      discriminator:
        propertyName: type
        mapping:
          link_with_icon_list: '#/components/schemas/FrontofficePageBlockLinkWithIconBlockList'
          course_listing: '#/components/schemas/FrontofficePageBlockCourseListingBlock'
    FrontofficePageBlockCourseListingBlock:
      allOf:
      - $ref: '#/components/schemas/FrontofficePageBlockShared'
      - $ref: '#/components/schemas/CourseListingBlock'
    FrontofficePageBlockLinkWithIconBlockList:
      allOf:
      - $ref: '#/components/schemas/FrontofficePageBlockShared'
      - $ref: '#/components/schemas/LinkWithIconBlockList'
    FrontofficePageBlockShared:
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/FrontofficePageBlockSharedTypeEnum'
      required:
      - id
      - type
    FrontofficePageBlockSharedTypeEnum:
      enum:
      - link_with_icon_list
      - course_listing
      type: string

System information (optional)

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    bug 🔥Broken or incorrect behavior.important 📌This issue is important and will be addressed when capacity allows.

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions