Skip to content
openproduct
Search

API changelog and stability policy

The catalog is version 1.5.0. Every change to what it returns is listed here with the milestone that made it, and a test holds this list to the fields the API actually serializes.

The policy

Additive forever. A field, once published, stays. A removal is announced on this page with a date at least 90 days out, carries a Deprecation header for the whole notice period, and is marked x-deprecated in the OpenAPI document until it goes. There is no 2.0.0: a breaking change is a new path beside the old one, and the old one keeps answering for the notice period.

The notice period is the proposal on the table until the people who depend on this API say otherwise; the number here and in the OpenAPI document is one constant, so when it moves it moves everywhere at once.

The limit

Rate limited, and the limit is published: 120 requests a minute per address on the public read (`anon`); 60 requests a minute per subject on the signed-in plane (`identity`); 300 requests a minute per organisation on an organisation's maintainer routes (`org`). Each bucket refills continuously. A refused request answers 429 with a Retry-After header computed from the refill and a body naming the bucket. The count is one per key rather than one per data centre, so the number here is the number enforced.

BucketAllowsPerGuards
anon120 requests a minuteaddressthe public read
identity60 requests a minutesubjectthe signed-in plane
org300 requests a minuteorganisationan organisation's maintainer routes

A refused request is a 429 carrying Retry-After — whole seconds until the next request is yours, computed from the bucket's refill rather than a flat window — and a body naming the bucket. The table, the OpenAPI document's info and the gateway's limiter read one constant, so when a number moves it moves everywhere at once.

In notice

Nothing. No field is scheduled for removal.

The changelog

1.5.0

  • whereItRunsadded · the product document · SC1

    Where the product runs: the stage row (the stage link, what people can try, who set it and when) and the production row (the production link, live since, version, who can use it, who set it and when); each null until the product is there.

1.4.0

  • stageadded · every card · OPR2

    Whether the product is an idea or is shipping: an idea until its first milestone is marked shipped, shipping from then on.

  • tryUrladded · the product document · OPR2

    The address of the running product, as the crew declared it; null while there is nothing to try.

  • milestonesadded · the product document · OPR2

    The product's milestones in the crew's order — a short code, a title, a summary, and the moment each shipped; null until it has.

  • milestoneCountsadded · every card · OPR2

    How many of the product's milestones have shipped, and how many there are — on every card, so a list draws progress without a read per product.

  • crewCountadded · every card · OPR2

    How many people the product's page lists as its crew; null while the catalogue row predates the count.

1.3.0

  • workspaceRefadded · the product document · OPR5

    The console address of the public workspace the maintainers attested with their link grant — the door a signed-in visitor opens to read it on Orunbase; null while the listing holds no grant. Never the listing's own tenancy id.

1.2.0

  • computedAtadded · the page · OS5

    When the catalogue these cards came from was computed — the sweep materialises it every ten minutes and the page says so; null while a page is served from the live join, before the first sweep.

1.1.0

  • nextadded · the page · OS1

    The cursor for the page after this one, on every page; null on the last, never absent. The catalog is paged in its published order, and a cursor is a position in it.

  • totaladded · the page · OS1

    Every published listing, counted — a number about the catalog, never the page's length.

  • languageadded · every card · PV0

    The repository's primary language, as observed, with the moment of the read.

  • lastCommitAtadded · every card · PV0

    When the repository was last pushed to, as observed.

  • openIssuesadded · every card · PV0

    The repository's open issue count, as observed.

  • mediaadded · every card · MD0

    The listing's images in document order — an authored hero and gallery, and an observed capture that carries its moment and is withdrawn past its window.

  • pricingadded · every card · PP3

    How the maintainers describe what it costs, as one enumerated, authored value.

  • installLineadded · the product document · PV2

    One copyable install command in the maintainer's own words — always authored, never derived, one command by construction.

  • cleanVotesadded · the product document · PV3

    Whether the listing's upvotes were checked by the integrity model and almost none discounted. A boolean and never a count.

  • changesadded · the product document · PV4

    What changed on the listing in the last week, oldest snapshot to newest, each entry with its own provenance; null where there is no earlier snapshot.

  • followersadded · the product document · PP1

    How many people follow the listing.

  • launchesadded · the product document · PP5

    Every launch the listing has had, newest first, with where each placed.

1.0.0

  • productsadded · the page · AG0

    The cards of the catalog.

  • slugadded · every card · AG0

    The listing's address, and its name on every public surface.

  • taglineadded · every card · AG0

    One line in the maintainers' words.

  • categoryadded · every card · AG0

    The one category the maintainers chose, from the published vocabulary.

  • hostingadded · every card · AG0

    Where it runs, as the maintainers describe it.

  • stackadded · every card · AG0

    What it is built with, in the maintainers' own words, untouched.

  • stackCanonicaladded · every card · AG0

    The subset of the stack the vocabulary recognises — the only part a facet reads.

  • licenceadded · every card · AG0

    The repository's licence, as observed — never a maintainer's claim.

  • metricsadded · every card · AG0

    Every observed number with its window, its moment and its state; absent when nobody observed it, never zero.

  • openRolesadded · every card · AG0

    How many roles are open.

  • openingCommitmentsadded · every card · AG0

    The commitment each open role asks for, verbatim.

  • hasLiveUrladded · every card · AG0

    Whether there is something running to try. A boolean, not the address.

  • publishedAtadded · every card · AG0

    When the listing was published.

  • indexableadded · every card · AG0

    Whether the listing asks to be indexed — the sitemap and the robots directive agree with it.

  • componentsadded · the product document · AG0

    The maintainers' curated map of what the product is made of: a name and a kind, nothing more.

  • launchadded · the product document · AG0

    The listing's current or most recent launch and where it placed on its board.

  • liveUrladded · the product document · AG0

    The address the maintainers declared.

  • maintainersadded · the product document · AG0

    Who maintains it, as the maintainers published themselves.

  • openingsadded · the product document · AG0

    The open roles in full.

  • pitchadded · the product document · AG0

    The pitch, in the maintainers' words.

  • pitchDigestadded · the product document · AG0

    A digest of the pitch, so a change can be noticed without the text.

  • repoUrladded · the product document · AG0

    The repository the observed facts are read from.