Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add support for const keyword #1834

Open
robertadkins opened this issue Oct 14, 2023 · 8 comments · May be fixed by #1835
Open

Add support for const keyword #1834

robertadkins opened this issue Oct 14, 2023 · 8 comments · May be fixed by #1835

Comments

@robertadkins
Copy link

I have a usecase where it would be helpful to support constant values via the const keyword.

Say we have an api spec containing some models like:

{
  "components": {
    "schemas": {
      "Animal": {
        "anyOf": [
          {
            "$ref": "#/components/schemas/Dog"
          },
          {
            "$ref": "#/components/schemas/Cat"
          }
        ]
      },
      "Dog": {
        "type": "object",
        "properties": {
          "type": {
            "const": "Dog"
          },
          "isPuppy": {
            "type": "boolean",
          }
        }
      },
      "Cat": {
        "properties": {
          "type": {
            "const": "Cat"
          },
          "isKitten": {
            "type": "boolean",
          }
        }
      }
    }
  }
}

In typescript, this should map to something like:

type Animal = Dog | Cat;
type Dog = {
  type: "Dog";
  isPuppy: boolean;
};
type Cat = {
  type: "Cat";
  isKitten: boolean;
};

This way, we can narrow the type in a useful way:

function isBaby(animal: Animal): boolean {
  switch(animal.type) {
    case "Dog":
      return animal.isPuppy;
    case "Cat":
      return animal.isKitten;
  }
}

However, openapi-typescript-codegen maps const values to any types, so the type information is lost.
@robertadkins robertadkins linked a pull request Oct 14, 2023 that will close this issue
Open
@mbergen
Copy link

mbergen commented Oct 18, 2023

I don't see a spec including

"type": {
  "const": "Cat"
},

being compatible with the OpenAPI spec, where type is required to be a string.
It would be weird to deviate the codegen to something that is not following the specification it is supposed to generate from, or am i missing something?

@robertadkins
Copy link
Author

type is required to be a string.

Ah, sorry I've actually overloaded type here. In

"type": {
    "const": "Cat"
},

type is the name of a property on the Cat object. For clarity, we could give the property a different name, like id:

"id": {
    "const": "Cat"
},

The issue still applies here independent of the property name.

@mbergen
Copy link

mbergen commented Oct 19, 2023

That would still be an extension to the OpenAPI spec, or am i misunderstanding your proposal?
As an alternative, did you try to use an enum with the possible values your subclasses can have as a type to handle this?

@robertadkins
Copy link
Author

The OpenAPI spec includes the const keyword as of version 3.1 and was explicitly addressed as part of OAI/OpenAPI-Specification#1977. From the spec:

The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is a superset of the JSON Schema Specification Draft 2020-12.

For more information about the properties, see JSON Schema Core and JSON Schema Validation.

The JSON Schema Validation spec above defines the const keyword (alongside with enum and type as generic validation keywords).

Some other libraries already have support for const, e.g. openapi-typescript added support in drwpow/openapi-typescript#831.

@mbergen
Copy link

mbergen commented Oct 19, 2023

I see, i just looked at the currently supported v3.0, not at v3.1, sorry.

@robertadkins
Copy link
Author

Ah, I see! So only v3.0 is currently supported here. Any opposition to starting v3.1 support with this change? Adding const should be a non-breaking update to v3.0 parsing.

@mbergen
Copy link

mbergen commented Oct 23, 2023

I'm by no means opposed, but i'm also not the maintainer of this library.

@kovaxis kovaxis mentioned this issue Nov 6, 2023
Open
@keul
Copy link

keul commented Nov 16, 2023

This would be great, in fact this is making this generator not usable with the SpatioTemporal Asset Catalogs standard, which uses a stac_version constant

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feature: add support for constant values robertadkins/openapi-typescript-codegen
3 participants
@keul @robertadkins @mbergen