BusDK Update

Bus API -providerit saavat yhtenäisen help-muodon

bus-api, bus-auth ja ensimmäiset provider-moduulit näyttävät nyt help-tekstinsä samalla rakenteella. Nimi, synopsis, kuvaus, optiot, esimerkit ja dokumentaatiolinkit löytyvät vakioiduista osioista.

Muutos on pieni mutta käytännöllinen: operaattori näkee nopeasti, onko provider itsenäinen palveluprosessi vai bus-api:n lataama moduuli, ja mihin docs- tai SDD-sivuun seuraavaksi kannattaa siirtyä.

25.4.2026bus-apiProvidersHelp output

Tiiviisti

TL;DR

bus-api näyttää komentonsa ja globaalit liput Git-tyylisinä help-osioina.
bus-api-provider-books, bus-api-provider-data, bus-api-provider-session ja bus-api-provider-auth kertovat oman provider-roolinsa samalla muodolla.
bus-auth listaa rekisteröinnin, OTP-vahvistuksen, tilakyselyn, tokenin ja admin-komennot samassa skriptikäyttöön sopivassa helpissä.
Helpissä on nyt RELATED DOCUMENTATION -osio, joka osoittaa sekä käyttäjädokumentaatioon että SDD-sivuihin.

bus-api näyttää nyt varsinaisen gateway-roolinsa, default serve -komennon ja muut alikomennot samassa helpissä:

$ bus-api --help

NAME
    bus-api - local REST JSON API gateway for BusDK workspaces

SYNOPSIS
    bus-api [global-options] [serve] [serve-options]
    bus-api [global-options] openapi
    bus-api [global-options] version

COMMANDS
    serve
        Start the API server. This is the default command.

Provider-binaarit saavat saman perusmuodon, mutta kuvaus kertoo niiden rajatun roolin. bus-api-provider-books --help sanoo suoraan, että moduuli omistaa books-domain-providerin eikä core bus-api -transporttia:

$ bus-api-provider-books --help

NAME
    bus-api-provider-books - Bus API books-domain provider module

SYNOPSIS
    bus-api-provider-books --help
    bus-api-provider-books --version

DESCRIPTION
    bus-api-provider-books owns accounting and bookkeeping provider behavior
    for the provider-based Bus API architecture.

Sama rakenne koskee data-, session- ja auth-provideria. Data-providerin kuvaus rajaa geneerisen data-facing provider -roolin, session-providerin help muistuttaa, että session lifecycle, token rotation, revocation ja introspection ovat policy context -pintaa, ja auth-providerin help näyttää suoraan vaaditut ympäristömuuttujat.

ENVIRONMENT
    BUS_AUTH_HS256_SECRET
        Required signing secret for HS256 JWTs. Use a deployment secret.

    BUS_AUTH_OTP_SENDER
        OTP sender selector. Supported values are memory, console, and smtp.

bus-auth käyttää samaa rakennetta mutta näyttää käyttäjän komentovirran. Helpissä näkyvät rekisteröinti, OTP-pyyntö, vahvistus, status, tokenin pyytäminen ja adminin waitlist-komennot samasta listasta:

COMMANDS
    register
        Register an email address for AI Platform access.

    verify
        Verify an OTP and receive an auth-service token.

    token
        Request an AI Platform JWT for an approved verified user.

Jokainen help päättyy jatkopolkuun:

RELATED DOCUMENTATION
    docs/docs/modules/bus-api-provider-session.md
    sdd/docs/modules/bus-api-provider-session.md
    sdd/docs/modules/bus-api-providers.md

Nykyinen käyttäjädokumentaatio löytyy bus-api-, bus-auth-, bus-api-provider-auth-, bus-api-provider-books-, bus-api-provider-data- ja bus-api-provider-session-sivuilta.