@lunch-money/v2-api-spec 2.11.1 → 2.11.2-preview.10
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 +17 -0
- package/lunch-money-api-v2.yaml +1082 -1747
- package/oauth-client-logo/index.d.ts +27 -0
- package/oauth-client-logo/index.js +32 -0
- package/oauth-scopes/catalog.d.ts +9 -0
- package/oauth-scopes/catalog.js +511 -0
- package/oauth-scopes/index.d.ts +2 -0
- package/oauth-scopes/index.js +12 -0
- package/oauth-scopes/types.d.ts +50 -0
- package/oauth-scopes/types.js +2 -0
- package/package.json +34 -3
- package/version-history.md +9 -2
package/package.json
CHANGED
|
@@ -1,16 +1,45 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@lunch-money/v2-api-spec",
|
|
3
|
-
"version": "2.11.
|
|
3
|
+
"version": "2.11.2-preview.10",
|
|
4
4
|
"description": "OpenAPI specification and version history for the Lunch Money v2 API",
|
|
5
5
|
"main": "lunch-money-api-v2.yaml",
|
|
6
|
+
"exports": {
|
|
7
|
+
".": "./lunch-money-api-v2.yaml",
|
|
8
|
+
"./lunch-money-api-v2.yaml": "./lunch-money-api-v2.yaml",
|
|
9
|
+
"./version-history.md": "./version-history.md",
|
|
10
|
+
"./oauth-scopes": {
|
|
11
|
+
"types": "./oauth-scopes/index.d.ts",
|
|
12
|
+
"require": "./oauth-scopes/index.js",
|
|
13
|
+
"default": "./oauth-scopes/index.js"
|
|
14
|
+
},
|
|
15
|
+
"./oauth-client-logo": {
|
|
16
|
+
"types": "./oauth-client-logo/index.d.ts",
|
|
17
|
+
"require": "./oauth-client-logo/index.js",
|
|
18
|
+
"default": "./oauth-client-logo/index.js"
|
|
19
|
+
},
|
|
20
|
+
"./package.json": "./package.json",
|
|
21
|
+
"./*": "./*"
|
|
22
|
+
},
|
|
6
23
|
"files": [
|
|
7
24
|
"lunch-money-api-v2.yaml",
|
|
8
25
|
"version-history.md",
|
|
26
|
+
"oauth-scopes",
|
|
27
|
+
"oauth-client-logo",
|
|
9
28
|
"README.md"
|
|
10
29
|
],
|
|
11
30
|
"scripts": {
|
|
12
31
|
"prepare": "husky install",
|
|
13
|
-
"
|
|
32
|
+
"build:oauth-scopes": "tsc -p tsconfig.oauth-scopes.json",
|
|
33
|
+
"build:oauth-client-logo": "tsc -p tsconfig.oauth-client-logo.json",
|
|
34
|
+
"build:shared-contracts": "npm run build:oauth-scopes && npm run build:oauth-client-logo",
|
|
35
|
+
"test:oauth-scopes": "npm run build:oauth-scopes && node --test test/oauth-scopes/*.test.js",
|
|
36
|
+
"test:oauth-client-logo": "npm run build:oauth-client-logo && node --test test/oauth-client-logo/*.test.js",
|
|
37
|
+
"generate:oauth-docs": "node scripts/generate-oauth-scope-catalog.js",
|
|
38
|
+
"sync:oauth-sample": "node scripts/sync-oauth-sample-walkthrough.js",
|
|
39
|
+
"check:oauth-sample": "node scripts/sync-oauth-sample-walkthrough.js --check",
|
|
40
|
+
"validate:oauth-sample": "npm run test:oauth-docs && npm run check:oauth-sample --",
|
|
41
|
+
"test:oauth-docs": "node scripts/generate-oauth-scope-catalog.js --check && node --test test/oauth-docs/*.test.js",
|
|
42
|
+
"prepublishOnly": "npm run build:shared-contracts && node scripts/prep-for-publish.js",
|
|
14
43
|
"postpublish": "node scripts/restore-readme.js",
|
|
15
44
|
"publish:docs": "node scripts/publish-docs.js --tag preview",
|
|
16
45
|
"publish:spec": "node scripts/publish-spec.js --tag preview",
|
|
@@ -30,6 +59,8 @@
|
|
|
30
59
|
"author": "",
|
|
31
60
|
"license": "ISC",
|
|
32
61
|
"devDependencies": {
|
|
33
|
-
"husky": "^8.0.3"
|
|
62
|
+
"husky": "^8.0.3",
|
|
63
|
+
"typescript": "^5.9.0",
|
|
64
|
+
"yaml": "^2.8.0"
|
|
34
65
|
}
|
|
35
66
|
}
|
package/version-history.md
CHANGED
|
@@ -5,10 +5,17 @@ The Lunch Money API spec uses a modified version of SEMVER for its versioning me
|
|
|
5
5
|
- The minor version represents the number of main endpoints 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.
|
|
6
6
|
- 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.
|
|
7
7
|
|
|
8
|
-
## v2.11.
|
|
8
|
+
## v2.11.2 - TBD
|
|
9
|
+
- Add OAuth 2.0 bearer-token authentication to the v2 API, allowing applications to access Lunch Money on behalf of users who authorize them
|
|
10
|
+
- Document and enforce required OAuth scopes for every v2 operation and publish the scope and scope-group catalog mapped to V2 `operationId` values.
|
|
11
|
+
- Added a new `403` `insufficient_scope` response
|
|
12
|
+
- Document the OAuth 2.0 authorization-code flow used to obtain access tokens
|
|
13
|
+
- Add `include_files` query parameter to `GET /transactions/{id}`
|
|
14
|
+
|
|
15
|
+
## v2.11.1 - TBD
|
|
9
16
|
- Add `GET /me/account/settings` and `PUT /me/account/settings` for account-level settings
|
|
10
17
|
- Add `GET /me/user/settings` and `PUT /me/user/settings` for user-level display and formatting preferences
|
|
11
|
-
- Add `GET /me/user/account/settings` and `PUT /me/user/account/settings` for settings specific to a user and
|
|
18
|
+
- Add `GET /me/user/account/settings` and `PUT /me/user/account/settings` for settings specific to a user and budget account
|
|
12
19
|
- Add `include_pending_in_totals` to `GET /me/account/settings` and `PUT /me/account/settings`
|
|
13
20
|
- Add `default_manual_account_id` to `GET /me/user/account/settings` and `PUT /me/user/account/settings`
|
|
14
21
|
- Document `GET /budgets/settings` response schema publicly; change `budget_period_quantity` to integer
|