Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions _specs/introduced-pass-key/v1/api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
layout: spec
title: introduced pass key — API
nav_title: "API"
nav_order: 30
---
# API
## Overview
- Audience & usage; versioning policy

## Base Info
- **Base URL:** `https://api.example.com`
- **Auth:** Bearer / API key / OAuth2
- **Content-Type:** `application/json`
- **Rate limits / Pagination / Idempotency**
- **Webhooks** (delivery, retries, signatures)

## Errors
```json
{ "error": { "code": "RESOURCE_NOT_FOUND", "message": "…", "details": {} } }
```

## Endpoints
### GET /v1/things
- Params: `page`, `limit`
- Response:
```json
{ "items": [], "next": "…" }
```
- Sample:
```bash
curl -H "Authorization: Bearer $TOKEN" \
"https://api.example.com/v1/things?limit=20"
```

## Webhooks (if any)
- …

## SDK Mapping
- …
Empty file.
8 changes: 8 additions & 0 deletions _specs/introduced-pass-key/v1/assets/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Assets for this spec

Use this folder for diagrams, images, and attachments referenced by pages in this spec.

Suggested:
- `assets/diagrams/` — draw.io, Excalidraw, PlantUML exports, ERDs
- `assets/images/` — screenshots/static images
- `assets/attachments/` — PDFs, sheets, other binaries
18 changes: 18 additions & 0 deletions _specs/introduced-pass-key/v1/data-model.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
layout: spec
title: introduced pass key — Data Model
nav_title: "Data Model"
nav_order: 25
---
# Data Model
## ERD
- Embed from `assets/diagrams/` or link to an ERD tool export.

## Tables / Collections
- Fields, types, indexes

## Retention / Archival / PII
- Classification & masking

## Example Queries
- …
39 changes: 39 additions & 0 deletions _specs/introduced-pass-key/v1/hld.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
layout: spec
title: introduced pass key — HLD
nav_title: "High-Level Design"
nav_order: 10
---
# HLD
## Context & Goals
- …

## Architecture (diagram)
- Place diagrams under `assets/diagrams/` and embed here.

## Components
| Component | Responsibility | Runs where | Notes |
|---|---|---|---|
| | | | |

## Interactions
- Key request/response flows
- External integrations

## Non-functional Requirements
- Performance, scalability, security, observability

## Constraints & Assumptions
- …

## Alternatives Considered
- …

## Risks & Mitigations
- …

## Dependencies
- …

## Open Questions
- …
40 changes: 40 additions & 0 deletions _specs/introduced-pass-key/v1/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
layout: spec
epic: MXOP-5859
family: introduced pass key
version: v1
title: introduced pass key
status: in-progress
stage: dev
spec_version: "1.0.0"
owner: "@pranavwani"
team: ""
created_at: 2025-09-11
updated_at:
tags: []
changelog:
- date: 2025-09-11
text: "Initial scaffold from issue #57"
nav_title: "Overview"
nav_order: 0
---
## Summary
introduced pass key for desktop native

## Scope
introduced pass key

## Risks & assumptions
introduced pass key

## Related Docs
- [High-Level Design](./hld.md)
- [Low-Level Design](./lld.md)
- [API](./api.md)
- [UX](./ux.md)
- [Data Model](./data-model.md)
- [Rollout & Ops](./rollout-ops.md)
- [QA / Test Plan](./qa-test.md)

## Related Links
- _No response_
37 changes: 37 additions & 0 deletions _specs/introduced-pass-key/v1/lld.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
layout: spec
title: introduced pass key — LLD
nav_title: "Low-Level Design"
nav_order: 20
---
# LLD
## Module Breakdown
- Module A/B with public interfaces and internals

## Data Structures & Storage
- Entities/DTOs, schemas, migrations

## Algorithms & State
- Pseudocode / state machines

## Configuration
```yaml
feature_enabled: true
timeout_ms: 5000
retry: { attempts: 3 }
```

## Error Handling
- Taxonomy, retries, idempotency, backoff

## Logging & Instrumentation
- Logs, metrics (names/types/labels), tracing spans

## Security Details
- Permissions, secrets, validation

## I18n/Accessibility (if applicable)
- …

## Edge Cases
- …
21 changes: 21 additions & 0 deletions _specs/introduced-pass-key/v1/qa-test.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
layout: spec
title: introduced pass key — QA / Test Plan
nav_title: "QA / Test Plan"
nav_order: 60
---
# QA / Test Plan
## Strategy
- Unit / integration / E2E

## Coverage vs Acceptance Criteria
- Trace each AC to tests

## Test Data & Environments
- …

## Performance / Security / UAT
- …

## Sign-off Checklist
- …
18 changes: 18 additions & 0 deletions _specs/introduced-pass-key/v1/rollout-ops.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
layout: spec
title: introduced pass key — Rollout & Ops
nav_title: "Rollout & Ops"
nav_order: 50
---
# Rollout & Ops
## Launch Plan
- Flags/config, migrations/backfill, rollback

## Monitoring & SLOs
- SLIs/SLOs, dashboards, alerts

## Runbook
- On-call steps; rollback strategy

## Post-launch
- Success criteria; cleanup tasks
33 changes: 33 additions & 0 deletions _specs/introduced-pass-key/v1/ux.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
layout: spec
title: introduced pass key — UX
nav_title: "UX"
nav_order: 40
---
# UX
## Personas & Jobs-to-be-Done
- …

## Use-cases / Scenarios
- …

## Information Architecture
- Navigation map

## Key Flows
- Link wireframes in `assets/images/` or Figma

## Screens / States
- Loading/empty/error, edge cases

## Content & Microcopy
- Tone guidelines, validation messages

## Accessibility
- Keyboard flows, contrast, ARIA notes

## Responsiveness & Platforms
- Breakpoints

## Telemetry
- Events & properties for UX analysis
Loading