Skip to content

Connect Discover: publish ecosystem docs, examples, feeds, and E2E proof #128

Description

@robinbraemer

Human need

An “open ecosystem” requires more than a public first-party webpage. Builders need a stable contract, examples, predictable limits, and evidence that their integrations will not become a second-class path.

Outcome

Publish the Connect Discover contract, integration guide, reference clients/examples, optional feed/export, service health, and cross-surface conformance suite.

Deliverables

  • Public OpenAPI source, generated reference, changelog, deprecation/version policy, and acceptable-use/rate-limit documentation.
  • Minimal curl, Java/Kotlin, Go, TypeScript/browser, and launcher-oriented examples.
  • A machine-readable taxonomy/capability reference.
  • Optional cache-friendly snapshot or signed incremental feed if measured consumers need bulk synchronization; it must contain no data beyond the public API.
  • Public API health and freshness on Minekube status.
  • Consumer conformance fixtures for pagination, filters, status freshness, compatibility, delisting, moderation, and version skew.
  • A feedback/security-reporting route for ecosystem builders.

Acceptance criteria

  • A developer with no Minekube account can discover the API, run an example, search a published endpoint, and follow pagination from public docs alone.
  • Documentation states permitted caching, attribution if any, anonymous rate limits, contact/escalation, privacy boundaries, and breaking-change guarantees.
  • Examples are executed in CI against contract fixtures and a non-production integration environment.
  • Mod, website, and Browser Hub run the same conformance corpus; a contract change cannot merge while a supported consumer breaks.
  • Status monitoring independently verifies API response shape, freshness, and a known published test record without declaring the service healthy from process uptime alone.
  • Feed/export data, if shipped, honors publish/unpublish/moderation bounds and is cryptographically integrity-checkable.
  • No example, fixture, telemetry, status probe, or support document contains real tokens, private endpoints, player identities, internal addresses, or peer/session IDs.
  • A third-party reference client successfully finds and joins/copies the dedicated E2E endpoint using only public interfaces.

Non-goals

  • A privileged automation backdoor.
  • Requiring generated Minekube libraries instead of plain HTTP.
  • Promising unlimited anonymous scraping without rate or abuse controls.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: connect-discoverOpen discovery, directory API, search, and listing surfaces for public Connect endpointsdocumentationImprovements or additions to documentationenhancementNew feature or requeststatus: researchRequires product or technical validation before implementation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions