Lexicon Garden

com.getorbyt.getServiceInfo

What this deployment of the Orbyt service can currently do, for clients that cannot be upgraded in step with it. Clients feature-detect against `capabilities` rather than comparing version numbers: only one version of this service is ever live, while many client builds run for months. Every field is optional and the whole call is optional — a client that cannot reach it, or reads an older service that does not serve it, must behave exactly as it did before. Unauthenticated.

Repository @getorbyt.com did:plc:2xrqztnmzlckb3xfuuukupso namespace authority
Details · query
Kindquery
Authoritygetorbyt.com
Indexed
Compare Edit in builder → Fork →

Query

query · GET

Parameters

query string

platform

string

Which client is asking, so version advice can be answered for it. An unknown or absent platform is answered without version advice rather than refused.

  • knownValues: ios | web

version

string

The asking client's own version, as a semantic version. Lets the service aim `config` values at particular builds, for example to turn something off only in the builds that have a bug. Absent or unreadable is answered as if no build were targeted.

  • maxLength: 32

Output

application/json

capabilities

requiredarray

Behaviours this deployment supports, as opaque identifiers a client tests for membership of. Deliberately not `knownValues`: the whole point is that a client meets identifiers it has never heard of and ignores them. Removing one is how a feature is turned off in already-installed clients.

  • maxLength: 128
itemsstring
  • maxLength: 64

config

ref

Values the client reads instead of building them in, so they can change without a release. Absent from an older service; a client that finds it absent, or a key missing from it, keeps its built-in default.

Reference

minimumClient

string

The oldest client version this service still answers correctly for the requested platform, as a semantic version. Advisory: this service does not refuse older clients, it tells them. A client below it should prompt for an update.

  • maxLength: 32

notices

array

Messages for the viewer, such as a degraded subsystem or a scheduled maintenance window.

  • maxLength: 8
itemsref
Reference

providers

ref

Which external services this deployment is attached to, so a client can aim `atproto-proxy` at them without a release. Absent from an older service; a client that finds it absent keeps its built-in defaults.

Reference

recommendedClient

string

The newest released client version for the requested platform, so a client can offer a soft update prompt without a separate service.

  • maxLength: 32

releaseNotes

ref

What is new in the asking client's own version, for the sheet a client shows once on its first launch after an update. Present only when the request names a platform and a readable version this service has notes for. Absent from an older service; a client that finds it absent shows nothing.

Reference

#config

object

Client settings decided by the service. Every value is optional for the client: it keeps a built-in default for each key it reads and ignores keys it does not know.

Properties

values

requiredarray

Already filtered to the requesting platform and version.

  • maxLength: 64
itemsref
Reference

#configValue

object

One setting. Values are strings so new keys need no schema change; the client parses each key it reads and falls back to its default when the value does not parse.

Properties

key

requiredstring
  • maxLength: 64

value

requiredstring
  • maxLength: 256

#notice

object

One operator message. `id` is stable so a client can remember that this viewer has already dismissed it.

Properties

id

requiredstring
  • maxLength: 64

message

requiredstring
  • maxLength: 1000

severity

string

Absent means info. A severity this client does not recognise must be presented as info rather than dropped or treated as blocking.

  • knownValues: info | warning | blocking

url

string · uri

#providers

object

Service identities only, never operational endpoints. Each service field is absent when this deployment has none; for `appView` that means standard social reads are unavailable and the client should not attempt them.

Properties

appView

string

Service DID with fragment answering `app.bsky.*` reads, e.g. `did:web:api.bsky.app#bsky_appview`.

  • maxLength: 256

chat

string

Service DID with fragment for chat.

  • maxLength: 256

discoveryFeed

string · at-uri

The feed generator behind Your Mix.

discoveryFeedService

string

Service DID with fragment for `discoveryFeed`.

  • maxLength: 256

network

requiredstring

A stable label for the connected network, such as `bluesky`.

  • maxLength: 32

#releaseNote

object

One new thing: a short name and a sentence or two about it.

Properties

detail

string
  • maxLength: 500

title

requiredstring
  • maxLength: 100

#releaseNotes

object

Notes for one released client version. Written by people for people, in the service so they can be written or corrected without a release.

Properties

items

requiredarray

What is new, most important first.

  • minLength: 1
  • maxLength: 8
itemsref
Reference

version

requiredstring

The version these notes describe, as a semantic version. A client shows them only when it is its own version.

  • maxLength: 32

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • com.getorbyt.getLiveFeatures

    query

    The release features live for the viewer right now, including any the service turns on for this account before launch so it can be tested. A feature absent from the answer is off, and so is every feature when a client cannot reach this method or reads an older service that does not serve it. Anonymous callers get the features live for everyone. Never cached: the answer depends on who asks.

  • dev.knotless.describeServer

    query

    What an appview offers the clients that use it.