OpenAPITools / OpenAPITools/openapi-generator

[BUG][Typescript-Angular] Mark properties as deprecated

Open
#17,867 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description

If a property is marked as deprecated in openapi spec, it has no effect on the generated typescript sdk. The generate model has no deprecation marker on the deprecated property. The generate model looks like:

export interface GameDto { 
    nationalLeague: boolean;
    results: boolean;
    id: number;
}
openapi-generator version

7.4.0-SNAPSHOT

OpenAPI declaration file content or url
{
  "openapi": "3.0.0",
  "info": {
    "title": "Test API",
    "version": "0.1"
  },
  "servers": [
    {
      "url": "http://test.local/api"
    }
  ],
  "paths": {
  },
  "components": {
    "schemas": {
      "GameDto": {
        "required": [
          "id",
          "results",
          "nationalLeague"
        ],
        "properties": {
          "nationalLeague": {
            "type": "boolean",
            "deprecated": true
          },
          "results": {
            "type": "boolean"
          },
          "id": {
            "type": "integer"
          }
        },
        "type": "object"
      }
    }
  }
}

Generation Details

using docker image openapitools/openapi-generator-cli

Steps to reproduce

run docker run --rm -v openapi.json:/app/openapi.json openapitools/openapi-generator-cli generate -i /app/openapi.json -g typescript-angular -o /app/ui/sdk

Related issues/PRs

https://github.com/OpenAPITools/openapi-generator/issues/15470

Suggest a fix

The generated model should look like this

export interface GameDto { 
    /** @deprecated */
    nationalLeague: boolean;
    results: boolean;
    id: number;
}

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by running the typescript-angular generator with the OpenAPI declaration and reproduction command in this issue, then inspect the generated GameDto model. The work is done when a property marked deprecated in the schema emits the requested @deprecated JSDoc marker while other properties remain unchanged.

Written by the indexing model from the issue text.

Assessment

Tech stack
angular, openapi, typescript
Domain
api, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.