Skip to main content

API

Documentation Map​

API

Tool / Contract Summary​

This page documents the real Loom HTTP surfaces. It separates public Loom surfaces, internal-only probes, and Fabric surfaces consumed read-only.

Business Value​

The live API posture provides:

  • a human Share UI path for operators and users
  • a repository/API path for machine interactions
  • one trusted ingress path instead of parallel public surfaces

Current Verified State​

Live now:

  • Share UI through https://<internal-runtime-redacted>/share/
  • repository/API through https://<internal-runtime-redacted>/alfresco/
  • trusted OIDC login start through auth/oidc

Available Now​

Canonical human entrypoint​

  • Route: GET /
  • Purpose: trusted public entry to Loom
  • Current behavior:
    • unauthenticated browser traffic is redirected into the OIDC bridge
    • successful login lands on Share
  • Fail / block semantics:
    • route is not green if trusted ingress or the bridge path is broken

Canonical Share UI​

  • Route: GET /share/
  • Purpose: human UI for browsing and working with content
  • Important inputs:
    • trusted browser session from the OIDC bridge
  • Important outputs:
    • Share UI pages and Share-backed content interactions
  • Fail / block semantics:
    • unauthenticated requests are redirected through the bridge login path

Canonical repository/API surface​

  • Route prefix: /alfresco/
  • Purpose: authenticated ECM and content API traffic
  • Important inputs:
    • authenticated bridge session
    • document uploads
    • metadata updates
    • search queries
    • versioning operations
  • Important outputs:
    • repository objects
    • content downloads/readback
    • search responses
    • probe responses
  • Verified live use:
    • upload
    • metadata update
    • versioned update
    • search hit
    • readback
    • rendition creation
  • Fail / block semantics:
    • unauthenticated access returns 401 after logout
    • repository readiness is not green unless search-backed readiness is green

Internal readiness probe​

  • Route:
    • /alfresco/api/-default-/public/alfresco/versions/1/probes/-ready-
  • Purpose:
    • internal repository readiness probe
  • Exposure:
    • internal or loopback validation path, not a separate public product API

Public Surfaces​

  • https://<internal-runtime-redacted>/
  • https://<internal-runtime-redacted>/share/
  • https://<internal-runtime-redacted>/alfresco/

Planned / Not in Current Scope​

  • no separate repo-owned REST facade in front of Alfresco
  • no local admission/governance API replacing Fabric
  • no repo-owned public worker/job control API

Contract Families​

The Loom repo API does not redefine Fabric contract families. Runtime-facing contract governance stays in Fabric.

Producer-/Consumer-Zuordnung​

Consumer posture:

  • Loom reads Fabric surfaces and uses them for repo validation and governance alignment

Producer posture:

  • Loom does not publish Fabric-owned shared truth from this API surface today

Fabric Surfaces​

  • GET /api/v1/contracts/docs-standard
  • GET /api/v1/contracts/matrix
  • GET /api/v1/contracts/jarvis
  • GET /api/v1/contracts/jarvis/readiness
  • GET /api/v1/contracts/registry
  • GET /api/v1/contracts/families
  • GET /api/v1/contracts/schemas
  • POST /api/v1/tools/admission/dry-run

Deployment / Verify​

python scripts/validate_live_proxy_sso_smoke.py --password <host-managed-secret> --insecure
python scripts/validate_runtime_contract.py --host <internal-runtime-redacted>
python scripts/validate_alfresco_runtime_profile.py --host <internal-runtime-redacted>

License: AGPLv3.

Helpifyr: https://helpifyr.com