From 267046db0e9ed0ec247bee8914e36268c61b3c4e Mon Sep 17 00:00:00 2001 From: pranavwani <26399261+pranavwani@users.noreply.github.com> Date: Thu, 11 Sep 2025 10:03:12 +0000 Subject: [PATCH 1/2] chore(spec): scaffold introduced pass key/v1 from issue #57 --- _specs/introduced-pass-key/v1/api.md | 40 +++++++++++++++++++ _specs/introduced-pass-key/v1/assets/.gitkeep | 0 .../introduced-pass-key/v1/assets/README.md | 8 ++++ _specs/introduced-pass-key/v1/data-model.md | 18 +++++++++ _specs/introduced-pass-key/v1/hld.md | 39 ++++++++++++++++++ _specs/introduced-pass-key/v1/index.md | 40 +++++++++++++++++++ _specs/introduced-pass-key/v1/lld.md | 37 +++++++++++++++++ _specs/introduced-pass-key/v1/qa-test.md | 21 ++++++++++ _specs/introduced-pass-key/v1/rollout-ops.md | 18 +++++++++ _specs/introduced-pass-key/v1/ux.md | 33 +++++++++++++++ 10 files changed, 254 insertions(+) create mode 100644 _specs/introduced-pass-key/v1/api.md create mode 100644 _specs/introduced-pass-key/v1/assets/.gitkeep create mode 100644 _specs/introduced-pass-key/v1/assets/README.md create mode 100644 _specs/introduced-pass-key/v1/data-model.md create mode 100644 _specs/introduced-pass-key/v1/hld.md create mode 100644 _specs/introduced-pass-key/v1/index.md create mode 100644 _specs/introduced-pass-key/v1/lld.md create mode 100644 _specs/introduced-pass-key/v1/qa-test.md create mode 100644 _specs/introduced-pass-key/v1/rollout-ops.md create mode 100644 _specs/introduced-pass-key/v1/ux.md diff --git a/_specs/introduced-pass-key/v1/api.md b/_specs/introduced-pass-key/v1/api.md new file mode 100644 index 0000000..14b2d4c --- /dev/null +++ b/_specs/introduced-pass-key/v1/api.md @@ -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 +- … diff --git a/_specs/introduced-pass-key/v1/assets/.gitkeep b/_specs/introduced-pass-key/v1/assets/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/_specs/introduced-pass-key/v1/assets/README.md b/_specs/introduced-pass-key/v1/assets/README.md new file mode 100644 index 0000000..2bc6457 --- /dev/null +++ b/_specs/introduced-pass-key/v1/assets/README.md @@ -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 diff --git a/_specs/introduced-pass-key/v1/data-model.md b/_specs/introduced-pass-key/v1/data-model.md new file mode 100644 index 0000000..aef5a33 --- /dev/null +++ b/_specs/introduced-pass-key/v1/data-model.md @@ -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 +- … diff --git a/_specs/introduced-pass-key/v1/hld.md b/_specs/introduced-pass-key/v1/hld.md new file mode 100644 index 0000000..2ea8a9d --- /dev/null +++ b/_specs/introduced-pass-key/v1/hld.md @@ -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 +- … diff --git a/_specs/introduced-pass-key/v1/index.md b/_specs/introduced-pass-key/v1/index.md new file mode 100644 index 0000000..e55b72d --- /dev/null +++ b/_specs/introduced-pass-key/v1/index.md @@ -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 + +## 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_ diff --git a/_specs/introduced-pass-key/v1/lld.md b/_specs/introduced-pass-key/v1/lld.md new file mode 100644 index 0000000..3cf9a1e --- /dev/null +++ b/_specs/introduced-pass-key/v1/lld.md @@ -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 +- … diff --git a/_specs/introduced-pass-key/v1/qa-test.md b/_specs/introduced-pass-key/v1/qa-test.md new file mode 100644 index 0000000..cd537aa --- /dev/null +++ b/_specs/introduced-pass-key/v1/qa-test.md @@ -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 +- … diff --git a/_specs/introduced-pass-key/v1/rollout-ops.md b/_specs/introduced-pass-key/v1/rollout-ops.md new file mode 100644 index 0000000..e3fbe83 --- /dev/null +++ b/_specs/introduced-pass-key/v1/rollout-ops.md @@ -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 diff --git a/_specs/introduced-pass-key/v1/ux.md b/_specs/introduced-pass-key/v1/ux.md new file mode 100644 index 0000000..32ecaa0 --- /dev/null +++ b/_specs/introduced-pass-key/v1/ux.md @@ -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 From d7826abbba69bff433c888a34f5770ecd492373e Mon Sep 17 00:00:00 2001 From: Pranav Wani Date: Thu, 11 Sep 2025 15:36:52 +0530 Subject: [PATCH 2/2] Update index.md --- _specs/introduced-pass-key/v1/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_specs/introduced-pass-key/v1/index.md b/_specs/introduced-pass-key/v1/index.md index e55b72d..626f09b 100644 --- a/_specs/introduced-pass-key/v1/index.md +++ b/_specs/introduced-pass-key/v1/index.md @@ -19,7 +19,7 @@ nav_title: "Overview" nav_order: 0 --- ## Summary -introduced pass key +introduced pass key for desktop native ## Scope introduced pass key