Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

additional spec docs (Spring 2024) #299

Open
3 of 9 tasks
bnewbold opened this issue Feb 27, 2024 · 0 comments
Open
3 of 9 tasks

additional spec docs (Spring 2024) #299

bnewbold opened this issue Feb 27, 2024 · 0 comments
Labels

Comments

@bnewbold
Copy link
Contributor

bnewbold commented Feb 27, 2024

Things that are maturing and need formal write-ups in the specs:

  • Blobs: media files referenced by records, but stored and transmitted separately (short spec)
    • getBlob, uploadBlob
    • document behavior of re-uploading a blob in the same repo (HTTP status code, etc)
    • document sort-order of list blobs (?)
  • Repository Sync: how content flows though the system
    • repo event stream ("firehose"): event schemas and details
    • getRepo endpoint
    • requestCrawl / notifyOfUpdate
  • Accounts
    • account migration
    • lifecycle states
    • private settings
  • Auth
    • service auth (JWTs)
    • OAuth
  • Labels
    • schema/fields
    • negation
    • signature lifecycle (with key rotation)
    • stream format
    • HTTP header

Additions to existing specs:

  • HTTP: generic proxying to remote services, based on HTTP headers
  • Data Model: recommended limits
@bnewbold bnewbold added the specs label Feb 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant