Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

APIコンソールのEndpoint項目は読み取り専用であるべき #206

Open
myConsciousness opened this issue Feb 24, 2023 · 4 comments

Comments

@myConsciousness
Copy link

APIコンソールのEndpoint項目は現在ユーザーが編集できるようですが、特定のエンドポイントページから遷移した場合はこの項目は読み取り専用であるべきです。特定のエンドポイントページから遷移してきて、ユーザーがエンドポイントを編集することのメリットはないように思います。

スクリーンショット 2023-02-24 21 27 55

@rinsuki
Copy link

rinsuki commented Feb 27, 2023

notes周りではページングクエリが使い回せることがメリットになりうるかも

エンドポイントが編集不可能であることによるメリットもないのではと思います (リセットボタンくらいはあってもいいかもしれない)

@myConsciousness
Copy link
Author

@rinsuki

返信ありがとうございます。

Misskey APIのページングの仕様がまだよくわかっていないので恐縮ですけど、
少なくとも対象のエンドポイントが notes の場合は https://xxxx.io/api/notes までは不変なのではないでしょうか?

@rinsuki
Copy link

rinsuki commented Feb 27, 2023

ページングは sinceId 等で指定しますが、取得する対象がNote系であればどのAPIでもそれらの範囲指定は有効なので (というかMisskeyのID生成は時間ベースなので取得する対象が違ってもIDに含まれるタイムスタンプの部分での範囲指定は動作するはず)、HTL と STL の両方を同じ範囲指定で取得してみたいという需要がある可能性があります

@myConsciousness
Copy link
Author

@rinsuki

なるほど、ページングと経緯については理解しました。

たぶん notes/hybrid-timelinenotes/global-timeline のような扱う対象が同じでスコープが異なるエンドポイントで差分を見てみたいということだと思います。

それを聞いた上でそもそもなのですが、
このAPIコンソールは「特定のエンドポイントを実際に叩いてどういうJSONが返ってくるか」
というお試し用途以上のことを想定しているということですかね。

少なくとも今の仕様だとユーザーがエンドポイント文字列を操作できるので、
今いるエンドポイントページ以上のことができてしまうのが少し気持ち悪いと感じました。

ただその仕様を残したいということだと、
ユーザーが下手に入力した文字列をリセットするためのボタンを用意するというのも一つの手だと思いますね。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants