vibedoc 1.0.1 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.next/BUILD_ID +1 -1
- package/.next/app-build-manifest.json +23 -19
- package/.next/app-path-routes-manifest.json +1 -1
- package/.next/build-manifest.json +2 -2
- package/.next/prerender-manifest.js +1 -1
- package/.next/prerender-manifest.json +1 -1
- package/.next/server/app/(app)/activity/page_client-reference-manifest.js +1 -1
- package/.next/server/app/(app)/board/page_client-reference-manifest.js +1 -1
- package/.next/server/app/(app)/docs/page.js +1 -1
- package/.next/server/app/(app)/docs/page_client-reference-manifest.js +1 -1
- package/.next/server/app/(app)/memory/page_client-reference-manifest.js +1 -1
- package/.next/server/app/(app)/settings/page_client-reference-manifest.js +1 -1
- package/.next/server/app/(app)/setup/page.js +2 -1
- package/.next/server/app/(app)/setup/page.js.nft.json +1 -1
- package/.next/server/app/(app)/setup/page_client-reference-manifest.js +1 -1
- package/.next/server/app/_not-found/page_client-reference-manifest.js +1 -1
- package/.next/server/app/_not-found.html +1 -1
- package/.next/server/app/_not-found.rsc +1 -1
- package/.next/server/app/activity.html +1 -1
- package/.next/server/app/activity.rsc +2 -2
- package/.next/server/app/api/mcp/route.js +2 -2
- package/.next/server/app/api/mcp/route.js.nft.json +1 -1
- package/.next/server/app/api/setup/generate/route.js +7 -7
- package/.next/server/app/api/setup/generate/route.js.nft.json +1 -1
- package/.next/server/app/board.html +1 -1
- package/.next/server/app/board.rsc +2 -2
- package/.next/server/app/docs.html +1 -1
- package/.next/server/app/docs.rsc +3 -3
- package/.next/server/app/index.html +1 -1
- package/.next/server/app/index.rsc +1 -1
- package/.next/server/app/memory.html +1 -1
- package/.next/server/app/memory.rsc +2 -2
- package/.next/server/app/page_client-reference-manifest.js +1 -1
- package/.next/server/app/settings.html +1 -1
- package/.next/server/app/settings.rsc +2 -2
- package/.next/server/app/setup.html +1 -1
- package/.next/server/app/setup.rsc +3 -3
- package/.next/server/app-paths-manifest.json +10 -10
- package/.next/server/chunks/118.js +2107 -0
- package/.next/server/chunks/191.js +1558 -501
- package/.next/server/middleware-build-manifest.js +1 -1
- package/.next/server/pages/404.html +1 -1
- package/.next/server/pages/500.html +1 -1
- package/.next/server/pages-manifest.json +1 -1
- package/.next/server/server-reference-manifest.js +1 -1
- package/.next/server/server-reference-manifest.json +1 -1
- package/.next/static/chunks/5179-76391417caead0bc.js +1 -0
- package/.next/static/chunks/6441-8a1066f99fe4fead.js +1 -0
- package/.next/static/chunks/app/(app)/docs/{page-17670ed46c3594e6.js → page-f5615cefbd3d1c64.js} +1 -1
- package/.next/static/chunks/app/(app)/{layout-34b4046ccf919d3f.js → layout-ef459e6f184dba6b.js} +1 -1
- package/.next/static/chunks/app/(app)/setup/page-a47e3a9a44666f50.js +1 -0
- package/.next/static/css/48c54dd7bfa2411e.css +5 -0
- package/package.json +1 -1
- package/.next/server/chunks/661.js +0 -1050
- package/.next/static/chunks/845-f90ef49ed88a44a2.js +0 -1
- package/.next/static/chunks/app/(app)/setup/page-5fd7500bd578e730.js +0 -1
- package/.next/static/css/518ce8dddf398f57.css +0 -5
- /package/.next/static/{moF7Sng2pYdyIpULgHRjM → SozubT4AiNYJ3ynkRV0zo}/_buildManifest.js +0 -0
- /package/.next/static/{moF7Sng2pYdyIpULgHRjM → SozubT4AiNYJ3ynkRV0zo}/_ssgManifest.js +0 -0
|
@@ -1,1050 +0,0 @@
|
|
|
1
|
-
"use strict";exports.id=661,exports.ids=[661],exports.modules={5661:(e,t,n)=>{n.d(t,{x:()=>s});let i=new Date().toISOString().split("T")[0],s=[{id:"blank",name:"Blank Document",description:"Empty markdown file",defaultPath:"docs/untitled.md",content:"# Untitled\n\n"},{id:"claude-md",name:"CLAUDE.md",description:"AI agent instructions for Claude Code",defaultPath:"CLAUDE.md",content:`# {{PROJECT_NAME}} — Agent Instructions
|
|
2
|
-
|
|
3
|
-
## What this is
|
|
4
|
-
{{DESCRIPTION}}
|
|
5
|
-
|
|
6
|
-
## Stack
|
|
7
|
-
{{TECH_STACK}}
|
|
8
|
-
|
|
9
|
-
## Project type
|
|
10
|
-
{{PROJECT_TYPE}}
|
|
11
|
-
|
|
12
|
-
## Commands
|
|
13
|
-
\`\`\`bash
|
|
14
|
-
# Install dependencies
|
|
15
|
-
npm install
|
|
16
|
-
|
|
17
|
-
# Start development
|
|
18
|
-
npm run dev
|
|
19
|
-
|
|
20
|
-
# Build for production
|
|
21
|
-
npm run build
|
|
22
|
-
|
|
23
|
-
# Run tests
|
|
24
|
-
npm test
|
|
25
|
-
\`\`\`
|
|
26
|
-
|
|
27
|
-
## Key architecture rules
|
|
28
|
-
- Follow existing patterns before introducing new abstractions
|
|
29
|
-
- Keep modules small and focused
|
|
30
|
-
- Write tests for business logic
|
|
31
|
-
|
|
32
|
-
## Key conventions
|
|
33
|
-
{{CONVENTIONS}}
|
|
34
|
-
|
|
35
|
-
## Key features
|
|
36
|
-
{{KEY_FEATURES}}
|
|
37
|
-
|
|
38
|
-
## Non-negotiables
|
|
39
|
-
- Keep code clean and well-documented
|
|
40
|
-
- Maintain test coverage
|
|
41
|
-
- Follow security best practices
|
|
42
|
-
- Never commit secrets or credentials
|
|
43
|
-
`},{id:"agents-md",name:"AGENTS.md",description:"AI agent instructions (multi-agent / OpenAI)",defaultPath:"AGENTS.md",content:`# {{PROJECT_NAME}} — Agent Instructions
|
|
44
|
-
|
|
45
|
-
## Overview
|
|
46
|
-
{{DESCRIPTION}}
|
|
47
|
-
|
|
48
|
-
## Stack
|
|
49
|
-
{{TECH_STACK}}
|
|
50
|
-
|
|
51
|
-
## Commands
|
|
52
|
-
\`\`\`bash
|
|
53
|
-
npm install
|
|
54
|
-
npm run dev
|
|
55
|
-
npm run build
|
|
56
|
-
npm test
|
|
57
|
-
\`\`\`
|
|
58
|
-
|
|
59
|
-
## Key conventions
|
|
60
|
-
{{CONVENTIONS}}
|
|
61
|
-
|
|
62
|
-
## Non-negotiables
|
|
63
|
-
- Follow existing code patterns
|
|
64
|
-
- Write tests for new features
|
|
65
|
-
- Never commit secrets or credentials
|
|
66
|
-
`},{id:"gemini-md",name:"GEMINI.md",description:"AI agent instructions for Gemini CLI",defaultPath:"GEMINI.md",content:`# {{PROJECT_NAME}} — Gemini Agent Instructions
|
|
67
|
-
|
|
68
|
-
## What this is
|
|
69
|
-
{{DESCRIPTION}}
|
|
70
|
-
|
|
71
|
-
## Stack
|
|
72
|
-
{{TECH_STACK}}
|
|
73
|
-
|
|
74
|
-
## Commands
|
|
75
|
-
\`\`\`bash
|
|
76
|
-
# Install dependencies
|
|
77
|
-
npm install
|
|
78
|
-
|
|
79
|
-
# Start development
|
|
80
|
-
npm run dev
|
|
81
|
-
|
|
82
|
-
# Build for production
|
|
83
|
-
npm run build
|
|
84
|
-
|
|
85
|
-
# Run tests
|
|
86
|
-
npm test
|
|
87
|
-
\`\`\`
|
|
88
|
-
|
|
89
|
-
## Key conventions
|
|
90
|
-
{{CONVENTIONS}}
|
|
91
|
-
|
|
92
|
-
## Non-negotiables
|
|
93
|
-
- Follow existing code patterns
|
|
94
|
-
- Write tests for new features
|
|
95
|
-
- Never commit secrets or credentials
|
|
96
|
-
`},{id:"cursorrules",name:".cursorrules",description:"Cursor IDE rules for AI assistance",defaultPath:".cursorrules",content:`# {{PROJECT_NAME}} — Cursor Rules
|
|
97
|
-
|
|
98
|
-
## Project overview
|
|
99
|
-
{{DESCRIPTION}}
|
|
100
|
-
|
|
101
|
-
## Tech stack
|
|
102
|
-
{{TECH_STACK}}
|
|
103
|
-
|
|
104
|
-
## Code style
|
|
105
|
-
- Use {{TECH_STACK}} conventions
|
|
106
|
-
- Follow existing patterns in the codebase
|
|
107
|
-
- Prefer explicit over implicit
|
|
108
|
-
- Keep functions small and focused
|
|
109
|
-
|
|
110
|
-
## Conventions
|
|
111
|
-
{{CONVENTIONS}}
|
|
112
|
-
|
|
113
|
-
## What NOT to do
|
|
114
|
-
- Don't introduce new dependencies without discussion
|
|
115
|
-
- Don't break existing tests
|
|
116
|
-
- Don't commit secrets or credentials
|
|
117
|
-
- Don't over-engineer simple solutions
|
|
118
|
-
`},{id:"windsurfrules",name:".windsurfrules",description:"Windsurf IDE rules for AI assistance",defaultPath:".windsurfrules",content:`# {{PROJECT_NAME}} — Windsurf Rules
|
|
119
|
-
|
|
120
|
-
## Project overview
|
|
121
|
-
{{DESCRIPTION}}
|
|
122
|
-
|
|
123
|
-
## Tech stack
|
|
124
|
-
{{TECH_STACK}}
|
|
125
|
-
|
|
126
|
-
## Code style
|
|
127
|
-
- Follow existing patterns in the codebase
|
|
128
|
-
- Prefer explicit over implicit
|
|
129
|
-
- Keep functions small and focused
|
|
130
|
-
|
|
131
|
-
## Conventions
|
|
132
|
-
{{CONVENTIONS}}
|
|
133
|
-
|
|
134
|
-
## Non-negotiables
|
|
135
|
-
- Don't introduce breaking changes
|
|
136
|
-
- Don't commit secrets or credentials
|
|
137
|
-
- Maintain test coverage
|
|
138
|
-
`},{id:"copilot-instructions",name:"Copilot Instructions",description:"GitHub Copilot custom instructions",defaultPath:".github/copilot-instructions.md",content:`# GitHub Copilot Instructions — {{PROJECT_NAME}}
|
|
139
|
-
|
|
140
|
-
## Project overview
|
|
141
|
-
{{DESCRIPTION}}
|
|
142
|
-
|
|
143
|
-
## Tech stack
|
|
144
|
-
{{TECH_STACK}}
|
|
145
|
-
|
|
146
|
-
## Coding conventions
|
|
147
|
-
{{CONVENTIONS}}
|
|
148
|
-
|
|
149
|
-
## Key features
|
|
150
|
-
{{KEY_FEATURES}}
|
|
151
|
-
|
|
152
|
-
## Style guidelines
|
|
153
|
-
- Follow existing patterns before creating new abstractions
|
|
154
|
-
- Write descriptive variable and function names
|
|
155
|
-
- Add comments for non-obvious logic only
|
|
156
|
-
- Keep functions focused on a single responsibility
|
|
157
|
-
|
|
158
|
-
## Testing
|
|
159
|
-
- Write tests for all new functionality
|
|
160
|
-
- Maintain existing test coverage
|
|
161
|
-
- Use the project's established testing patterns
|
|
162
|
-
`},{id:"prd",name:"PRD",description:"Product requirements document",defaultPath:"docs/prd.md",content:`# Product Requirements — {{PROJECT_NAME}}
|
|
163
|
-
|
|
164
|
-
**Status:** Draft
|
|
165
|
-
**Last updated:** {{DATE}}
|
|
166
|
-
**Author:**
|
|
167
|
-
**Stakeholders:**
|
|
168
|
-
|
|
169
|
-
## Problem statement
|
|
170
|
-
{{DESCRIPTION}}
|
|
171
|
-
|
|
172
|
-
## Goals
|
|
173
|
-
-
|
|
174
|
-
-
|
|
175
|
-
|
|
176
|
-
## Non-goals
|
|
177
|
-
-
|
|
178
|
-
-
|
|
179
|
-
|
|
180
|
-
## User stories
|
|
181
|
-
| As a... | I want to... | So that... |
|
|
182
|
-
|---------|--------------|------------|
|
|
183
|
-
| user | | |
|
|
184
|
-
|
|
185
|
-
## Requirements
|
|
186
|
-
|
|
187
|
-
### Functional
|
|
188
|
-
{{KEY_FEATURES}}
|
|
189
|
-
|
|
190
|
-
### Non-functional
|
|
191
|
-
- Performance:
|
|
192
|
-
- Security:
|
|
193
|
-
- Reliability:
|
|
194
|
-
- Scalability:
|
|
195
|
-
|
|
196
|
-
## Success metrics
|
|
197
|
-
| Metric | Current | Target |
|
|
198
|
-
|--------|---------|--------|
|
|
199
|
-
| | | |
|
|
200
|
-
|
|
201
|
-
## Timeline
|
|
202
|
-
| Milestone | Target date |
|
|
203
|
-
|-----------|-------------|
|
|
204
|
-
| | |
|
|
205
|
-
|
|
206
|
-
## Open questions
|
|
207
|
-
-
|
|
208
|
-
`},{id:"architecture-overview",name:"Architecture Overview",description:"System architecture doc",defaultPath:"docs/architecture/overview.md",content:`# Architecture Overview — {{PROJECT_NAME}}
|
|
209
|
-
|
|
210
|
-
**Last updated:** {{DATE}}
|
|
211
|
-
|
|
212
|
-
## Summary
|
|
213
|
-
{{DESCRIPTION}}
|
|
214
|
-
|
|
215
|
-
## Tech stack
|
|
216
|
-
{{TECH_STACK}}
|
|
217
|
-
|
|
218
|
-
## System diagram
|
|
219
|
-
|
|
220
|
-
\`\`\`mermaid
|
|
221
|
-
graph TB
|
|
222
|
-
Client["Client"] --> API["API Layer"]
|
|
223
|
-
API --> DB["Database"]
|
|
224
|
-
API --> Cache["Cache"]
|
|
225
|
-
\`\`\`
|
|
226
|
-
|
|
227
|
-
## Components
|
|
228
|
-
|
|
229
|
-
| Component | Responsibility | Tech |
|
|
230
|
-
|-----------|---------------|------|
|
|
231
|
-
| | | |
|
|
232
|
-
|
|
233
|
-
## Data flow
|
|
234
|
-
|
|
235
|
-
1.
|
|
236
|
-
2.
|
|
237
|
-
3.
|
|
238
|
-
|
|
239
|
-
## Key decisions
|
|
240
|
-
-
|
|
241
|
-
|
|
242
|
-
## Security considerations
|
|
243
|
-
- Authentication:
|
|
244
|
-
- Authorization:
|
|
245
|
-
- Data validation:
|
|
246
|
-
- Secrets management:
|
|
247
|
-
|
|
248
|
-
## Scalability notes
|
|
249
|
-
-
|
|
250
|
-
`},{id:"api-reference",name:"API Reference",description:"API endpoints reference",defaultPath:"docs/api-reference.md",content:`# API Reference — {{PROJECT_NAME}}
|
|
251
|
-
|
|
252
|
-
**Last updated:** {{DATE}}
|
|
253
|
-
|
|
254
|
-
## Base URL
|
|
255
|
-
|
|
256
|
-
\`\`\`
|
|
257
|
-
https://api.example.com/v1
|
|
258
|
-
\`\`\`
|
|
259
|
-
|
|
260
|
-
## Authentication
|
|
261
|
-
|
|
262
|
-
All requests require a bearer token in the Authorization header:
|
|
263
|
-
|
|
264
|
-
\`\`\`
|
|
265
|
-
Authorization: Bearer <token>
|
|
266
|
-
\`\`\`
|
|
267
|
-
|
|
268
|
-
## Rate limiting
|
|
269
|
-
|
|
270
|
-
- **Limit:** 1000 requests/hour per API key
|
|
271
|
-
- **Headers:** \`X-RateLimit-Limit\`, \`X-RateLimit-Remaining\`, \`X-RateLimit-Reset\`
|
|
272
|
-
|
|
273
|
-
## Pagination
|
|
274
|
-
|
|
275
|
-
List endpoints support cursor-based pagination:
|
|
276
|
-
|
|
277
|
-
\`\`\`
|
|
278
|
-
GET /resources?cursor=<cursor>&limit=20
|
|
279
|
-
\`\`\`
|
|
280
|
-
|
|
281
|
-
## Error codes
|
|
282
|
-
|
|
283
|
-
| Code | Meaning |
|
|
284
|
-
|------|---------|
|
|
285
|
-
| 400 | Bad request — invalid parameters |
|
|
286
|
-
| 401 | Unauthorized — missing or invalid token |
|
|
287
|
-
| 403 | Forbidden — insufficient permissions |
|
|
288
|
-
| 404 | Not found |
|
|
289
|
-
| 422 | Unprocessable entity — validation error |
|
|
290
|
-
| 429 | Too many requests |
|
|
291
|
-
| 500 | Internal server error |
|
|
292
|
-
|
|
293
|
-
## Endpoints
|
|
294
|
-
|
|
295
|
-
### GET /resource
|
|
296
|
-
|
|
297
|
-
**Description:** List resources
|
|
298
|
-
|
|
299
|
-
**Query parameters:**
|
|
300
|
-
- \`limit\` (integer, default 20) — items per page
|
|
301
|
-
- \`cursor\` (string) — pagination cursor
|
|
302
|
-
|
|
303
|
-
**Response:**
|
|
304
|
-
\`\`\`json
|
|
305
|
-
{
|
|
306
|
-
"data": [],
|
|
307
|
-
"cursor": null,
|
|
308
|
-
"total": 0
|
|
309
|
-
}
|
|
310
|
-
\`\`\`
|
|
311
|
-
|
|
312
|
-
### POST /resource
|
|
313
|
-
|
|
314
|
-
**Description:** Create a resource
|
|
315
|
-
|
|
316
|
-
**Request body:**
|
|
317
|
-
\`\`\`json
|
|
318
|
-
{}
|
|
319
|
-
\`\`\`
|
|
320
|
-
|
|
321
|
-
**Response:**
|
|
322
|
-
\`\`\`json
|
|
323
|
-
{}
|
|
324
|
-
\`\`\`
|
|
325
|
-
`},{id:"runbook",name:"Runbook",description:"Operational runbook",defaultPath:"docs/runbook.md",content:`# Runbook — {{PROJECT_NAME}}
|
|
326
|
-
|
|
327
|
-
**Last updated:** {{DATE}}
|
|
328
|
-
|
|
329
|
-
## Overview
|
|
330
|
-
{{DESCRIPTION}}
|
|
331
|
-
|
|
332
|
-
## SLOs
|
|
333
|
-
|
|
334
|
-
| Metric | Target |
|
|
335
|
-
|--------|--------|
|
|
336
|
-
| Availability | 99.9% |
|
|
337
|
-
| P95 latency | < 500ms |
|
|
338
|
-
| Error rate | < 0.1% |
|
|
339
|
-
|
|
340
|
-
## Environments
|
|
341
|
-
|
|
342
|
-
| Env | URL | Purpose |
|
|
343
|
-
|-----|-----|---------|
|
|
344
|
-
| Production | | Live traffic |
|
|
345
|
-
| Staging | | Pre-release testing |
|
|
346
|
-
| Development | | Local dev |
|
|
347
|
-
|
|
348
|
-
## Alerting
|
|
349
|
-
|
|
350
|
-
| Alert | Threshold | Severity | Action |
|
|
351
|
-
|-------|-----------|----------|--------|
|
|
352
|
-
| | | | |
|
|
353
|
-
|
|
354
|
-
## On-call contacts
|
|
355
|
-
|
|
356
|
-
| Role | Name | Contact |
|
|
357
|
-
|------|------|---------|
|
|
358
|
-
| Primary | | |
|
|
359
|
-
| Secondary | | |
|
|
360
|
-
|
|
361
|
-
## Procedures
|
|
362
|
-
|
|
363
|
-
### Deploy
|
|
364
|
-
|
|
365
|
-
1.
|
|
366
|
-
2.
|
|
367
|
-
3.
|
|
368
|
-
|
|
369
|
-
### Rollback
|
|
370
|
-
|
|
371
|
-
1.
|
|
372
|
-
2.
|
|
373
|
-
3.
|
|
374
|
-
|
|
375
|
-
### Troubleshooting
|
|
376
|
-
|
|
377
|
-
#### High error rate
|
|
378
|
-
1. Check application logs
|
|
379
|
-
2. Check downstream dependencies
|
|
380
|
-
3. Review recent deploys
|
|
381
|
-
|
|
382
|
-
#### High latency
|
|
383
|
-
1. Check database query times
|
|
384
|
-
2. Check cache hit rates
|
|
385
|
-
3. Review resource utilization
|
|
386
|
-
|
|
387
|
-
## Escalation path
|
|
388
|
-
|
|
389
|
-
1. On-call engineer
|
|
390
|
-
2. Team lead
|
|
391
|
-
3. Engineering manager
|
|
392
|
-
`},{id:"adr",name:"Architecture Decision",description:"Architecture Decision Record",defaultPath:"docs/architecture/decisions/ADR-001.md",content:`# ADR-001: Title
|
|
393
|
-
|
|
394
|
-
**Status:** Proposed
|
|
395
|
-
**Date:** {{DATE}}
|
|
396
|
-
**Deciders:**
|
|
397
|
-
|
|
398
|
-
## Context
|
|
399
|
-
What is the issue that we're seeing that is motivating this decision or change?
|
|
400
|
-
|
|
401
|
-
## Decision
|
|
402
|
-
What is the change that we're proposing and/or doing?
|
|
403
|
-
|
|
404
|
-
## Rationale
|
|
405
|
-
Why did we choose this option?
|
|
406
|
-
|
|
407
|
-
## Alternatives considered
|
|
408
|
-
- **Option A:** Description — pros/cons
|
|
409
|
-
- **Option B:** Description — pros/cons
|
|
410
|
-
|
|
411
|
-
## Consequences
|
|
412
|
-
|
|
413
|
-
### Positive
|
|
414
|
-
-
|
|
415
|
-
|
|
416
|
-
### Negative
|
|
417
|
-
-
|
|
418
|
-
|
|
419
|
-
### Neutral
|
|
420
|
-
-
|
|
421
|
-
`},{id:"meeting-notes",name:"Meeting Notes",description:"Meeting notes template",defaultPath:`docs/meetings/${i}.md`,content:`# Meeting Notes — ${i}
|
|
422
|
-
|
|
423
|
-
**Attendees:**
|
|
424
|
-
**Facilitator:**
|
|
425
|
-
|
|
426
|
-
## Agenda
|
|
427
|
-
|
|
428
|
-
1.
|
|
429
|
-
2.
|
|
430
|
-
|
|
431
|
-
## Notes
|
|
432
|
-
|
|
433
|
-
## Decisions
|
|
434
|
-
|
|
435
|
-
## Action items
|
|
436
|
-
|
|
437
|
-
| Action | Owner | Due |
|
|
438
|
-
|--------|-------|-----|
|
|
439
|
-
| | | |
|
|
440
|
-
|
|
441
|
-
## Next meeting
|
|
442
|
-
`},{id:"onboarding",name:"Onboarding Guide",description:"Developer onboarding guide",defaultPath:"docs/onboarding.md",content:`# Developer Onboarding — {{PROJECT_NAME}}
|
|
443
|
-
|
|
444
|
-
**Last updated:** {{DATE}}
|
|
445
|
-
|
|
446
|
-
## Overview
|
|
447
|
-
{{DESCRIPTION}}
|
|
448
|
-
|
|
449
|
-
## Prerequisites
|
|
450
|
-
- [ ] Access to repository ({{REPO_URL}})
|
|
451
|
-
- [ ] Access to staging environment
|
|
452
|
-
- [ ] Accounts: (list required accounts/services)
|
|
453
|
-
|
|
454
|
-
## Day 1 checklist
|
|
455
|
-
- [ ] Clone the repository
|
|
456
|
-
- [ ] Set up local development environment
|
|
457
|
-
- [ ] Run the app locally
|
|
458
|
-
- [ ] Read the architecture overview
|
|
459
|
-
- [ ] Meet the team
|
|
460
|
-
|
|
461
|
-
## Environment setup
|
|
462
|
-
|
|
463
|
-
\`\`\`bash
|
|
464
|
-
# Clone
|
|
465
|
-
git clone {{REPO_URL}}
|
|
466
|
-
cd {{PROJECT_NAME}}
|
|
467
|
-
|
|
468
|
-
# Install dependencies
|
|
469
|
-
npm install
|
|
470
|
-
|
|
471
|
-
# Copy environment variables
|
|
472
|
-
cp .env.example .env.local
|
|
473
|
-
|
|
474
|
-
# Start development server
|
|
475
|
-
npm run dev
|
|
476
|
-
\`\`\`
|
|
477
|
-
|
|
478
|
-
## Tech stack
|
|
479
|
-
{{TECH_STACK}}
|
|
480
|
-
|
|
481
|
-
## IDE setup
|
|
482
|
-
- Recommended: VS Code or Cursor
|
|
483
|
-
- Install recommended extensions (see \`.vscode/extensions.json\`)
|
|
484
|
-
- Enable format on save
|
|
485
|
-
|
|
486
|
-
## Project structure
|
|
487
|
-
|
|
488
|
-
\`\`\`
|
|
489
|
-
(describe key directories here)
|
|
490
|
-
\`\`\`
|
|
491
|
-
|
|
492
|
-
## Key concepts
|
|
493
|
-
-
|
|
494
|
-
|
|
495
|
-
## Common tasks
|
|
496
|
-
|
|
497
|
-
### Running tests
|
|
498
|
-
\`\`\`bash
|
|
499
|
-
npm test
|
|
500
|
-
\`\`\`
|
|
501
|
-
|
|
502
|
-
### Building for production
|
|
503
|
-
\`\`\`bash
|
|
504
|
-
npm run build
|
|
505
|
-
\`\`\`
|
|
506
|
-
|
|
507
|
-
## Key contacts
|
|
508
|
-
|
|
509
|
-
| Role | Name | Contact |
|
|
510
|
-
|------|------|---------|
|
|
511
|
-
| | | |
|
|
512
|
-
|
|
513
|
-
## Resources
|
|
514
|
-
- Architecture overview: \`docs/architecture/overview.md\`
|
|
515
|
-
- API reference: \`docs/api-reference.md\`
|
|
516
|
-
- Runbook: \`docs/runbook.md\`
|
|
517
|
-
`},{id:"contributing",name:"CONTRIBUTING.md",description:"Contribution guidelines",defaultPath:"CONTRIBUTING.md",content:`# Contributing to {{PROJECT_NAME}}
|
|
518
|
-
|
|
519
|
-
Thank you for your interest in contributing!
|
|
520
|
-
|
|
521
|
-
## Getting started
|
|
522
|
-
|
|
523
|
-
1. Fork the repository
|
|
524
|
-
2. Clone your fork: \`git clone {{REPO_URL}}\`
|
|
525
|
-
3. Create a feature branch: \`git checkout -b feat/your-feature\`
|
|
526
|
-
4. Make your changes
|
|
527
|
-
5. Submit a pull request
|
|
528
|
-
|
|
529
|
-
## Branch naming
|
|
530
|
-
|
|
531
|
-
| Type | Pattern | Example |
|
|
532
|
-
|------|---------|---------|
|
|
533
|
-
| Feature | \`feat/<description>\` | \`feat/user-auth\` |
|
|
534
|
-
| Fix | \`fix/<description>\` | \`fix/login-crash\` |
|
|
535
|
-
| Chore | \`chore/<description>\` | \`chore/update-deps\` |
|
|
536
|
-
| Docs | \`docs/<description>\` | \`docs/api-guide\` |
|
|
537
|
-
|
|
538
|
-
## Commit conventions
|
|
539
|
-
|
|
540
|
-
We use [Conventional Commits](https://conventionalcommits.org):
|
|
541
|
-
|
|
542
|
-
\`\`\`
|
|
543
|
-
feat: add user authentication
|
|
544
|
-
fix: resolve login redirect issue
|
|
545
|
-
docs: update API reference
|
|
546
|
-
chore: upgrade dependencies
|
|
547
|
-
\`\`\`
|
|
548
|
-
|
|
549
|
-
## Pull request process
|
|
550
|
-
|
|
551
|
-
1. Fill out the PR template completely
|
|
552
|
-
2. Ensure all CI checks pass
|
|
553
|
-
3. Request review from at least one maintainer
|
|
554
|
-
4. Address all review comments
|
|
555
|
-
5. Squash commits before merge
|
|
556
|
-
|
|
557
|
-
## PR review checklist
|
|
558
|
-
|
|
559
|
-
- [ ] Code follows project conventions
|
|
560
|
-
- [ ] Tests added/updated
|
|
561
|
-
- [ ] Documentation updated if needed
|
|
562
|
-
- [ ] No secrets or credentials in code
|
|
563
|
-
- [ ] Breaking changes documented
|
|
564
|
-
|
|
565
|
-
## Code style
|
|
566
|
-
{{CONVENTIONS}}
|
|
567
|
-
|
|
568
|
-
## Reporting bugs
|
|
569
|
-
|
|
570
|
-
Open an issue with:
|
|
571
|
-
- Description of the bug
|
|
572
|
-
- Steps to reproduce
|
|
573
|
-
- Expected vs actual behavior
|
|
574
|
-
- Environment details
|
|
575
|
-
`},{id:"security",name:"SECURITY.md",description:"Security policy and vulnerability reporting",defaultPath:"SECURITY.md",content:`# Security Policy — {{PROJECT_NAME}}
|
|
576
|
-
|
|
577
|
-
## Supported versions
|
|
578
|
-
|
|
579
|
-
| Version | Supported |
|
|
580
|
-
|---------|-----------|
|
|
581
|
-
| latest | ✅ |
|
|
582
|
-
| < 1.0 | ❌ |
|
|
583
|
-
|
|
584
|
-
## Reporting a vulnerability
|
|
585
|
-
|
|
586
|
-
**Please do not report security vulnerabilities through public GitHub issues.**
|
|
587
|
-
|
|
588
|
-
To report a security issue, email: security@example.com
|
|
589
|
-
|
|
590
|
-
Include:
|
|
591
|
-
- Description of the vulnerability
|
|
592
|
-
- Steps to reproduce
|
|
593
|
-
- Potential impact
|
|
594
|
-
- Any suggested mitigations
|
|
595
|
-
|
|
596
|
-
You will receive a response within 48 hours. We will:
|
|
597
|
-
1. Confirm receipt of your report
|
|
598
|
-
2. Investigate and assess the issue
|
|
599
|
-
3. Release a fix or mitigation
|
|
600
|
-
4. Credit you in the release notes (unless you prefer anonymity)
|
|
601
|
-
|
|
602
|
-
## Security best practices
|
|
603
|
-
|
|
604
|
-
When contributing to this project:
|
|
605
|
-
- Never commit secrets, tokens, or credentials
|
|
606
|
-
- Use environment variables for all sensitive configuration
|
|
607
|
-
- Validate and sanitize all user input
|
|
608
|
-
- Follow the principle of least privilege
|
|
609
|
-
- Keep dependencies up to date
|
|
610
|
-
`},{id:"pr-template",name:"PR Template",description:"Pull request template",defaultPath:".github/pull_request_template.md",content:`## Description
|
|
611
|
-
|
|
612
|
-
<!-- Briefly describe the changes and why they were made -->
|
|
613
|
-
|
|
614
|
-
## Type of change
|
|
615
|
-
|
|
616
|
-
- [ ] Bug fix (non-breaking change that fixes an issue)
|
|
617
|
-
- [ ] New feature (non-breaking change that adds functionality)
|
|
618
|
-
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
|
|
619
|
-
- [ ] Documentation update
|
|
620
|
-
- [ ] Refactor / code cleanup
|
|
621
|
-
- [ ] Dependency update
|
|
622
|
-
|
|
623
|
-
## Related issues
|
|
624
|
-
|
|
625
|
-
Closes #
|
|
626
|
-
|
|
627
|
-
## How to test
|
|
628
|
-
|
|
629
|
-
1.
|
|
630
|
-
2.
|
|
631
|
-
3.
|
|
632
|
-
|
|
633
|
-
## Screenshots / recordings
|
|
634
|
-
|
|
635
|
-
<!-- If applicable, add screenshots or screen recordings -->
|
|
636
|
-
|
|
637
|
-
## Checklist
|
|
638
|
-
|
|
639
|
-
- [ ] My code follows the project's style guidelines
|
|
640
|
-
- [ ] I have performed a self-review of my changes
|
|
641
|
-
- [ ] I have added tests that prove my fix or feature works
|
|
642
|
-
- [ ] New and existing unit tests pass locally
|
|
643
|
-
- [ ] I have updated documentation if needed
|
|
644
|
-
- [ ] No secrets or credentials are included
|
|
645
|
-
`},{id:"bug-report",name:"Bug Report Template",description:"GitHub issue template for bugs",defaultPath:".github/ISSUE_TEMPLATE/bug_report.md",content:`---
|
|
646
|
-
name: Bug report
|
|
647
|
-
about: Create a report to help us improve
|
|
648
|
-
labels: bug
|
|
649
|
-
---
|
|
650
|
-
|
|
651
|
-
## Describe the bug
|
|
652
|
-
|
|
653
|
-
A clear and concise description of what the bug is.
|
|
654
|
-
|
|
655
|
-
## Steps to reproduce
|
|
656
|
-
|
|
657
|
-
1. Go to '...'
|
|
658
|
-
2. Click on '...'
|
|
659
|
-
3. See error
|
|
660
|
-
|
|
661
|
-
## Expected behavior
|
|
662
|
-
|
|
663
|
-
A clear and concise description of what you expected to happen.
|
|
664
|
-
|
|
665
|
-
## Actual behavior
|
|
666
|
-
|
|
667
|
-
What actually happened.
|
|
668
|
-
|
|
669
|
-
## Screenshots
|
|
670
|
-
|
|
671
|
-
If applicable, add screenshots to help explain your problem.
|
|
672
|
-
|
|
673
|
-
## Environment
|
|
674
|
-
|
|
675
|
-
- OS: [e.g. macOS 14]
|
|
676
|
-
- Browser: [e.g. Chrome 120]
|
|
677
|
-
- Version: [e.g. 1.2.3]
|
|
678
|
-
- Node.js: [e.g. 20.x]
|
|
679
|
-
|
|
680
|
-
## Additional context
|
|
681
|
-
|
|
682
|
-
Add any other context about the problem here.
|
|
683
|
-
`},{id:"feature-request",name:"Feature Request Template",description:"GitHub issue template for features",defaultPath:".github/ISSUE_TEMPLATE/feature_request.md",content:`---
|
|
684
|
-
name: Feature request
|
|
685
|
-
about: Suggest an idea for this project
|
|
686
|
-
labels: enhancement
|
|
687
|
-
---
|
|
688
|
-
|
|
689
|
-
## Problem
|
|
690
|
-
|
|
691
|
-
Is your feature request related to a problem? Please describe.
|
|
692
|
-
A clear and concise description of what the problem is.
|
|
693
|
-
|
|
694
|
-
## Proposed solution
|
|
695
|
-
|
|
696
|
-
A clear and concise description of what you want to happen.
|
|
697
|
-
|
|
698
|
-
## Alternatives considered
|
|
699
|
-
|
|
700
|
-
A clear and concise description of any alternative solutions or features you've considered.
|
|
701
|
-
|
|
702
|
-
## Implementation notes
|
|
703
|
-
|
|
704
|
-
Any thoughts on how this might be implemented?
|
|
705
|
-
|
|
706
|
-
## Additional context
|
|
707
|
-
|
|
708
|
-
Add any other context, mockups, or screenshots about the feature request here.
|
|
709
|
-
`},{id:"changelog",name:"CHANGELOG.md",description:"Keep a Changelog format",defaultPath:"CHANGELOG.md",content:`# Changelog — {{PROJECT_NAME}}
|
|
710
|
-
|
|
711
|
-
All notable changes to this project will be documented in this file.
|
|
712
|
-
|
|
713
|
-
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
714
|
-
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
715
|
-
|
|
716
|
-
## [Unreleased]
|
|
717
|
-
|
|
718
|
-
### Added
|
|
719
|
-
-
|
|
720
|
-
|
|
721
|
-
### Changed
|
|
722
|
-
-
|
|
723
|
-
|
|
724
|
-
### Fixed
|
|
725
|
-
-
|
|
726
|
-
|
|
727
|
-
### Removed
|
|
728
|
-
-
|
|
729
|
-
|
|
730
|
-
## [1.0.0] — {{DATE}}
|
|
731
|
-
|
|
732
|
-
### Added
|
|
733
|
-
- Initial release
|
|
734
|
-
`},{id:"deployment",name:"DEPLOYMENT.md",description:"Deployment guide and procedures",defaultPath:"DEPLOYMENT.md",content:`# Deployment Guide — {{PROJECT_NAME}}
|
|
735
|
-
|
|
736
|
-
**Last updated:** {{DATE}}
|
|
737
|
-
|
|
738
|
-
## Environments
|
|
739
|
-
|
|
740
|
-
| Environment | URL | Branch | Auto-deploy |
|
|
741
|
-
|-------------|-----|--------|-------------|
|
|
742
|
-
| Production | | \`main\` | No |
|
|
743
|
-
| Staging | | \`develop\` | Yes |
|
|
744
|
-
| Preview | | PRs | Yes |
|
|
745
|
-
|
|
746
|
-
## Prerequisites
|
|
747
|
-
|
|
748
|
-
- Access to deployment platform
|
|
749
|
-
- Environment variables configured (see \`.env.example\`)
|
|
750
|
-
- CI/CD pipeline passing
|
|
751
|
-
|
|
752
|
-
## Deploy to production
|
|
753
|
-
|
|
754
|
-
\`\`\`bash
|
|
755
|
-
# 1. Ensure tests pass
|
|
756
|
-
npm test
|
|
757
|
-
|
|
758
|
-
# 2. Build and verify
|
|
759
|
-
npm run build
|
|
760
|
-
|
|
761
|
-
# 3. Merge to main
|
|
762
|
-
git checkout main && git merge develop
|
|
763
|
-
|
|
764
|
-
# 4. Tag the release
|
|
765
|
-
git tag v1.x.x && git push --tags
|
|
766
|
-
\`\`\`
|
|
767
|
-
|
|
768
|
-
## Environment variables
|
|
769
|
-
|
|
770
|
-
| Variable | Required | Description |
|
|
771
|
-
|----------|----------|-------------|
|
|
772
|
-
| | Yes | |
|
|
773
|
-
|
|
774
|
-
## Rollback procedure
|
|
775
|
-
|
|
776
|
-
1. Identify the last stable release tag
|
|
777
|
-
2. \`git checkout <tag>\`
|
|
778
|
-
3. Redeploy the previous version
|
|
779
|
-
4. Verify the rollback with smoke tests
|
|
780
|
-
|
|
781
|
-
## Smoke tests
|
|
782
|
-
|
|
783
|
-
After every deploy, verify:
|
|
784
|
-
- [ ] App loads at production URL
|
|
785
|
-
- [ ] Auth flow works
|
|
786
|
-
- [ ] Core features functional
|
|
787
|
-
- [ ] No error spikes in monitoring
|
|
788
|
-
|
|
789
|
-
## Contacts
|
|
790
|
-
|
|
791
|
-
| Role | Contact |
|
|
792
|
-
|------|---------|
|
|
793
|
-
| On-call | |
|
|
794
|
-
| Release manager | |
|
|
795
|
-
`},{id:"testing",name:"TESTING.md",description:"Testing strategy and guide",defaultPath:"TESTING.md",content:`# Testing Guide — {{PROJECT_NAME}}
|
|
796
|
-
|
|
797
|
-
**Last updated:** {{DATE}}
|
|
798
|
-
|
|
799
|
-
## Test strategy
|
|
800
|
-
|
|
801
|
-
| Layer | Type | Tool | Coverage target |
|
|
802
|
-
|-------|------|------|----------------|
|
|
803
|
-
| Unit | Functions/logic | {{TEST_FRAMEWORK}} | 80%+ |
|
|
804
|
-
| Integration | API/DB | {{TEST_FRAMEWORK}} | 70%+ |
|
|
805
|
-
| E2E | User flows | Playwright | Key paths |
|
|
806
|
-
|
|
807
|
-
## Running tests
|
|
808
|
-
|
|
809
|
-
\`\`\`bash
|
|
810
|
-
# Run all tests
|
|
811
|
-
npm test
|
|
812
|
-
|
|
813
|
-
# Run with coverage
|
|
814
|
-
npm run test:coverage
|
|
815
|
-
|
|
816
|
-
# Run E2E tests
|
|
817
|
-
npm run test:e2e
|
|
818
|
-
|
|
819
|
-
# Watch mode
|
|
820
|
-
npm run test:watch
|
|
821
|
-
\`\`\`
|
|
822
|
-
|
|
823
|
-
## Writing tests
|
|
824
|
-
|
|
825
|
-
### Unit test example
|
|
826
|
-
|
|
827
|
-
\`\`\`typescript
|
|
828
|
-
describe('MyFunction', () => {
|
|
829
|
-
it('should return expected value', () => {
|
|
830
|
-
expect(myFunction(input)).toBe(expected)
|
|
831
|
-
})
|
|
832
|
-
})
|
|
833
|
-
\`\`\`
|
|
834
|
-
|
|
835
|
-
### Integration test guidelines
|
|
836
|
-
- Use a real database (not mocks) for DB tests
|
|
837
|
-
- Reset state between tests
|
|
838
|
-
- Test happy path and error cases
|
|
839
|
-
|
|
840
|
-
### E2E test guidelines
|
|
841
|
-
- Cover critical user journeys
|
|
842
|
-
- Use stable selectors (\`data-testid\`)
|
|
843
|
-
- Run against staging environment
|
|
844
|
-
|
|
845
|
-
## Test organization
|
|
846
|
-
|
|
847
|
-
\`\`\`
|
|
848
|
-
src/
|
|
849
|
-
__tests__/ # Unit tests
|
|
850
|
-
__integration__/ # Integration tests
|
|
851
|
-
e2e/ # E2E tests
|
|
852
|
-
\`\`\`
|
|
853
|
-
|
|
854
|
-
## CI/CD
|
|
855
|
-
|
|
856
|
-
Tests run automatically on every PR. PRs cannot merge with failing tests.
|
|
857
|
-
`},{id:"glossary",name:"Glossary",description:"Project terminology reference",defaultPath:"docs/glossary.md",content:`# Glossary — {{PROJECT_NAME}}
|
|
858
|
-
|
|
859
|
-
**Last updated:** {{DATE}}
|
|
860
|
-
|
|
861
|
-
This document defines terms used throughout the project documentation and codebase.
|
|
862
|
-
|
|
863
|
-
## Terms
|
|
864
|
-
|
|
865
|
-
| Term | Definition |
|
|
866
|
-
|------|------------|
|
|
867
|
-
| | |
|
|
868
|
-
|
|
869
|
-
## Acronyms
|
|
870
|
-
|
|
871
|
-
| Acronym | Full form | Meaning |
|
|
872
|
-
|---------|-----------|---------|
|
|
873
|
-
| | | |
|
|
874
|
-
|
|
875
|
-
## Domain concepts
|
|
876
|
-
|
|
877
|
-
<!-- Add domain-specific concepts here -->
|
|
878
|
-
|
|
879
|
-
---
|
|
880
|
-
|
|
881
|
-
*Keep this document updated as new terminology is introduced.*
|
|
882
|
-
`},{id:"database",name:"Database Docs",description:"Database schema and design reference",defaultPath:"docs/DATABASE.md",content:`# Database Documentation — {{PROJECT_NAME}}
|
|
883
|
-
|
|
884
|
-
**Last updated:** {{DATE}}
|
|
885
|
-
|
|
886
|
-
## Overview
|
|
887
|
-
|
|
888
|
-
<!-- Brief description of the database design -->
|
|
889
|
-
|
|
890
|
-
## Entity Relationship Diagram
|
|
891
|
-
|
|
892
|
-
\`\`\`mermaid
|
|
893
|
-
erDiagram
|
|
894
|
-
USERS {
|
|
895
|
-
uuid id PK
|
|
896
|
-
string email
|
|
897
|
-
timestamp created_at
|
|
898
|
-
}
|
|
899
|
-
\`\`\`
|
|
900
|
-
|
|
901
|
-
## Tables
|
|
902
|
-
|
|
903
|
-
### users
|
|
904
|
-
|
|
905
|
-
| Column | Type | Nullable | Description |
|
|
906
|
-
|--------|------|----------|-------------|
|
|
907
|
-
| id | uuid | No | Primary key |
|
|
908
|
-
| email | varchar | No | Unique email |
|
|
909
|
-
| created_at | timestamp | No | Creation time |
|
|
910
|
-
|
|
911
|
-
## Indexes
|
|
912
|
-
|
|
913
|
-
| Table | Columns | Type | Purpose |
|
|
914
|
-
|-------|---------|------|---------|
|
|
915
|
-
| | | | |
|
|
916
|
-
|
|
917
|
-
## Migrations
|
|
918
|
-
|
|
919
|
-
Migrations live in \`db/migrations/\`. Run with:
|
|
920
|
-
|
|
921
|
-
\`\`\`bash
|
|
922
|
-
npm run db:migrate
|
|
923
|
-
\`\`\`
|
|
924
|
-
|
|
925
|
-
## Connection
|
|
926
|
-
|
|
927
|
-
\`\`\`
|
|
928
|
-
DATABASE_URL=postgresql://user:password@host:5432/dbname
|
|
929
|
-
\`\`\`
|
|
930
|
-
|
|
931
|
-
## Backup & restore
|
|
932
|
-
|
|
933
|
-
\`\`\`bash
|
|
934
|
-
# Backup
|
|
935
|
-
pg_dump $DATABASE_URL > backup.sql
|
|
936
|
-
|
|
937
|
-
# Restore
|
|
938
|
-
psql $DATABASE_URL < backup.sql
|
|
939
|
-
\`\`\`
|
|
940
|
-
|
|
941
|
-
## Performance notes
|
|
942
|
-
|
|
943
|
-
-
|
|
944
|
-
`},{id:"openapi",name:"OpenAPI Spec",description:"OpenAPI 3.0 API specification scaffold",defaultPath:"docs/api-spec.yaml",content:`openapi: 3.0.3
|
|
945
|
-
info:
|
|
946
|
-
title: {{PROJECT_NAME}} API
|
|
947
|
-
description: |
|
|
948
|
-
{{DESCRIPTION}}
|
|
949
|
-
version: 1.0.0
|
|
950
|
-
contact:
|
|
951
|
-
email: team@example.com
|
|
952
|
-
|
|
953
|
-
servers:
|
|
954
|
-
- url: https://api.example.com/v1
|
|
955
|
-
description: Production
|
|
956
|
-
- url: https://staging-api.example.com/v1
|
|
957
|
-
description: Staging
|
|
958
|
-
|
|
959
|
-
security:
|
|
960
|
-
- bearerAuth: []
|
|
961
|
-
|
|
962
|
-
paths:
|
|
963
|
-
/health:
|
|
964
|
-
get:
|
|
965
|
-
summary: Health check
|
|
966
|
-
operationId: healthCheck
|
|
967
|
-
security: []
|
|
968
|
-
responses:
|
|
969
|
-
'200':
|
|
970
|
-
description: OK
|
|
971
|
-
content:
|
|
972
|
-
application/json:
|
|
973
|
-
schema:
|
|
974
|
-
type: object
|
|
975
|
-
properties:
|
|
976
|
-
status:
|
|
977
|
-
type: string
|
|
978
|
-
example: ok
|
|
979
|
-
|
|
980
|
-
/resources:
|
|
981
|
-
get:
|
|
982
|
-
summary: List resources
|
|
983
|
-
operationId: listResources
|
|
984
|
-
parameters:
|
|
985
|
-
- name: limit
|
|
986
|
-
in: query
|
|
987
|
-
schema:
|
|
988
|
-
type: integer
|
|
989
|
-
default: 20
|
|
990
|
-
- name: cursor
|
|
991
|
-
in: query
|
|
992
|
-
schema:
|
|
993
|
-
type: string
|
|
994
|
-
responses:
|
|
995
|
-
'200':
|
|
996
|
-
description: Success
|
|
997
|
-
content:
|
|
998
|
-
application/json:
|
|
999
|
-
schema:
|
|
1000
|
-
$ref: '#/components/schemas/ResourceList'
|
|
1001
|
-
'401':
|
|
1002
|
-
$ref: '#/components/responses/Unauthorized'
|
|
1003
|
-
|
|
1004
|
-
components:
|
|
1005
|
-
securitySchemes:
|
|
1006
|
-
bearerAuth:
|
|
1007
|
-
type: http
|
|
1008
|
-
scheme: bearer
|
|
1009
|
-
bearerFormat: JWT
|
|
1010
|
-
|
|
1011
|
-
schemas:
|
|
1012
|
-
Resource:
|
|
1013
|
-
type: object
|
|
1014
|
-
properties:
|
|
1015
|
-
id:
|
|
1016
|
-
type: string
|
|
1017
|
-
format: uuid
|
|
1018
|
-
createdAt:
|
|
1019
|
-
type: string
|
|
1020
|
-
format: date-time
|
|
1021
|
-
|
|
1022
|
-
ResourceList:
|
|
1023
|
-
type: object
|
|
1024
|
-
properties:
|
|
1025
|
-
data:
|
|
1026
|
-
type: array
|
|
1027
|
-
items:
|
|
1028
|
-
$ref: '#/components/schemas/Resource'
|
|
1029
|
-
cursor:
|
|
1030
|
-
type: string
|
|
1031
|
-
nullable: true
|
|
1032
|
-
total:
|
|
1033
|
-
type: integer
|
|
1034
|
-
|
|
1035
|
-
Error:
|
|
1036
|
-
type: object
|
|
1037
|
-
properties:
|
|
1038
|
-
error:
|
|
1039
|
-
type: string
|
|
1040
|
-
message:
|
|
1041
|
-
type: string
|
|
1042
|
-
|
|
1043
|
-
responses:
|
|
1044
|
-
Unauthorized:
|
|
1045
|
-
description: Unauthorized
|
|
1046
|
-
content:
|
|
1047
|
-
application/json:
|
|
1048
|
-
schema:
|
|
1049
|
-
$ref: '#/components/schemas/Error'
|
|
1050
|
-
`}]}};
|