Write a guide how to implement an API Report method
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 45/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- php
- 領域
- api, documentation
調査の方向性
issue にリンクされている既存の「Exposing API Methods」ガイドから始めます。単純な配列から構築した DataTable と、フィルターでカスタマイズした既存の report を扱う例を追加し、limit、showColumns、filter_* などの DataTable クエリパラメーターがどのように適用されるかを説明します。両方の例とその根拠がドキュメント化されたら、ガイドは完了です。
索引モデルが issue の本文から書いたものです。
説明
It would be good to extend the current guide about Exposing API Methods with an example how to implement an API Report method.
Maybe one example that creates a DataTable from a simple array and runs a filter on it? The filter is maybe not needed but we should explain why not simply return the plain array: Because the dataTable allows to use all our query parameters like limit, showColumns, filter_*, ...
Then maybe another simple example that fetches an existing report, runs a filter on it to customize the report and returns it.
- 主要言語
- PHP
- スター
- 58
- フォーク
- 88
- 平均マージ
- 2日 10時間
- マージ済み PR（30日）
- 2
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
matomo-org/developer-documentation のほかの issue
-
Documentation enhancement
難易度 1/5 1〜3時間 初心者へのやさしさ 68/100
-
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
-
bug
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
-
難易度 1/5 1時間未満 初心者へのやさしさ 55/100
matomo-org/developer-documentation#806 · コメント 2 件 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
matomo-org/developer-documentation#787 · コメント 1 件 ·
matomo-org/developer-documentation の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 64/100
backdrop-contrib/paragraphs#299 ·
-
tech-debt
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
landsman/adminer-desktop#206 ·
メンテナーはふだん 1 日以内に返信
-
Explosm: Cyanide & Happiness failed with: https://explosm.net/comics/latest#comic resulted in 307オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
RSS-Bridge/rss-bridge#5154 ·
メンテナーはふだん 1 日以内に返信
-
sync-en
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
メンテナーはふだん 2 日以内に返信