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

feature request: Make "Permissions" API objects consistent

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

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

評価

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

調査の方向性

まず、リンクされた操作を入口として、Set Role Permission と Create Role の API 仕様にある Permissions オブジェクトを比較します。どのフィールド名を正規のものにすべきかを判断し、その後、TypeScript の型定義と OpenAPI が生成する出力で両方のスキーマがどのように表現されているかを追跡します。API モデルが冗長なデシリアライズ処理なしに一貫した表現を使用していれば完了です。

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

説明

enhancement
What do you want to see?

There are multiple places in the API spec where an object representing a role's permissions (allowed and denied) is expressed, but I've noticed an inconsistency: Sometimes the fields are allow and deny (example: Set Role Permission), and sometimes they are a and d (example: Create Role). Could this be fixed up and unified in one way or another? It would make some API wrappers' lives easier not needing to include special JSON deserialization logic to handle the same model with differing field names, or having to include redundant model code. 😄

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

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

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

はじめの一歩

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

stoatchat/javascript-client-api のほかの issue

stoatchat/javascript-client-api の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

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

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