Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

"required": true for a property. Does the codgen support it?

オープン
#322 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
35/100
issue の種類
バグ
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
typescript
領域
devtools

調査の方向性

Start by tracing how the generator reads Schema Object properties and determines whether each TypeScript property is optional; no source file or test is named in the issue. Compare handling of the object-level required array with property-level required values, then add or update coverage so the supported behavior is explicit in the generated output.

索引モデルが issue の本文から書いたものです。

説明

I have a Schema Object

{
  "Obj": {
    "description": "Obj",
    "required": [
      "id",
      "foo"
    ],
    "properties": {
      "id": {
        "type": "string",
        "pattern": "^[0-9a-f]{32}$"
      },
      "foo": {
        "type": "string",
        "pattern": "^[0-9a-f]{32}$"
      },
      "bar": {
        "type": "string",
        "pattern": "^[0-9a-f]{32}$"
      }
    }
  }
}

With this ShemaObject, a type generates perfectly fine.

/**
 * Obj
 */
export type Obj = {
  /**
   * @pattern ^[0-9a-f]{32}$
   */
  id: string;
  /**
   * @pattern ^[0-9a-f]{32}$
   */
  foo: string;
  /**
   * @pattern ^[0-9a-f]{32}$
   */
  bar?: string;
};

But if I move/distribute required to properties like this

{
  "Obj": {
    "description": "Obj",
    "properties": {
      "id": {
        "type": "string",
        "pattern": "^[0-9a-f]{32}$",
        "required": true
      },
      "foo": {
        "type": "string",
        "pattern": "^[0-9a-f]{32}$",
        "required": true
      },
      "bar": {
        "type": "string",
        "pattern": "^[0-9a-f]{32}$"
      }
    }
  }
}

It generates this:

/**
 * Obj
 */
export type Obj = {
  /**
   * @pattern ^[0-9a-f]{32}$
   */
  id?: string;
  /**
   * @pattern ^[0-9a-f]{32}$
   */
  foo?: string;
  /**
   * @pattern ^[0-9a-f]{32}$
   */
  bar?: string;
};

Conclusion:
It ignores this approach of requiring fields if the required is set at the property level. Is it a bug? Is it possible to set up this approach?

主要言語
TypeScript
スター
634
フォーク
83
PR マージ指標
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

fabien0102/openapi-codegen のほかの issue

fabien0102/openapi-codegen の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。