docs: use `apify api` as fallback for API reference CLI samples
メンテナーはふだん 1 日以内に返信
@szaganek がすでに取り組んでいます。
2026年7月30日 から。
評価
この issue はまだ評価されていません。
説明
The "Apify CLI" code samples in the API reference (apify-api/openapi/code_samples/curl/) currently cover only ~31 of ~131 operations. Where a dedicated CLI subcommand exists, the sample should keep using it (e.g. apify runs info <RUN ID>). For the rest, fall back to apify api, which makes an authenticated HTTP request to any endpoint:
apify api GET actor-runs/<RUN ID>
This way every endpoint gets a CLI sample without inventing subcommands.
Note: This also needs a fix in the decorator (apify-api/plugins/decorators/code-samples-decorator.mjs). It only attaches samples to an endpoint when both a JS and a CLI sample file exist - if either is missing, it skips the endpoint entirely and shows no tabs at all. That's why only ~31 endpoints currently show samples despite ~98 having a JS sample. To get full CLI coverage we either backfill a CLI sample for every endpoint, or change that logic so a missing file only drops that one tab instead of all of them.
- 主要言語
- JavaScript
- スター
- 82
- フォーク
- 240
- 平均マージ
- 3日 15時間
- マージ済み PR（30日）
- 41
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
apify/apify-docs のほかの issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
apify/apify-docs#3071 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
apify/apify-docs#3049 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
apify/apify-docs#2742 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1〜3時間 初心者へのやさしさ 82/100
apify/apify-docs#2741 ·
メンテナーはふだん 1 日以内に返信
-
low priority t-unblocking tech enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
apify/apify-docs#2451 ·
メンテナーはふだん 1 日以内に返信
apify/apify-docs の issue をすべて見る
似ている issue
-
BUG
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
メンテナーはふだん 1 日以内に返信
-
type/bug
難易度 1/5 1時間未満 初心者へのやさしさ 75/100
flarum/framework#5231 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
apache/rocketmq-dashboard#6896 ·
メンテナーはふだん 3 日以内に返信
-
bug good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
メンテナーはふだん 1 日以内に返信
-
[workshop-sync] workshop/side-quest-17-06-output-injection.md: stale add_comment.cjs line referencesオープンdocumentation
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
githubnext/gh-aw-workshop#4679 ·
メンテナーはふだん 1 日以内に返信