Add openapi.json so it can be viewed by OCS-API Viewer app
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 48/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 静か
- 技術スタック
- openapi
- 領域
- api, documentation
調査の方向性
まず、Deck で利用可能な API エンドポイントを、deck.readthedocs.io にある既存の API ドキュメントおよび OCS-API Viewer アプリの要件と比較します。Deck 用の openapi.json が公開され、viewer やその他の OpenAPI ツールから利用できるようになれば完了です。
索引モデルが issue の本文から書いたものです。
説明
How to use GitHub
- Please use the 👍 reaction to show that you are affected by the same issue.
- Please don't comment if you have no relevant information to add. It's just extra noise for everyone subscribed to this issue.
- Subscribe to receive notifications on status change and new comments.
Is your feature request related to a problem? Please describe.
When using external automation tools or if you are scripting knowing API endpoints is very important. Currently, there is a quite old API documentation at https://deck.readthedocs.io/en/latest/API/ but e.g. Talk relies on the OCS-API Viewer app for Nextcloud, always displaying the latest API docs. Deck isn't available there.
Describe the solution you'd like
Publish an openapi.json which can be read by the OCS-API Viewer app.
Describe alternatives you've considered
Since I can't find any openapi.json file I can't even use other viewers. Now it's try and error with the old documentation.
Additional context
- 主要言語
- JavaScript
- スター
- 1.4k
- フォーク
- 358
- 平均マージ
- 2日 18時間
- マージ済み PR（30日）
- 83
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
nextcloud/deck のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
CSV export leaves trailing commas in tags and assigned-user fields対応中かも @Kumar-s75 が 39 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
-
Board clone API failure is treated as a successful board response対応中かも @Kumar-s75 が 39 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
nextcloud/deck#8334 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
1. to develop bug
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
nextcloud/deck#8146 · コメント 2 件 · リアクション 2 件 ·
メンテナーはふだん 1 日以内に返信
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 79/100
SACGF/variantgrid#2341 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
Unsampled pageload span is profiled when profileLifecycle is 'trace' (browser UI profiling)対応中かも @Jxxunnn が今日担当しました。 オープンBrowser Waiting for: Product Owner
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
getsentry/sentry-javascript#25497 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
external-plugin needs-review:HIGH ready-for-review
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
github/awesome-copilot#5162 · コメント 3 件 ·
メンテナーはふだん 1 日以内に返信