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

api-version should not cause a ChangedParameterOrder error

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

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

評価

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

調査の方向性

リポジトリで ChangedParameterOrder ルールとパラメーター参照の処理を検索し、次に issue に示されている元のパラメーターリストと更新後のパラメーターリストを比較します。ApiVersionParameter の並べ替えによってこの breaking change エラーが発生しなくなり、他のパラメーター順序の変更は引き続き検出されれば完了です。issue の例と関連するプロジェクトチェックで検証してください。

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

説明

I'm working on https://github.com/Azure/azure-rest-api-specs-pr/pull/15631 . I have 57 ChangedParameterOrder breaking change errors. Many are due to ApiVersionParameter changing order. It should be ignored by the ChangedParameterOrder rule.

ChangedParameterOrder

This is the original.

        "operationId": "Locations_CheckQuotaAvailability",
        "parameters": [
          {
            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
          },
          {
            "name": "location",
            "in": "path",
            "required": true,
            "type": "string",
            "description": "Azure region"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
          }
        ],

To:

        "operationId": "Locations_CheckQuotaAvailability",
        "parameters": [
          {
            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
          },
          {
            "name": "location",
            "in": "path",
            "description": "A location in a subscription",
            "required": true,
            "type": "string",
            "pattern": "^[-\\w\\._]+$"
          }
        ],

If I move the ApiVersionParameter in the original version to be first, the rule does not consider it breaking.

主要言語
C#
スター
290
フォーク
50
平均マージ
2日 21時間
マージ済み PR(30日)
10

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

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

Azure/openapi-diff のほかの issue

Azure/openapi-diff の issue をすべて見る

似ている issue

C# の issue をもっと見る

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

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