@lunch-money/developer-docs 2.11.1-preview.9 → 2.11.1
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 +1 -13
- package/docs/branding-your-app.md +1 -1
- package/manifest.json +0 -101
- package/package.json +3 -3
- package/v2/docs/version-history.md +1 -3
- package/v2/spec/lunch-money-api-v2.yaml +1 -310
- package/docs/oauth/authorization-code.md +0 -80
- package/docs/oauth/concepts.md +0 -46
- package/docs/oauth/development.md +0 -57
- package/docs/oauth/index.md +0 -28
- package/docs/oauth/native-apps.md +0 -26
- package/docs/oauth/oauth-scope-catalog-design.md +0 -370
- package/docs/oauth/register-client.md +0 -51
- package/docs/oauth/review-and-approval.md +0 -57
- package/docs/oauth/scopes.md +0 -104
- package/docs/oauth/security.md +0 -44
- package/docs/oauth/tokens.md +0 -66
- package/docs/oauth/troubleshooting.md +0 -132
- package/v2/images/oauth-authorization-flow.svg +0 -32
- package/v2/images/oauth-token-lifecycle.svg +0 -14
package/README.md
CHANGED
|
@@ -45,22 +45,10 @@ const intro = fs.readFileSync(path.join(docsRoot, 'docs/getting-started.md'), 'u
|
|
|
45
45
|
}
|
|
46
46
|
],
|
|
47
47
|
"redirects": [ /* { from, to, status } */ ],
|
|
48
|
-
"sidebar": {
|
|
49
|
-
"docs": [
|
|
50
|
-
{
|
|
51
|
-
"section": "OAUTH",
|
|
52
|
-
"collapsed": true, // optional; initially collapse this section
|
|
53
|
-
"items": [ /* { label, path, external? } */ ]
|
|
54
|
-
}
|
|
55
|
-
],
|
|
56
|
-
"v1": [ /* … */ ]
|
|
57
|
-
}
|
|
48
|
+
"sidebar": { "docs": [ /* … */ ], "v1": [ /* … */ ] }
|
|
58
49
|
}
|
|
59
50
|
```
|
|
60
51
|
|
|
61
|
-
Sidebar sections initially appear expanded unless their optional `collapsed`
|
|
62
|
-
property is `true`.
|
|
63
|
-
|
|
64
52
|
## Versioning
|
|
65
53
|
|
|
66
54
|
The package version tracks the newest API version this content documents (e.g. `2.11.x`
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
Building a tool, plugin, or integration on top of Lunch Money? Use the official **Powered by Lunch Money** badge to credit the connection clearly — without implying that your app *is* Lunch Money.
|
|
4
4
|
|
|
5
5
|
<a href="https://lunchmoney.app/assets/images/media-kit/powered-by-lunch-money-badge.png" download="powered-by-lunch-money-badge.png" target="_blank" rel="noopener noreferrer" title="Download Powered by Lunch Money badge">
|
|
6
|
-
<img src="/v2/images/powered-by-lunch-money-badge.png" alt="Powered by Lunch Money badge" />
|
|
6
|
+
<img src="/v2/images/powered-by-lunch-money-badge.png" alt="Powered by Lunch Money badge" width="320" />
|
|
7
7
|
</a>
|
|
8
8
|
|
|
9
9
|
> [!TIP]
|
package/manifest.json
CHANGED
|
@@ -73,94 +73,6 @@
|
|
|
73
73
|
"type": "markdown",
|
|
74
74
|
"aliases": ["/v2/branding-your-app"]
|
|
75
75
|
},
|
|
76
|
-
{
|
|
77
|
-
"path": "/oauth",
|
|
78
|
-
"file": "docs/oauth/index.md",
|
|
79
|
-
"title": "OAuth Overview",
|
|
80
|
-
"section": "OAUTH",
|
|
81
|
-
"type": "markdown",
|
|
82
|
-
"aliases": ["/v2/oauth", "/v2/oauth/"]
|
|
83
|
-
},
|
|
84
|
-
{
|
|
85
|
-
"path": "/oauth/concepts",
|
|
86
|
-
"file": "docs/oauth/concepts.md",
|
|
87
|
-
"title": "OAuth Concepts",
|
|
88
|
-
"section": "OAUTH",
|
|
89
|
-
"type": "markdown",
|
|
90
|
-
"aliases": ["/v2/oauth/concepts"]
|
|
91
|
-
},
|
|
92
|
-
{
|
|
93
|
-
"path": "/oauth/register-client",
|
|
94
|
-
"file": "docs/oauth/register-client.md",
|
|
95
|
-
"title": "Register an OAuth Client",
|
|
96
|
-
"section": "OAUTH",
|
|
97
|
-
"type": "markdown",
|
|
98
|
-
"aliases": ["/v2/oauth/register-client"]
|
|
99
|
-
},
|
|
100
|
-
{
|
|
101
|
-
"path": "/oauth/authorization-code",
|
|
102
|
-
"file": "docs/oauth/authorization-code.md",
|
|
103
|
-
"title": "Implement Authorization",
|
|
104
|
-
"section": "OAUTH",
|
|
105
|
-
"type": "markdown",
|
|
106
|
-
"aliases": ["/v2/oauth/authorization-code"]
|
|
107
|
-
},
|
|
108
|
-
{
|
|
109
|
-
"path": "/oauth/development",
|
|
110
|
-
"file": "docs/oauth/development.md",
|
|
111
|
-
"title": "Develop and Test",
|
|
112
|
-
"section": "OAUTH",
|
|
113
|
-
"type": "markdown",
|
|
114
|
-
"aliases": ["/v2/oauth/development"]
|
|
115
|
-
},
|
|
116
|
-
{
|
|
117
|
-
"path": "/oauth/tokens",
|
|
118
|
-
"file": "docs/oauth/tokens.md",
|
|
119
|
-
"title": "Token Lifecycle",
|
|
120
|
-
"section": "OAUTH",
|
|
121
|
-
"type": "markdown",
|
|
122
|
-
"aliases": ["/v2/oauth/tokens"]
|
|
123
|
-
},
|
|
124
|
-
{
|
|
125
|
-
"path": "/oauth/security",
|
|
126
|
-
"file": "docs/oauth/security.md",
|
|
127
|
-
"title": "OAuth Security",
|
|
128
|
-
"section": "OAUTH",
|
|
129
|
-
"type": "markdown",
|
|
130
|
-
"aliases": ["/v2/oauth/security"]
|
|
131
|
-
},
|
|
132
|
-
{
|
|
133
|
-
"path": "/oauth/troubleshooting",
|
|
134
|
-
"file": "docs/oauth/troubleshooting.md",
|
|
135
|
-
"title": "Troubleshoot OAuth",
|
|
136
|
-
"section": "OAUTH",
|
|
137
|
-
"type": "markdown",
|
|
138
|
-
"aliases": ["/v2/oauth/troubleshooting"]
|
|
139
|
-
},
|
|
140
|
-
{
|
|
141
|
-
"path": "/oauth/review-and-approval",
|
|
142
|
-
"file": "docs/oauth/review-and-approval.md",
|
|
143
|
-
"title": "OAuth Client Review and Approval",
|
|
144
|
-
"section": "OAUTH",
|
|
145
|
-
"type": "markdown",
|
|
146
|
-
"aliases": ["/v2/oauth/review-and-approval"]
|
|
147
|
-
},
|
|
148
|
-
{
|
|
149
|
-
"path": "/oauth/native-apps",
|
|
150
|
-
"file": "docs/oauth/native-apps.md",
|
|
151
|
-
"title": "Native Apps",
|
|
152
|
-
"section": "OAUTH",
|
|
153
|
-
"type": "markdown",
|
|
154
|
-
"aliases": ["/v2/oauth/native-apps"]
|
|
155
|
-
},
|
|
156
|
-
{
|
|
157
|
-
"path": "/oauth/scopes",
|
|
158
|
-
"file": "docs/oauth/scopes.md",
|
|
159
|
-
"title": "OAuth Scopes",
|
|
160
|
-
"section": "OAUTH",
|
|
161
|
-
"type": "markdown",
|
|
162
|
-
"aliases": ["/v2/oauth/scopes"]
|
|
163
|
-
},
|
|
164
76
|
{
|
|
165
77
|
"path": "/v2/overview",
|
|
166
78
|
"file": "v2/docs/intro-to-v2.md",
|
|
@@ -299,19 +211,6 @@
|
|
|
299
211
|
{ "label": "Using the API with AI", "path": "/using-with-ai" },
|
|
300
212
|
{ "label": "Branding your App", "path": "/branding-your-app" }
|
|
301
213
|
]},
|
|
302
|
-
{ "section": "OAUTH", "collapsed": true, "items": [
|
|
303
|
-
{ "label": "OAuth Overview", "path": "/oauth" },
|
|
304
|
-
{ "label": "Concepts", "path": "/oauth/concepts" },
|
|
305
|
-
{ "label": "Register a Client", "path": "/oauth/register-client" },
|
|
306
|
-
{ "label": "Implement Authorization", "path": "/oauth/authorization-code" },
|
|
307
|
-
{ "label": "Develop and Test", "path": "/oauth/development" },
|
|
308
|
-
{ "label": "Token Lifecycle", "path": "/oauth/tokens" },
|
|
309
|
-
{ "label": "Security", "path": "/oauth/security" },
|
|
310
|
-
{ "label": "Troubleshooting", "path": "/oauth/troubleshooting" },
|
|
311
|
-
{ "label": "Review and Approval", "path": "/oauth/review-and-approval" },
|
|
312
|
-
{ "label": "Native Apps", "path": "/oauth/native-apps" },
|
|
313
|
-
{ "label": "Scope Catalog", "path": "/oauth/scopes" }
|
|
314
|
-
]},
|
|
315
214
|
{ "section": "REFERENCE", "items": [
|
|
316
215
|
{ "label": "v2 API Overview", "path": "/v2/overview" },
|
|
317
216
|
{ "label": "v2 API Reference", "path": "/v2/docs", "external": true },
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@lunch-money/developer-docs",
|
|
3
|
-
"version": "2.11.1
|
|
3
|
+
"version": "2.11.1",
|
|
4
4
|
"description": "Developer documentation content for Lunch Money APIs",
|
|
5
5
|
"exports": {
|
|
6
6
|
".": "./package.json",
|
|
@@ -18,8 +18,8 @@
|
|
|
18
18
|
"access": "public"
|
|
19
19
|
},
|
|
20
20
|
"scripts": {
|
|
21
|
-
"validate:manifest": "node
|
|
22
|
-
"prepack": "node
|
|
21
|
+
"validate:manifest": "node scripts/validate-manifest.js",
|
|
22
|
+
"prepack": "node scripts/validate-manifest.js && node scripts/prepack.js",
|
|
23
23
|
"postpack": "node scripts/postpack.js"
|
|
24
24
|
},
|
|
25
25
|
"keywords": [
|
|
@@ -5,9 +5,7 @@ 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.1 -
|
|
9
|
-
- Add the OAuth scope and scope-group catalog mapped to V2 `operationId` values
|
|
10
|
-
- Document OAuth 2.0 authorization-code endpoints and required OAuth scopes for every V2 operation
|
|
8
|
+
## v2.11.1 - Sep 28, 2026
|
|
11
9
|
- Add `GET /me/account/settings` and `PUT /me/account/settings` for account-level settings
|
|
12
10
|
- Add `GET /me/user/settings` and `PUT /me/user/settings` for user-level display and formatting preferences
|
|
13
11
|
- Add `GET /me/user/account/settings` and `PUT /me/user/account/settings` for settings specific to a user and budgeting account
|