proagents 1.6.19 → 1.6.21

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.
Files changed (143) hide show
  1. package/.claude/settings.local.json +13 -1
  2. package/.proagents/.cursorrules +25 -10
  3. package/.proagents/.windsurfrules +25 -10
  4. package/.proagents/AGENTS.md +30 -11
  5. package/.proagents/AI_INSTRUCTIONS.md +86 -30
  6. package/.proagents/BOLT.md +25 -10
  7. package/.proagents/CLAUDE.md +25 -10
  8. package/.proagents/GEMINI.md +25 -10
  9. package/.proagents/KIRO.md +25 -10
  10. package/.proagents/LOVABLE.md +25 -10
  11. package/.proagents/PROAGENTS.md +96 -343
  12. package/.proagents/REPLIT.md +25 -10
  13. package/.proagents/activity.log +1 -0
  14. package/.proagents/custom-commands.yaml +0 -1
  15. package/.proagents/docs/command-details.md +1 -2
  16. package/.proagents/getting-started/ai-training-setup.md +0 -1
  17. package/.proagents/performance/README.md +59 -0
  18. package/.proagents/performance/bundle-analysis.md +375 -0
  19. package/.proagents/performance/load-testing.md +563 -0
  20. package/.proagents/performance/runtime-metrics.md +489 -0
  21. package/.proagents/performance/web-vitals.md +425 -0
  22. package/.proagents/platforms.yaml +66 -0
  23. package/.proagents/proagents.config.yaml +0 -1
  24. package/.proagents/prompts/ai-add.md +80 -0
  25. package/.proagents/prompts/ai-list.md +41 -0
  26. package/.proagents/prompts/ai-remove.md +112 -0
  27. package/.proagents/prompts/ai-sync.md +96 -0
  28. package/.proagents/workflow-modes/entry-modes.md +1 -6
  29. package/lib/commands/ai.js +100 -48
  30. package/lib/commands/init.js +89 -22
  31. package/package.json +1 -1
  32. package/.proagents/ANTIGRAVITY.md +0 -61
  33. package/.proagents/CHATGPT.md +0 -57
  34. package/.proagents/GROQ.md +0 -57
  35. package/.proagents/api-versioning/README.md +0 -257
  36. package/.proagents/api-versioning/changelog-template.md +0 -225
  37. package/.proagents/api-versioning/deprecation-workflow.md +0 -470
  38. package/.proagents/api-versioning/versioning-strategy.md +0 -291
  39. package/.proagents/automation/README.md +0 -38
  40. package/.proagents/automation/ai-behavior-rules.md +0 -339
  41. package/.proagents/automation/ai-prompt-injection.md +0 -331
  42. package/.proagents/automation/auto-decisions.md +0 -535
  43. package/.proagents/automation/decision-defaults.yaml +0 -317
  44. package/.proagents/cache/README.md +0 -110
  45. package/.proagents/cache/analysis-metadata.json +0 -76
  46. package/.proagents/cache/conventions.json +0 -125
  47. package/.proagents/cache/dependencies.json +0 -85
  48. package/.proagents/cache/features.json +0 -115
  49. package/.proagents/cache/patterns.json +0 -105
  50. package/.proagents/cache/schemas/conventions-schema.json +0 -138
  51. package/.proagents/cache/schemas/dependencies-schema.json +0 -95
  52. package/.proagents/cache/schemas/features-schema.json +0 -104
  53. package/.proagents/cache/schemas/metadata-schema.json +0 -83
  54. package/.proagents/cache/schemas/patterns-schema.json +0 -136
  55. package/.proagents/cache/schemas/structure-schema.json +0 -72
  56. package/.proagents/cache/structure.json +0 -109
  57. package/.proagents/checklists/README.md +0 -261
  58. package/.proagents/checklists/code-quality.md +0 -137
  59. package/.proagents/checklists/code-review.md +0 -148
  60. package/.proagents/checklists/pr-checklist.md +0 -78
  61. package/.proagents/checklists/pre-deployment.md +0 -132
  62. package/.proagents/checklists/pre-implementation.md +0 -80
  63. package/.proagents/checklists/testing.md +0 -120
  64. package/.proagents/checkpoints.json +0 -13
  65. package/.proagents/cicd/README.md +0 -338
  66. package/.proagents/cicd/azure-devops.md +0 -267
  67. package/.proagents/cicd/github-actions.md +0 -375
  68. package/.proagents/cicd/gitlab-ci.md +0 -278
  69. package/.proagents/cicd/jenkins.md +0 -317
  70. package/.proagents/collaboration/README.md +0 -143
  71. package/.proagents/collaboration/roles.md +0 -248
  72. package/.proagents/collaboration/sessions.md +0 -390
  73. package/.proagents/collaboration/sync.md +0 -358
  74. package/.proagents/cost/README.md +0 -48
  75. package/.proagents/cost/cost-template.md +0 -283
  76. package/.proagents/cost/estimation-framework.md +0 -287
  77. package/.proagents/database/README.md +0 -72
  78. package/.proagents/database/examples/001-create-users.sql +0 -129
  79. package/.proagents/database/examples/002-add-preferences.sql +0 -94
  80. package/.proagents/database/examples/003-add-index.sql +0 -105
  81. package/.proagents/database/examples/004-rename-column.sql +0 -122
  82. package/.proagents/database/examples/005-add-foreign-key.sql +0 -142
  83. package/.proagents/database/examples/006-data-migration.sql +0 -196
  84. package/.proagents/database/examples/007-drop-column.sql +0 -163
  85. package/.proagents/database/examples/README.md +0 -89
  86. package/.proagents/database/migration-workflow.md +0 -478
  87. package/.proagents/database/rollback-scripts.md +0 -487
  88. package/.proagents/database/safety-checks.md +0 -447
  89. package/.proagents/git/README.md +0 -68
  90. package/.proagents/git/branch-strategy.md +0 -164
  91. package/.proagents/git/commit-conventions.md +0 -241
  92. package/.proagents/git/pr-workflow.md +0 -286
  93. package/.proagents/git/rollback-procedures.md +0 -416
  94. package/.proagents/ide-integration/README.md +0 -124
  95. package/.proagents/ide-integration/cline-config.md +0 -429
  96. package/.proagents/ide-integration/continue-config.md +0 -380
  97. package/.proagents/ide-integration/cursor-rules.md +0 -280
  98. package/.proagents/ide-integration/github-copilot.md +0 -384
  99. package/.proagents/ide-integration/windsurf-rules.md +0 -314
  100. package/.proagents/integrations/README.md +0 -97
  101. package/.proagents/integrations/pm/README.md +0 -344
  102. package/.proagents/learning/README.md +0 -136
  103. package/.proagents/learning/adaptation.md +0 -305
  104. package/.proagents/learning/data-collection.md +0 -283
  105. package/.proagents/learning/implementation-guide.md +0 -865
  106. package/.proagents/learning/reports.md +0 -306
  107. package/.proagents/mcp/README.md +0 -133
  108. package/.proagents/mcp/context-providers.md +0 -442
  109. package/.proagents/mcp/server-config.md +0 -306
  110. package/.proagents/mcp/tools-definition.md +0 -513
  111. package/.proagents/pm-integration/README.md +0 -151
  112. package/.proagents/pm-integration/asana.md +0 -346
  113. package/.proagents/pm-integration/github-issues.md +0 -308
  114. package/.proagents/pm-integration/gitlab-issues.md +0 -482
  115. package/.proagents/pm-integration/jira.md +0 -364
  116. package/.proagents/pm-integration/linear.md +0 -409
  117. package/.proagents/pm-integration/notion.md +0 -275
  118. package/.proagents/pm-integration/sync-config.md +0 -533
  119. package/.proagents/pm-integration/trello.md +0 -159
  120. package/.proagents/rules/README.md +0 -179
  121. package/.proagents/rules/custom-rules-template.yaml +0 -286
  122. package/.proagents/rules/custom-rules.md +0 -754
  123. package/.proagents/rules/validation-rules-template.yaml +0 -517
  124. package/.proagents/runbooks/README.md +0 -219
  125. package/.proagents/runbooks/dependency-vulnerability.md +0 -505
  126. package/.proagents/runbooks/incident-response.md +0 -451
  127. package/.proagents/runbooks/performance-degradation.md +0 -584
  128. package/.proagents/runbooks/production-debugging.md +0 -489
  129. package/.proagents/sprints/README.md +0 -58
  130. package/.proagents/team/README.md +0 -256
  131. package/.proagents/team/code-ownership.md +0 -306
  132. package/.proagents/team/communication-templates.md +0 -441
  133. package/.proagents/team/handoff-protocol.md +0 -380
  134. package/.proagents/team/ide-setup/README.md +0 -103
  135. package/.proagents/team/ide-setup/cursor.md +0 -276
  136. package/.proagents/team/ide-setup/jetbrains.md +0 -330
  137. package/.proagents/team/ide-setup/neovim.md +0 -640
  138. package/.proagents/team/ide-setup/vscode.md +0 -348
  139. package/.proagents/team/onboarding.md +0 -278
  140. package/.proagents/time-tracking.json +0 -19
  141. package/.proagents/troubleshooting/README.md +0 -730
  142. package/.proagents/troubleshooting/ai-issues.md +0 -601
  143. package/.proagents/troubleshooting/workflow-issues.md +0 -571
@@ -1,61 +0,0 @@
1
- # ProAgents Commands for Antigravity IDE
2
-
3
- This project uses ProAgents - an AI-agnostic development workflow framework.
4
-
5
- ## ⚠️ MANDATORY: Every pa: Command Flow
6
-
7
- ### BEFORE Any pa: Command (Auto-Sync)
8
-
9
- **Read these files FIRST before doing anything:**
10
-
11
- ```bash
12
- cat .proagents/worklog/_context.md # Current state
13
- cat .proagents/changelog/_recent.md # Recent changes
14
- tail -10 .proagents/activity.log # Recent activity
15
- ```
16
-
17
- **This applies to EVERY command:** `pa:fix`, `pa:feature`, `pa:test`, `pa:doc`, etc.
18
-
19
- ### AFTER Any pa: Command (Auto-Log)
20
-
21
- **After EVERY file edit, IMMEDIATELY update these files:**
22
-
23
- 1. `.proagents/changelog/_recent.md` - Prepend change summary
24
- 2. `.proagents/changelog/modules/[module].md` - Based on file path
25
- 3. `.proagents/worklog/_context.md` - Update current state
26
-
27
- Module detection: `src/api/*`→api, `src/auth/*`→auth, `src/components/*`→ui
28
-
29
- ## Essential Commands
30
-
31
- | Command | Action |
32
- |---------|--------|
33
- | `pa:feature "name"` | Start new feature workflow |
34
- | `pa:fix "bug"` | Quick bug fix mode |
35
- | `pa:project-setup` | Interactive project setup wizard |
36
- | `pa:rnd` | Research & Development workflow |
37
- | `pa:doc` | Documentation options |
38
- | `pa:qa` | Quality assurance checks |
39
- | `pa:test` | Run test workflow |
40
- | `pa:deploy` | Deployment preparation |
41
- | `pa:status` | Show current progress |
42
-
43
- ## Full Command Reference
44
-
45
- For complete command list, see: `./.proagents/AI_INSTRUCTIONS.md`
46
-
47
- ## On `pa:` Command
48
-
49
- 1. Read the corresponding file from `./.proagents/prompts/` or `./.proagents/workflow-modes/`
50
- 2. Follow the workflow instructions
51
- 3. Use project config from `./.proagents/proagents.config.yaml`
52
-
53
- ## Key Files
54
-
55
- - `./.proagents/AI_INSTRUCTIONS.md` - Complete command reference
56
- - `./.proagents/WORKFLOW.md` - Full 10-phase workflow
57
- - `./.proagents/prompts/` - Phase-specific prompts
58
-
59
- ## Note
60
-
61
- Works with both Gemini and Claude models in Antigravity.
@@ -1,57 +0,0 @@
1
- # ProAgents Commands for ChatGPT / Codex
2
-
3
- This project uses ProAgents - an AI-agnostic development workflow framework.
4
-
5
- ## ⚠️ MANDATORY: Every pa: Command Flow
6
-
7
- ### BEFORE Any pa: Command (Auto-Sync)
8
-
9
- **Read these files FIRST before doing anything:**
10
-
11
- ```bash
12
- cat .proagents/worklog/_context.md # Current state
13
- cat .proagents/changelog/_recent.md # Recent changes
14
- tail -10 .proagents/activity.log # Recent activity
15
- ```
16
-
17
- **This applies to EVERY command:** `pa:fix`, `pa:feature`, `pa:test`, `pa:doc`, etc.
18
-
19
- ### AFTER Any pa: Command (Auto-Log)
20
-
21
- **After EVERY file edit, IMMEDIATELY update these files:**
22
-
23
- 1. `.proagents/changelog/_recent.md` - Prepend change summary
24
- 2. `.proagents/changelog/modules/[module].md` - Based on file path
25
- 3. `.proagents/worklog/_context.md` - Update current state
26
-
27
- Module detection: `src/api/*`→api, `src/auth/*`→auth, `src/components/*`→ui
28
-
29
- ## Essential Commands
30
-
31
- | Command | Action |
32
- |---------|--------|
33
- | `pa:feature "name"` | Start new feature workflow |
34
- | `pa:fix "bug"` | Quick bug fix mode |
35
- | `pa:project-setup` | Interactive project setup wizard |
36
- | `pa:rnd` | Research & Development workflow |
37
- | `pa:doc` | Documentation options |
38
- | `pa:qa` | Quality assurance checks |
39
- | `pa:test` | Run test workflow |
40
- | `pa:deploy` | Deployment preparation |
41
- | `pa:status` | Show current progress |
42
-
43
- ## Full Command Reference
44
-
45
- For complete command list, see: `./.proagents/AI_INSTRUCTIONS.md`
46
-
47
- ## On `pa:` Command
48
-
49
- 1. Read the corresponding file from `./.proagents/prompts/` or `./.proagents/workflow-modes/`
50
- 2. Follow the workflow instructions
51
- 3. Use project config from `./.proagents/proagents.config.yaml`
52
-
53
- ## Key Files
54
-
55
- - `./.proagents/AI_INSTRUCTIONS.md` - Complete command reference
56
- - `./.proagents/WORKFLOW.md` - Full 10-phase workflow
57
- - `./.proagents/prompts/` - Phase-specific prompts
@@ -1,57 +0,0 @@
1
- # ProAgents Commands for Groq
2
-
3
- This project uses ProAgents - an AI-agnostic development workflow framework.
4
-
5
- ## ⚠️ MANDATORY: Every pa: Command Flow
6
-
7
- ### BEFORE Any pa: Command (Auto-Sync)
8
-
9
- **Read these files FIRST before doing anything:**
10
-
11
- ```bash
12
- cat .proagents/worklog/_context.md # Current state
13
- cat .proagents/changelog/_recent.md # Recent changes
14
- tail -10 .proagents/activity.log # Recent activity
15
- ```
16
-
17
- **This applies to EVERY command:** `pa:fix`, `pa:feature`, `pa:test`, `pa:doc`, etc.
18
-
19
- ### AFTER Any pa: Command (Auto-Log)
20
-
21
- **After EVERY file edit, IMMEDIATELY update these files:**
22
-
23
- 1. `.proagents/changelog/_recent.md` - Prepend change summary
24
- 2. `.proagents/changelog/modules/[module].md` - Based on file path
25
- 3. `.proagents/worklog/_context.md` - Update current state
26
-
27
- Module detection: `src/api/*`→api, `src/auth/*`→auth, `src/components/*`→ui
28
-
29
- ## Essential Commands
30
-
31
- | Command | Action |
32
- |---------|--------|
33
- | `pa:feature "name"` | Start new feature workflow |
34
- | `pa:fix "bug"` | Quick bug fix mode |
35
- | `pa:project-setup` | Interactive project setup wizard |
36
- | `pa:rnd` | Research & Development workflow |
37
- | `pa:doc` | Documentation options |
38
- | `pa:qa` | Quality assurance checks |
39
- | `pa:test` | Run test workflow |
40
- | `pa:deploy` | Deployment preparation |
41
- | `pa:status` | Show current progress |
42
-
43
- ## Full Command Reference
44
-
45
- For complete command list, see: `./.proagents/AI_INSTRUCTIONS.md`
46
-
47
- ## On `pa:` Command
48
-
49
- 1. Read the corresponding file from `./.proagents/prompts/` or `./.proagents/workflow-modes/`
50
- 2. Follow the workflow instructions
51
- 3. Use project config from `./.proagents/proagents.config.yaml`
52
-
53
- ## Key Files
54
-
55
- - `./.proagents/AI_INSTRUCTIONS.md` - Complete command reference
56
- - `./.proagents/WORKFLOW.md` - Full 10-phase workflow
57
- - `./.proagents/prompts/` - Phase-specific prompts
@@ -1,257 +0,0 @@
1
- # API Versioning
2
-
3
- Manage API versions, deprecation, and backward compatibility.
4
-
5
- ---
6
-
7
- ## Overview
8
-
9
- API versioning ensures smooth evolution of your APIs while maintaining backward compatibility for existing clients. ProAgents helps you manage API versions throughout the development lifecycle.
10
-
11
- ---
12
-
13
- ## Documentation
14
-
15
- | Document | Description |
16
- |----------|-------------|
17
- | [Versioning Strategy](./versioning-strategy.md) | URL vs header versioning, semantic versioning |
18
- | [Deprecation Workflow](./deprecation-workflow.md) | Deprecation timeline, migration guides |
19
- | [Changelog Template](./changelog-template.md) | API changelog format and automation |
20
-
21
- ---
22
-
23
- ## Versioning Strategies
24
-
25
- ### 1. URL-Based Versioning (Recommended)
26
-
27
- ```
28
- https://api.example.com/v1/users
29
- https://api.example.com/v2/users
30
- ```
31
-
32
- **Pros:**
33
- - Clear and explicit
34
- - Easy to understand
35
- - Cache-friendly
36
- - Easy to test
37
-
38
- **Cons:**
39
- - URL changes between versions
40
- - Multiple endpoints to maintain
41
-
42
- ### 2. Header-Based Versioning
43
-
44
- ```http
45
- GET /users HTTP/1.1
46
- Accept: application/vnd.api+json;version=2
47
- ```
48
-
49
- **Pros:**
50
- - Clean URLs
51
- - Same resource URL across versions
52
-
53
- **Cons:**
54
- - Less visible
55
- - Harder to test in browser
56
- - Cache configuration needed
57
-
58
- ### 3. Query Parameter Versioning
59
-
60
- ```
61
- https://api.example.com/users?version=2
62
- ```
63
-
64
- **Pros:**
65
- - Simple to implement
66
- - Easy to test
67
-
68
- **Cons:**
69
- - Not RESTful
70
- - Caching issues
71
-
72
- ---
73
-
74
- ## Quick Start
75
-
76
- ```yaml
77
- # proagents.config.yaml
78
- api_versioning:
79
- strategy: "url" # url | header | query
80
- current_version: "v2"
81
- supported_versions: ["v1", "v2"]
82
- deprecation_notice: "6 months"
83
-
84
- # Version lifecycle
85
- lifecycle:
86
- alpha: "unstable, may change"
87
- beta: "stable, may have bugs"
88
- stable: "production ready"
89
- deprecated: "will be removed"
90
- sunset: "no longer available"
91
- ```
92
-
93
- ---
94
-
95
- ## Version Lifecycle
96
-
97
- ```
98
- Alpha → Beta → Stable → Deprecated → Sunset
99
- ↓ ↓ ↓ ↓ ↓
100
- Unstable Testing Current Notice Removed
101
- ```
102
-
103
- ### Timeline Example
104
-
105
- | Version | Status | Date | Notes |
106
- |---------|--------|------|-------|
107
- | v1 | Deprecated | 2024-01 | Migration notice sent |
108
- | v1 | Sunset | 2024-07 | No longer available |
109
- | v2 | Stable | 2024-01 | Current version |
110
- | v3 | Beta | 2024-06 | Testing phase |
111
-
112
- ---
113
-
114
- ## Commands
115
-
116
- ```bash
117
- # Check API compatibility between versions
118
- proagents api check-compatibility v1 v2
119
-
120
- # Generate API changelog
121
- proagents api changelog
122
-
123
- # Generate migration guide
124
- proagents api migration-guide v1 v2
125
-
126
- # Mark version deprecated
127
- proagents api deprecate v1 --sunset "2024-06-01"
128
-
129
- # Check for breaking changes
130
- proagents api breaking-changes v1 v2
131
-
132
- # Validate API schema
133
- proagents api validate-schema
134
- ```
135
-
136
- ---
137
-
138
- ## Breaking vs Non-Breaking Changes
139
-
140
- ### Breaking Changes (Require New Version)
141
-
142
- | Change Type | Example |
143
- |-------------|---------|
144
- | Remove endpoint | DELETE /api/v1/legacy |
145
- | Remove field | Remove `user.username` |
146
- | Rename field | `user_id` → `userId` |
147
- | Change field type | `id: number` → `id: string` |
148
- | Add required field | Add required `email` |
149
- | Change HTTP method | GET → POST |
150
- | Change authentication | API key → OAuth |
151
-
152
- ### Non-Breaking Changes (Same Version)
153
-
154
- | Change Type | Example |
155
- |-------------|---------|
156
- | Add endpoint | New POST /api/v1/preferences |
157
- | Add optional field | Add `user.nickname` |
158
- | Add enum value | Status: `active` → `active, pending` |
159
- | Widen type | `int` → `number` |
160
- | Deprecate (not remove) | Mark field deprecated |
161
- | Add optional parameter | Add `?limit=10` |
162
-
163
- ---
164
-
165
- ## Deprecation Process
166
-
167
- ### Phase 1: Announcement (T-6 months)
168
- - Add deprecation warnings to responses
169
- - Update documentation
170
- - Notify API consumers
171
-
172
- ### Phase 2: Migration Support (T-3 months)
173
- - Provide migration guides
174
- - Offer migration tools/scripts
175
- - Support both versions
176
-
177
- ### Phase 3: Final Notice (T-1 month)
178
- - Send final reminders
179
- - Reduce support for deprecated version
180
- - Track remaining usage
181
-
182
- ### Phase 4: Sunset (T-0)
183
- - Remove deprecated version
184
- - Return 410 Gone for old endpoints
185
- - Archive documentation
186
-
187
- ---
188
-
189
- ## Response Headers
190
-
191
- ```http
192
- HTTP/1.1 200 OK
193
- X-API-Version: 2
194
- X-API-Deprecated: true
195
- X-API-Sunset: 2024-06-01
196
- Link: <https://api.example.com/v2/users>; rel="successor-version"
197
- ```
198
-
199
- ---
200
-
201
- ## Changelog Format
202
-
203
- ```markdown
204
- # API Changelog
205
-
206
- ## [v2.1.0] - 2024-01-15
207
-
208
- ### Added
209
- - `GET /users/{id}/preferences` - Fetch user preferences
210
- - `POST /users/{id}/avatar` - Upload user avatar
211
-
212
- ### Changed
213
- - `GET /users` now supports pagination (breaking: removed `all` parameter)
214
-
215
- ### Deprecated
216
- - `GET /users/{id}/settings` - Use `/preferences` instead
217
-
218
- ### Removed
219
- - None
220
-
221
- ### Fixed
222
- - Fixed rate limit calculation for authenticated requests
223
-
224
- ### Security
225
- - Added input validation for user search endpoint
226
- ```
227
-
228
- ---
229
-
230
- ## Integration with Development
231
-
232
- ### During Implementation
233
- - Check for breaking changes before implementation
234
- - Generate version comparison reports
235
- - Suggest migration strategies
236
-
237
- ### During Testing
238
- - Test against multiple API versions
239
- - Verify backward compatibility
240
- - Check deprecation warnings
241
-
242
- ### During Documentation
243
- - Generate version-specific docs
244
- - Create migration guides
245
- - Update changelog automatically
246
-
247
- ---
248
-
249
- ## Best Practices
250
-
251
- 1. **Version early** - Add versioning from the start
252
- 2. **Document changes** - Keep detailed changelogs
253
- 3. **Communicate** - Give advance notice of breaking changes
254
- 4. **Support transitions** - Maintain deprecated versions during migration
255
- 5. **Monitor usage** - Track version usage to guide sunset decisions
256
- 6. **Test thoroughly** - Test both old and new versions
257
- 7. **Use semantic versioning** - Major.Minor.Patch for clear communication
@@ -1,225 +0,0 @@
1
- # API Changelog Template
2
-
3
- Document API changes for each version.
4
-
5
- ---
6
-
7
- ## Changelog Format
8
-
9
- ```markdown
10
- # API Changelog
11
-
12
- All notable changes to the API are documented here.
13
-
14
- ## [v2.1.0] - 2024-01-15
15
-
16
- ### Added
17
- - `GET /users/{id}/preferences` - Fetch user preferences
18
- - `PUT /users/{id}/preferences` - Update user preferences
19
- - `avatar_url` field to user response
20
-
21
- ### Changed
22
- - `POST /auth/login` now returns refresh token in response body
23
- - Rate limit increased from 100 to 200 requests/minute
24
-
25
- ### Deprecated
26
- - `GET /users/{id}/settings` - Use `/preferences` instead (removal: v3.0.0)
27
-
28
- ### Fixed
29
- - Fixed pagination returning duplicate items
30
- - Fixed date format inconsistency in responses
31
-
32
- ### Security
33
- - Added rate limiting to password reset endpoint
34
-
35
- ---
36
-
37
- ## [v2.0.0] - 2024-01-01
38
-
39
- ### Breaking Changes
40
- - Response wrapper: All responses now wrapped in `{ data: ... }`
41
- - Authentication: Moved from query parameter to Bearer token
42
- - User ID: Changed from integer to UUID
43
-
44
- ### Added
45
- - `POST /auth/refresh` - Refresh access token
46
- - `DELETE /users/{id}` - Delete user account
47
- - Pagination metadata in list responses
48
-
49
- ### Changed
50
- - Error response format standardized
51
- - All timestamps now in ISO 8601 format
52
-
53
- ### Removed
54
- - `GET /users/search` - Use query parameters on `GET /users` instead
55
- - `api_key` query parameter authentication
56
-
57
- ### Migration
58
- See [v1 to v2 Migration Guide](./migration/v1-to-v2.md)
59
- ```
60
-
61
- ---
62
-
63
- ## Entry Types
64
-
65
- ### Added
66
- New endpoints, fields, or features.
67
-
68
- ```markdown
69
- ### Added
70
- - `GET /products/{id}/reviews` - List product reviews
71
- - `rating` field added to product response
72
- - Support for `sort` query parameter on list endpoints
73
- ```
74
-
75
- ### Changed
76
- Modifications to existing behavior.
77
-
78
- ```markdown
79
- ### Changed
80
- - `POST /orders` now requires `shipping_address` field
81
- - Default page size changed from 10 to 20
82
- - Error messages now include request ID
83
- ```
84
-
85
- ### Deprecated
86
- Features marked for future removal.
87
-
88
- ```markdown
89
- ### Deprecated
90
- - `GET /legacy/users` - Use `GET /users` instead
91
- - Deprecation date: 2024-03-01
92
- - Removal date: 2024-09-01
93
- - Migration guide: [link]
94
- ```
95
-
96
- ### Removed
97
- Features that have been removed.
98
-
99
- ```markdown
100
- ### Removed
101
- - `GET /v1/users` - Sunset completed
102
- - `api_key` authentication method
103
- - `legacy_id` field from user response
104
- ```
105
-
106
- ### Fixed
107
- Bug fixes.
108
-
109
- ```markdown
110
- ### Fixed
111
- - Fixed 500 error when email contains special characters
112
- - Fixed incorrect count in pagination response
113
- - Fixed timezone handling in date filters
114
- ```
115
-
116
- ### Security
117
- Security-related changes.
118
-
119
- ```markdown
120
- ### Security
121
- - Added CSRF protection to all state-changing endpoints
122
- - Implemented rate limiting on authentication endpoints
123
- - Fixed XSS vulnerability in user bio field
124
- ```
125
-
126
- ---
127
-
128
- ## Version Entry Template
129
-
130
- ```markdown
131
- ## [vX.Y.Z] - YYYY-MM-DD
132
-
133
- ### Summary
134
- Brief description of this release.
135
-
136
- ### Breaking Changes
137
- - [List breaking changes with migration instructions]
138
-
139
- ### Added
140
- - [New endpoint/feature] - [Description]
141
-
142
- ### Changed
143
- - [Modified behavior] - [What changed]
144
-
145
- ### Deprecated
146
- - [Feature] - [Replacement and timeline]
147
-
148
- ### Removed
149
- - [Feature] - [Reason]
150
-
151
- ### Fixed
152
- - [Bug] - [What was fixed]
153
-
154
- ### Security
155
- - [Security improvement]
156
-
157
- ### Documentation
158
- - [Documentation updates]
159
-
160
- ### Internal
161
- - [Internal changes not affecting API consumers]
162
- ```
163
-
164
- ---
165
-
166
- ## Automation
167
-
168
- ### Auto-Generate Changelog Entry
169
-
170
- ```yaml
171
- # When creating PR for API changes
172
- api_changelog:
173
- auto_generate: true
174
-
175
- detect_from:
176
- - route_changes
177
- - schema_changes
178
- - middleware_changes
179
-
180
- require_entry_for:
181
- - breaking_changes
182
- - new_endpoints
183
- - deprecated_features
184
- ```
185
-
186
- ### PR Template for API Changes
187
-
188
- ```markdown
189
- ## API Change Description
190
-
191
- ### Type of Change
192
- - [ ] New endpoint
193
- - [ ] Modified endpoint
194
- - [ ] Deprecated endpoint
195
- - [ ] Breaking change
196
- - [ ] Bug fix
197
- - [ ] Security fix
198
-
199
- ### Changelog Entry
200
- ```
201
- ### Added/Changed/Deprecated/Fixed
202
- - [Your changelog entry here]
203
- ```
204
-
205
- ### Breaking Change Details
206
- If breaking change, describe:
207
- - What breaks
208
- - Migration steps
209
- - Timeline
210
-
211
- ### Documentation
212
- - [ ] API docs updated
213
- - [ ] Changelog updated
214
- - [ ] Migration guide created (if breaking)
215
- ```
216
-
217
- ---
218
-
219
- ## Commands
220
-
221
- | Command | Description |
222
- |---------|-------------|
223
- | `pa:api-changelog add` | Add changelog entry |
224
- | `pa:api-changelog view` | View API changelog |
225
- | `pa:api-changelog generate` | Auto-generate from changes |