Skip to main content

Reviewer app starter kit

This page is a starter kit, not a full reference.

Use it when you need to ship a reviewer-facing application quickly with the public AetherFS surface.

Product goal​

Ship a reviewer app that lets a reviewer:

  • pick a session from a queue
  • inspect the tree
  • read and write annotations
  • inspect health and history
  • grant or deny approval

Minimum architecture​

Use these layers:

  • your backend or frontend client calling the public HTTP API
  • your app state for queue, session detail, and selected file
  • no local mount requirement unless reviewers explicitly need Aether CLI

Core screens​

Screen 1: review queue​

Data:

  • GET /v1/sessions

Show:

  • session label or ID
  • status
  • last activity
  • health badge if available
  • whether approval is pending

Screen 2: session review page​

Data:

  • GET /v1/sessions/{sessionId}
  • GET /v1/sessions/{sessionId}/manifest
  • GET /v1/sessions/{sessionId}/annotations
  • GET /v1/sessions/{sessionId}/health

Show:

  • session metadata
  • left tree pane
  • file-focused review pane
  • annotation panel
  • approval controls

Screen 3: history panel​

Data:

  • GET /v1/sessions/{sessionId}/events

Show:

  • recent activity
  • approval-related transitions
  • file mutation history

Core actions​

Add annotation​

Route:

  • POST /v1/sessions/{sessionId}/annotations

Required user inputs:

  • file path
  • line number
  • comment

Required system input:

  • expected content hash for stale-content protection

Resolve annotation​

Route:

  • PATCH /v1/sessions/{sessionId}/annotations/{annotationId}

Request approval​

Route:

  • POST /v1/sessions/{sessionId}/request-approval

This may be initiated by your app, by automation, or by another product flow.

Grant or deny​

Routes:

  • POST /v1/sessions/{sessionId}/approvals/{approvalId}/grant
  • POST /v1/sessions/{sessionId}/approvals/{approvalId}/deny

Suggested implementation order​

  1. review queue
  2. session detail page
  3. manifest tree
  4. annotation list and creation
  5. annotation resolution
  6. approval controls
  7. health badge
  8. event history

Suggested data-fetch sequence​

When opening a session page:

  1. fetch session detail
  2. fetch manifest
  3. fetch annotations
  4. fetch health
  5. fetch recent events

This gives you a good balance between perceived speed and useful context.

Failure handling checklist​

Handle:

  • missing session
  • approval already resolved
  • annotation update on stale content
  • health unavailable or unknown

Use the public google.rpc.Status error envelope as your baseline error parser.

First release checklist​

  • queue page works
  • review page works
  • annotations can be added and resolved
  • approval grant and deny work
  • session status is visible
  • health state is visible
  • event history is visible