Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

docs: use `apify api` as fallback for API reference CLI samples

Abierto
#2,687 2 comentarios 0 reacciones 1 asignado Ver en GitHub

Los mantenedores suelen responder en 1 día

@szaganek ya está trabajando en esto.

Desde el 30/7/2026.

Evaluación

Este issue todavía no se ha evaluado.

Descripción

documentation t-docs

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.

Lenguaje dominante
JavaScript
Estrellas
82
Forks
240
Merge medio
4 d 2 h
PR fusionados (30 d)
44

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de apify/apify-docs

Todos los issues de apify/apify-docs

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.