Enum generation descriptions - allow for nulls/empty strings

[simon-curtis]

Changes

Expands the condition for skipping enum descriptions to also ignore null and empty strings.

Details

Since NSwag.AspNetCore v14.5, it seems that a descriptions array is always generated for enums, with null values for any undefined entries. This appears to be intended to maintain positional alignment with enum values, and there’s no built-in way to override it due to being a private field. This change ensures such null or empty entries are not appended.

I can't see anything in the spec that would suggest that null is an invalid value for a description but at the moment you get a null reference exception:

file:///D:/git/cma/main/Technical/SourceCode/TestHarness%202.0/TestHarness.UI/node_modules/openapi-typescript/dist/lib/ts.mjs:271
    " ".concat(metadata.description.trim()),
                                    ^

TypeError: Cannot read properties of null (reading 'trim')
    at tsEnumMember (file:///D:/git/cma/main/Technical/SourceCode/TestHarness%202.0/TestHarness.UI/node_modules/openapi-typescript/dist/lib/ts.mjs:271:37)

How to Review

Give it an openapi spec like this and check that the process runs to completion with no errors and that no descriptions are generated.

{
  "schemas": {
    "ProjectType": {
      "type": "integer",
      "description": "",
      "x-enumNames": [
        "Normal",
        "Snapshot"
      ],
      "x-enum-descriptions": [
        null,
        null,
      ],
      "enum": [
        0,
        1
      ]
    }
  }
}

Checklist

• Unit tests updated
• docs/ updated (if necessary)
• pnpm run update:examples run (only applicable for openapi-typescript)

[netlify]

✅ Deploy Preview for openapi-ts canceled.

Name	Link
🔨 Latest commit	e086728
🔍 Latest deploy log	https://app.netlify.com/projects/openapi-ts/deploys/6899a3a6583ddc00091ea5d9

[changeset-bot]

🦋 Changeset detected

Latest commit: e086728

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
openapi-typescript	Patch
swr-openapi	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[drwpow]

This fix looks good! Could you add a patch changeset? We could merge & release with that!

[drwpow]

Looks great, thank you!