Skip to content

Bridge the "docs" OpenAPI spec with the actual OpenAPI implementation #87

Description

@tadasant

Conceptually, we want:

  1. An OpenAPI spec that represents the full shape of the "registry API", including optional features like vendor-specific extensions.
  2. An OpenAPI spec that represents the official registry API, which should be a minimal subset of (1)
  3. Automated validation that (1) and (2) are in sync and correspond to what is running live in production for the official registry API

We currently have (2) defined here.

(1) is not defined anywhere, but we can probably take (2) and build off it; just need to create a copy and work off that.

We'll want to tie (2) to be directly tied to the actual Go implementation in some way (whether by test suite or some more direct generation).

We'll probably want some test suite bridging (1) and (2).

Open to other suggestions for how to codify this, if folks think OpenAPI schemas are not the best way to do this.

Activity

  1. added
    go-live blockerThis issue is one we need to address prior to initial go-live
    on May 27, 2025
  2. tadasant commented on Jun 30, 2025

    @tadasant
    MemberAuthor

    Dupe of #159

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    go-live blockerThis issue is one we need to address prior to initial go-liveimplementation workShovel-ready to write code

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions