Lexicon Garden

at.happyproto.registry.putStatus

Add a software.release.status record about one of the caller's projects or versions. Statuses are never edited or deleted: to cancel one, add another with status `withdrawn` that names it in `withdraws`.

Repository @happyproto.at did:plc:mo7vq4jbioxwafy5zkcc3eux namespace authority
Details · procedure
Kindprocedure
Authorityregistry.happyproto.at
Indexed

Showing version bafyreieqcghpwd5je6kc7cnnfrlp5uzhegeziezyvrsb6suvw7ydncookm. Show the latest

Compare Edit in builder → Fork →

Procedure

procedure · POST

Input

application/json

kind

string

Why, as a category a client can act on.

  • maxLength: 64
  • knownValues: security | broken | superseded

reason

string

Why, in words shown to operators.

  • maxLength: 3000
  • maxGraphemes: 300

status

requiredstring

An ECMA-428 event type. `endOfDevelopment`, `endOfSupport` and `supersededBy` deprecate the subject; `endOfDistribution` makes it unavailable; `endOfLife` retires it; `withdrawn` cancels the status named in `withdraws`.

  • maxLength: 64
  • knownValues: endOfDevelopment | endOfSupport | supersededBy | endOfDistribution | endOfLife | withdrawn

subject

requiredstring · at-uri

The caller's software.release.project or software.release.version the status is about.

supersededBy

string

Required when status is `supersededBy`: the version of the same project to use instead.

  • minLength: 1
  • maxLength: 64

withdraws

string · at-uri

Required when status is `withdrawn`: the caller's software.release.status record to cancel.

Output

application/json

cid

requiredstring · cid

uri

requiredstring · at-uri

The software.release.status written.

Errors

AuthRequired

The caller's identity could not be determined, so there is no repo to write to.

NotConfigured

The registry has no identity configured. An operator problem, not a caller's.

InvalidRecord

The input breaks a rule the registry applies, so it would refuse the records. The message names the field.

InvalidRequest

The input breaks the method's lexicon, such as a field of the wrong format or past its length, and HappyView refused it before the registry saw it. The message names the field.

Upstream

A record could not be written to the caller's repo. Records written before the failure stay, and the same call can be made again.

SubjectNotFound

The subject, or the status named in withdraws, is not an indexed record of the caller's.

InvalidStatus

The status is missing a field it requires, such as supersededBy or withdraws, or names one that is not valid.