pckg client contract

Platform spec feature

pckg client contract

Back to Registry client ◎ Open in platform map

Spec standingStandard

Owner

Piotr Mikstacki pmikstacki@cybernomad.it

Submitter

Piotr Mikstacki pmikstacki@cybernomad.it

Current document

ADRs (2)

1. 0001-hub-authority Hub authority Accepted

   Hub authority

   Context

   One client story.

   Decision

   Hub owns HTTP and auth.

   Consequences

   Extension defers.

   Verification anchors

   beskid_pckg; pckgClient.

   Open full ADR page

2. 0002-registry-assigned-versions Registry versions Accepted

   Registry versions

   Context

   Manual semver drift.

   Decision

   Registry-assigned publish versions in routine flows.

   Consequences

   UI shows server version.

   Verification anchors

   publish API tests.

   Open full ADR page

Articles

• Contracts and edge cases Registry client guarantees and failure modes. article Standard
• Design model Conceptual model for the Beskid pckg registry client (`beskid_pckg`). article Standard
• Examples Example `beskid pckg` invocations and configuration. article Standard
• FAQ and troubleshooting Common pckg client and registry issues. article Standard
• Flow and algorithm Pack, upload, and query flows for the pckg registry client. article Standard
• Verification and traceability Tests and traceability for the pckg client contract. article Standard

History

0 revisions (git unavailable at build; counts may be empty)

Open full history on GitHub

No commits recorded for this path.

Completeness

OKfeature · 3 SpecSection(s) · 0 H2 heading(s)

Section id	Required	Found
what-this-feature-specifies	yes	yes
implementation-anchors	yes	yes

Full tree: run pnpm verify:platform-spec-layout (writes src/generated/platform-spec-layout-report.json).

Related spec docs

• Area
  Registry client

  Parent area

• Area
  Manifests and lockfiles

  Manifest and lock operations call into registry fetch/update paths

• Area
  CLI

  CLI package commands are the primary client entrypoint

What this feature specifies

pckg client contract defines one operational contract that a newcomer can follow end-to-end: first the model, then execution flow, then strict guarantees, concrete examples, and verification guidance.

Implementation anchors

• Public client API in compiler/crates/beskid_pckg/src/lib.rs
• HTTP and auth flows in compiler/crates/beskid_pckg/src/client.rs
• CLI integration in compiler/crates/beskid_pckg/src/cli.rs
• Package dashboard behavior in pckg/src/Server/Components/Pages/Dashboard/Packages.razor.cs

Decisions

No open decisions. D-TOOL-PCKG-0001 (hub authority), 0002 (registry-assigned versions)—see adr/ and the ADRs tab.

Articles

• Hub authorityHub authority
• Contracts and edge casesRegistry client guarantees and failure modes.
• Design modelConceptual model for the Beskid pckg registry client (`beskid_pckg`).
• ExamplesExample `beskid pckg` invocations and configuration.
• FAQ and troubleshootingCommon pckg client and registry issues.
• Flow and algorithmPack, upload, and query flows for the pckg registry client.
• Verification and traceabilityTests and traceability for the pckg client contract.