Files
rickyandClaude Opus 5.5 bffdea937c REST API v1: tokens, read endpoints, squawks, webhooks
- Personal tokens (Profile → API tokens) act as their owner; integration
  tokens (Admin → Integrations) reach chosen aircraft and scopes, and their
  writes name the person they're for (SAM-On-Behalf-Of). Tokens are stored
  hashed, shown once, revocable, with last use recorded.
- GET aircraft, components, due list, inspections, ADs, logbook entries and
  squawks; POST/PATCH squawks with external_ref links to the other system.
- Idempotency-Key for safe retries, paging, JSON errors, rate limits.
- Record history keeps the token with each change (in the hashed payload).
- Webhooks (squawk created/updated/resolved, entry signed), HMAC-signed,
  retried, never sent to the server itself; deliveries listed for admins.
- The outbound address check is shared by AirTrail and webhooks; reporting a
  squawk is announced the same way from the form and the API.
- docs/guide/api.md: the API reference.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 19:05:10 -05:00

57 lines
2.1 KiB
Ruby

# The REST API (docs/api.md): tokens, webhooks, idempotent writes, and links
# from SAM records to the other system's ids ("redmine:issue:4512").
class CreateApi < ActiveRecord::Migration[8.1]
def change
create_table :api_tokens do |t|
t.string :name, null: false
t.string :kind, null: false, default: "personal" # personal | integration
t.references :user, null: false, foreign_key: true # the owner (personal) or the admin who made it (integration)
t.string :token_digest, null: false
t.string :token_hint, null: false # the first characters, to tell tokens apart
t.json :scopes, null: false, default: []
t.json :aircraft_ids # integration: the aircraft it may reach
t.datetime :last_used_at
t.string :last_used_ip
t.datetime :revoked_at
t.timestamps
t.index :token_digest, unique: true
end
create_table :webhook_endpoints do |t|
t.references :api_token, null: false, foreign_key: true
t.string :url, null: false
t.text :secret, null: false
t.json :events, null: false, default: []
t.boolean :enabled, null: false, default: true
t.timestamps
end
create_table :webhook_deliveries do |t|
t.references :webhook_endpoint, null: false, foreign_key: true
t.string :event, null: false
t.text :payload, null: false
t.string :status, null: false, default: "pending" # pending | delivered | failed
t.integer :attempts, null: false, default: 0
t.integer :response_status
t.string :last_error
t.datetime :delivered_at
t.timestamps
t.index [ :webhook_endpoint_id, :created_at ]
end
create_table :api_idempotency_keys do |t|
t.references :api_token, null: false, foreign_key: true
t.string :key, null: false
t.string :request_digest, null: false
t.integer :response_status, null: false
t.text :response_body, null: false
t.datetime :created_at, null: false
t.index [ :api_token_id, :key ], unique: true
end
add_column :squawks, :external_ref, :string
add_index :squawks, :external_ref
add_column :record_versions, :api_token_id, :integer
end
end