Files
fn_registry/python/functions/infra/hoppscotch_create_request.md
T
egutierrez eb8dbf66a1 feat(infra): auto-commit con 88 cambios
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-06-11 00:16:46 +02:00

5.2 KiB

name, kind, lang, domain, version, purity, signature, description, tags, uses_functions, uses_types, returns, returns_optional, error_type, imports, params, output, tested, tests, test_file_path, file_path
name kind lang domain version purity signature description tags uses_functions uses_types returns returns_optional error_type imports params output tested tests test_file_path file_path
hoppscotch_create_request function py infra 1.0.0 impure def hoppscotch_create_request(collection_id: str, method: str, url: str, *, title: str | None = None, headers: dict | None = None, body: str | None = None, body_type: str | None = None, team_id: str | None = None, access_token: str, backend_url: str = "http://localhost:3170") -> dict Crea una request REST dentro de una team collection de Hoppscotch self-hosted via la mutation GraphQL createRequestInCollection. Construye el HoppRESTRequest canonico reusando build_hoppscotch_collection del registry y lo envia como json string en el campo request del input. La mutation esta protegida por GqlAuthGuard: el JWT de sesion (de hoppscotch_login) viaja en la cookie access_token. Algunas versiones del backend exigen team_id dentro del input.
hoppscotch
flow-replay
http
infra
crud
build_hoppscotch_collection_py_infra
false error_go_core
json
requests
name desc
collection_id ID de la team collection donde insertar la request.
name desc
method metodo HTTP de la request (GET, POST, PUT, ...). Se normaliza a mayusculas por build_hoppscotch_collection.
name desc
url endpoint completo de la request (con query string si aplica).
name desc
title nombre visible de la request en la GUI de Hoppscotch. None = derivar de method + path (p.ej. 'GET /ping').
name desc
headers dict name->value de cabeceras de la request. None = sin cabeceras.
name desc
body cuerpo de la request como texto YA serializado (no se re-serializa). None = sin cuerpo.
name desc
body_type tipo de cuerpo: 'json' | 'form' | 'raw' | None. Determina el contentType del HoppRESTRequest.
name desc
team_id ID de la team duena de la collection. Requerido por las versiones del backend cuyo CreateTeamRequestInput exige teamID (el self-host de referencia lo exige). Si el backend no lo pide, None.
name desc
access_token JWT de sesion (de hoppscotch_login). Viaja en la cookie access_token, NO en el header Authorization.
name desc
backend_url base del backend Hoppscotch sin barra final. El endpoint GraphQL es {backend_url}/graphql. Default http://localhost:3170.
dict. En exito: {status: 'ok', id: str, title: str} con el ID de la request creada. En error (GraphQL errors, respuesta no JSON, sin id, o fallo de transporte): {status: 'error', error: str, data: <cuerpo GraphQL si lo hubo>}. Nunca lanza por errores de red esperables. true
test_golden_crea_request_y_devuelve_id
test_body_json_se_serializa_en_el_request
test_team_id_se_incluye_en_data
test_team_id_omitido_no_aparece_en_data
test_error_graphql_errors
python/functions/infra/hoppscotch_create_request_test.py python/functions/infra/hoppscotch_create_request.py

Ejemplo

import sys
sys.path.insert(0, "python/functions")
from infra.hoppscotch_login import hoppscotch_login
from infra.hoppscotch_create_request import hoppscotch_create_request

token = hoppscotch_login("admin@example.com")["access_token"]

# Crear una request POST con body JSON en una team collection.
result = hoppscotch_create_request(
    collection_id="cmq8lt8ta000t0xls4ddy6sdz",
    method="POST",
    url="https://api.example.com/login",
    title="Login",
    headers={"Content-Type": "application/json"},
    body='{"user":"neo","pass":"<<secret>>"}',
    body_type="json",
    team_id="cmq8kn0v500030xls1nvminjy",  # requerido por este backend
    access_token=token,
)
print(result)  # {"status": "ok", "id": "...", "title": "Login"}

Cuando usarla

Cuando el agente quiera preparar una request REST en una team Hoppscotch self-hosted via API para que el humano la vea aparecer en vivo en la GUI (las subscriptions de Hoppscotch propagan la creacion en tiempo real). Util en el patron grabar->destilar->reproducir: tras destilar un flujo a call specs, se materializan como requests dentro de una collection que el humano inspecciona. Primero obten el access_token con hoppscotch_login.

Gotchas

  • El access_token va como cookie, no como header Authorization. La mutation esta protegida por GqlAuthGuard que lee el JWT de la cookie access_token.
  • El token expira (~24h). Si la llamada devuelve un error de auth, re-loguea con hoppscotch_login.
  • request debe ser un json string de un HoppRESTRequest v:"2". No se pasa el dict directo: el campo request del input es un string. Esta funcion serializa con json.dumps el item que produce build_hoppscotch_collection.
  • team_id puede ser obligatorio. El self-host de referencia exige teamID dentro de CreateTeamRequestInput. Si lo omites contra ese backend, GraphQL responde "Field teamID of required type ID! was not provided". Pasa team_id.
  • Secreto — nunca logear el token en crudo. No imprimas access_token en claro; trata el JWT como un secreto.

Capability growth log

v1.0.0 — version inicial. CRUD validado contra el self-host vivo el 10/06/2026. Se anadio team_id opcional porque el backend de referencia exige teamID en el input.