Metadata question
- 主要言語
- Go
- スター
- 11.3k
- フォーク
- 2.5k
- 平均マージ
- 1日 20時間
- マージ済み PR(30日)
- 53
説明
I happened to be re-implementing some acceptance tests the other day and while doing so I noticed that the signatures for the actions secret functions didn't look right. Tracking this back into the OpenAPI doc shows that the 5 functions below are tracking APIs from GHES v3.7 that are no longer documented (see #4335 for my proposed fix for this specific case).
- `ActionsService.GetEnvPublicKey`
- `ActionsService.ListEnvSecrets`
- `ActionsService.GetEnvSecret`
- `ActionsService.CreateOrUpdateEnvSecret`
- `ActionsService.DeleteEnvSecret`
Looking at the OpenAPI metadata I was expecting these endpoints to be marked as deprecated, but this doesn't appear to be the case. I can also see unused endpoints from old GHES versions still in the metadata.
My primary questions are as follows:
- Should endpoints be removed once they're no longer supported by GitHub and are no longer in use (e.g. there are some projects v1 endpoints still in there)?
- Should endpoints be marked as deprecated once they're no longer supported by GitHub (e.g. deprecated or not in supported GHES versions)?
- If the endpoints were correctly marked as deprecated would this automatically mark the functions as deprecated?
- If this is the case do we have a process for updating functions that just need to change endpoint and/or signature?
コントリビューションガイド
調査の方向性
まず OpenAPI メタデータと issue に記載されている ActionsService の 5 つのメソッドを確認し、次に GHES v3.7 のドキュメントおよび #4335 で提案されている修正と比較します。エンドポイントの削除と非推奨化に関する質問に回答し、影響を受ける関数を更新するための明確なプロセスを文書化できれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- go, openapi
- 領域
- api, backend-api-design
- issue の種類
- リファクタリング
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 静か
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 35/100