Lexicon nits (Jan 2024 edition)

bnewbold commented 10 months ago

Noticed these when doing a docs/descriptions pass (https://github.com/bluesky-social/atproto/pull/2110). Maybe some of these were flagged before, or i'm confused.

[x] com.atproto.server.describeServer links: string format could be 'uri'
[x] com.atproto.sync.getRecord, commit param (CID): I think this should be DEPRECATED?
[x] app.bsky.embed.images#viewImage thumb and fullsize fields (and other image views/fields): string format could be uri
[x] com.atproto.moderation.createReport reason field missing max string size on creation, but has it in view/response?

More ambiguous:

[ ] app.bsky.actor.profile description field: would be nice if it was length 300 (not 256) for consistency with posts. We probably discussed, I think boat has probably sailed on this one.
[ ] com.atproto.sync.subscribeRepos#repoOp action field: has knownValues (create, update, delete) but not a closed set? Seems like it could be tighter.
[ ] com.atproto.repo.createRecord rkey: there is maxLength on createRecord, but not other methods. We should make this format record-key anyways, when that is ready

Some of the uri stuff was rolled up in https://github.com/bluesky-social/atproto/pull/1994, but I only hit embeds there (not feed.generator, actor.profile, or other record views with blobs).

I wasn't hunting for nits, so there might be more.

mackuba commented 9 months ago

Captain, it's 2024… 😅

bnewbold commented 9 months ago

RIP

bluesky-social / atproto