@lunch-money/v2-api-spec 2.8.5 → 2.9.0
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/README.md.backup +12 -0
- package/lunch-money-api-v2.yaml +2671 -2330
- package/package.json +1 -1
- package/version-history.md +10 -1
package/README.md.backup
CHANGED
|
@@ -66,6 +66,18 @@ The OpenAPI spec is the authoritative source for:
|
|
|
66
66
|
- Authentication requirements
|
|
67
67
|
- Status codes and error formats
|
|
68
68
|
|
|
69
|
+
##### Versioning
|
|
70
|
+
|
|
71
|
+
The Lunch Money API spec uses a modified version of SEMVER for its versioning methodology as follows
|
|
72
|
+
- The major version is the API version. This will always be 2 in this repo
|
|
73
|
+
- The minor version represents the number of main endpoints (or OpenAPI tags) the current version of the spec supports. For example, a version of the API that supports the /me, /categories, and /transactions endpoints would have a minor version of 3
|
|
74
|
+
- The revision number represents the number of updates since the last endpoint was added. For example, each time changes are made to one of the existing three APIs as described above, the revision number will be bumped.
|
|
75
|
+
|
|
76
|
+
Details of each version can be found in [./version-history.md](./version-history.md)
|
|
77
|
+
|
|
78
|
+
Changes to the spec that modify existing or add new API endpoints should update the version number in the spec and in the package.json accordingly.
|
|
79
|
+
|
|
80
|
+
|
|
69
81
|
### Documentation Guides (`v2/docs/*.md`)
|
|
70
82
|
- **Purpose**: Human-readable guides and tutorials
|
|
71
83
|
- **Format**: Markdown with custom extensions
|