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.json が OpenAPI Specification として invaild な部分がある #13498

Open
1 task
zyoshoka opened this issue Mar 2, 2024 · 1 comment
Open
1 task
Labels
⚠️bug? This might be a bug packages/backend Server side specific issue/PR

Comments

@zyoshoka
Copy link
Contributor

zyoshoka commented Mar 2, 2024

💡 Summary

現在バックエンドの生成する OpenAPI 定義 /api.json は validate-api-json ワークフローによって validate され見かけ上通ってはいますが、ログを見ると 156 個の警告が出力されています(https://github.com/misskey-dev/misskey/actions/runs/7927440397/job/21643840936 の Validation を参照)。

これらの警告は、下記のコマンドで --extends=minimal オプションを取っ払うと153個のエラーと4個の警告に変わるため、対処すべきであると考えられます。

run: npx @redocly/cli lint --extends=minimal ./packages/backend/built/api.json

警告の殆どを占めているのは次の2つです:

(タイトルだけ見れば #10632 と同じですが内容が異なるので別で立てます)

🥰 Expected Behavior

pnpm --filter backend generate-api-json && redocly lint packages/backend/built/api.json でエラーが出ない

🤬 Actual Behavior

pnpm --filter backend generate-api-json && redocly lint packages/backend/built/api.json でエラーが出る(--extends=minimal 付きだとエラーは出ない)

📝 Steps to Reproduce

No response

💻 Frontend Environment

No response

🛰 Backend Environment (for server admin)

* Installation Method or Hosting Service:
* Misskey: 2023.3.0
* Node:
* PostgreSQL:
* Redis:
* OS and Architecture:

Do you want to address this bug yourself?

  • Yes, I will patch the bug myself and send a pull request
@zyoshoka zyoshoka added the ⚠️bug? This might be a bug label Mar 2, 2024
@zyoshoka
Copy link
Contributor Author

zyoshoka commented Mar 2, 2024

security-defined ルールのエラーは単に

security: [{
	bearerAuth: [],
}],

を追加すれば解消されるようです。

operation-operationId-unique ルールのエラーは allowGettrue なエンドポイントのみで生じているので get- / post- などの prefix をつければ直りそうです(それがベスト・プラクティスかどうかは分かりませんが…)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
⚠️bug? This might be a bug packages/backend Server side specific issue/PR
Projects
Status: Triage
Development

No branches or pull requests

2 participants