[Feature Request] Standardize operationIds to ensure uniqueness

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

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

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
csharp, powershell
領域
api, tooling

調査の方向性

参照されている OpenAPIService/PowershellFormatter.cs と、pull request 338 からリンクされているディスカッションを確認して、既存の operationId の規約を理解することから始めます。OData パスに対する operationIds がどこで生成されているかを追跡し、次にドキュメント検証のエントリポイントを特定します。要求された命名規則が適用され、重複する operationIds が拒否されれば完了です。

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

説明

priority:p3 type:enhancement

We should consider standardizing the naming convention of operationIds to what we currently have in DevX API (PowerShell style) - https://github.com/microsoftgraph/microsoft-graph-devx-api/blob/dev/OpenAPIService/PowershellFormatter.cs? For example:

  • Remove hash suffix values from operationIds for function all paths.
  • Add '_' to separate verb (action) in an operationId. This typically the last . or second from last . for OData cast paths.
  • PUT operations should have Set as the verb in an operationId {xxx}_Set{yyy}.

In PowerShell, we use operationIds to form command names.

As part of this exercise, we should add validation to ensure operationIds are unique for a given document.

Edit: This is a continuation of https://github.com/microsoft/OpenAPI.NET.OData/pull/338#discussion_r1097802458.

主要言語
C#
スター
240
フォーク
70
平均マージ
7時間 59分
マージ済み PR（30日）
13

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

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

はじめの一歩

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

microsoft/OpenAPI.NET.OData のほかの issue

microsoft/OpenAPI.NET.OData の issue をすべて見る

似ている issue

C# の issue をもっと見る

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

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