@lunch-money/v2-api-spec 2.11.1-preview.2 → 2.11.1-preview.4

package/README.md

@@ -39,73 +39,11 @@ npx @openapitools/openapi-generator-cli generate \
 npx swagger-cli validate node_modules/@lunch-money/v2-api-spec/lunch-money-api-v2.yaml
 ```
 
-### Updating URLs for Local Development
+### Spec URLs
 
-The package includes a script to help switch between local and production URLs in the OpenAPI specification. This is useful when developing against a local server.
-
-#### Using the Script
-
-The script is located at `node_modules/@lunch-money/v2-api-spec/update-urls.sh`.
-
-**Required flags:**
-- `--local` - Switch URLs to local development (default: `http://localhost:3000/v2`)
-- `--production` - Switch URLs to production deployment URLs
-
-**Switch to production URLs (using defaults):**
-```bash
-cd node_modules/@lunch-money/v2-api-spec
-./update-urls.sh --production
-```
-
-**Switch to production URLs (with custom URLs):**
-```bash
-cd node_modules/@lunch-money/v2-api-spec
-API_DEPLOY_URL=https://api.lunchmoney.app/v2 \
-DOCS_DEPLOY_URL=https://alpha.lunchmoney.app/v2 \
-./update-urls.sh --production
-```
-
-**Switch to local URLs:**
-```bash
-cd node_modules/@lunch-money/v2-api-spec
-./update-urls.sh --local
-```
-
-**Switch to local URLs (with custom local URL):**
-```bash
-cd node_modules/@lunch-money/v2-api-spec
-LOCAL_URL=http://localhost:4000/v2 ./update-urls.sh --local
-```
-
-**Using environment variables:**
-Create a `.env` file in the package directory:
-```bash
-LOCAL_URL=http://localhost:3000/v2
-API_DEPLOY_URL=https://api.lunchmoney.app/v2
-DOCS_DEPLOY_URL=https://alpha.lunchmoney.app/v2
-```
-
-Then run:
-```bash
-./update-urls.sh --production
-# or
-./update-urls.sh --local
-```
-
-#### How It Works
-
-The script updates the `servers` section in the OpenAPI specification:
-- **Server 1**: Typically the production API server
-- **Server 2**: Typically a mock or staging server
-
-It also updates any references to these URLs throughout the specification file.
-
-#### Important Notes
-
-- The script modifies the spec file in place
-- Changes are not persisted across `npm install` - the package will be restored to its original state
-- For persistent changes, consider copying the spec to your project directory first
-- The script works in both the npm package and the git repository
+The published YAML uses public production docs/API URLs. Do not rewrite them in this
+package for local or deploy environments — consuming apps (for example the Lunch Money
+docs/mock server) should rewrite an installed copy when needed.
 
 ## Versioning
 

package/lunch-money-api-v2.yaml

@@ -2,11 +2,13 @@ openapi: 3.0.2
 info:
   title: Lunch Money API - v2
   description: |-
+    Welcome to the Lunch Money v2 API reference. This is the **v2.11.1** spec.
+
     ### Introduction
 
-    The API is available at `https://api.lunchmoney.dev/v2`. Get your access token from the [Lunch Money developers page](https://my.lunchmoney.app/developers).
+    The API is available at `https://lunchmoney.dev/v2`. Get your access token from the [Lunch Money developers page](https://my.lunchmoney.app/developers).
 
-    <span class="red-text"><strong>The v2 API is in open alpha and is still subject to change. Use the mock server or a test budget when getting started.</strong></span>
+    API calls can <span class="red-text"><strong>change or delete</strong></span> your data. Any changes you make are <span class="red-text"><strong>permanent</strong></span>, just like they would be if you made changes using the web or mobile app.   Please refer to the [Getting Started Guide](https://lunchmoney.dev/v2/getting-started) before using the API.
 
     **Static Mock Server**
 
@@ -18,15 +20,15 @@ info:
 
     **Migrating from v1**
 
-    The v2 API is not backwards compatible with v1. See the [Migration Guide](https://alpha.lunchmoney.dev/v2/migration-guide) for details.
+    The v2 API is not backwards compatible with v1. See the [Migration Guide](https://lunchmoney.dev/v2/migration-guide) for details.
 
     **Useful links**
-    - [Developer Portal](https://alpha.lunchmoney.dev/v2/introduction)
-    - [Getting Started Guide](https://alpha.lunchmoney.dev/v2/getting-started)
-    - [v2 API Overview](https://alpha.lunchmoney.dev/v2/overview)
-    - [Version History](https://alpha.lunchmoney.dev/v2/version-history)
-    - [Migration Guide](https://alpha.lunchmoney.dev/v2/migration-guide)
-    - [Rate Limits](https://alpha.lunchmoney.dev/v2/rate-limits)
+    - [Developer Portal](https://lunchmoney.dev/v2/introduction)
+    - [Getting Started Guide](https://lunchmoney.dev/v2/getting-started)
+    - [v2 API Overview](https://lunchmoney.dev/v2/overview)
+    - [Version History](https://lunchmoney.dev/v2/version-history)
+    - [Migration Guide](https://lunchmoney.dev/v2/migration-guide)
+    - [Rate Limits](https://lunchmoney.dev/v2/rate-limits)
   termsOfService: https://lunchmoney.dev/#current-status
   contact:
     email: devsupport@lunchmoney.app
@@ -38,8 +40,8 @@ info:
 servers:
   - url: https://api.lunchmoney.dev/v2
     description: v2 Lunch Money API Server - changes will affect real data!
-#  - url: https://mock.lunchmoney.dev/v2
-  - url: https://lm-v2-api-next-a7fabcab8e9a.herokuapp.com/v2/
+#  - url: https://lunchmoney.dev/v2
+  - url: https://lunchmoney.dev/v2
     description: Static mock version of the v2 Lunch Money API Server
 
 tags:
@@ -2940,7 +2942,7 @@ components:
         currency:
           description: Three-letter lowercase currency code of the transaction
             in ISO 4217 format. Must match one of the [supported
-            currencies](https://lm-v2-api-next-a7fabcab8e9a.herokuapp.com/v2/currencies). If not set
+            currencies](https://lunchmoney.dev/v2/currencies). If not set
             defaults to the user account's primary currency.
           allOf:
             - $ref: "#/components/schemas/currencyEnum"
@@ -9097,19 +9099,19 @@ paths:
           description: Sets the maximum number of transactions to return. If
             more match the filter criteria, the response will include a
             `has_more` attribute set to `true`. See
-            [Pagination](https://lm-v2-api-next-a7fabcab8e9a.herokuapp.com/v2/pagination)
+            [Pagination](https://lunchmoney.dev/v2/pagination)
         - name: offset
           in: query
           schema:
             type: integer
           description: Sets the offset for the records returned. This is
             typically set automatically in the header. See
-            [Pagination](https://lm-v2-api-next-a7fabcab8e9a.herokuapp.com/v2/pagination)
+            [Pagination](https://lunchmoney.dev/v2/pagination)
       responses:
         "200":
           description: Returns an array of transactions. <br><br>The `has_more`
             property is set to `true` if more transactions are available. See
-            [Pagination](https://lm-v2-api-next-a7fabcab8e9a.herokuapp.com/v2/pagination)
+            [Pagination](https://lunchmoney.dev/v2/pagination)
           content:
             application/json:
               schema:

package/package.json

@@ -1,13 +1,12 @@
 {
   "name": "@lunch-money/v2-api-spec",
-  "version": "2.11.1-preview.2",
+  "version": "2.11.1-preview.4",
   "description": "OpenAPI specification and version history for the Lunch Money v2 API",
   "main": "lunch-money-api-v2.yaml",
   "files": [
     "lunch-money-api-v2.yaml",
     "version-history.md",
-    "README.md",
-    "update-urls.sh"
+    "README.md"
   ],
   "scripts": {
     "prepare": "husky install",

package/update-urls.sh

@@ -1,135 +0,0 @@
-#!/bin/bash
-
-# Script to update URLs in the OpenAPI specification file
-# This is useful for switching the docs/mock server URL between local development and production
-# Note: All references to DOCS_DEPLOY_URL throughout the file are toggled; the API server URL remains unchanged
-#
-# Usage:
-#   # In git repo:
-#   ./scripts/update-urls.sh --local|--production
-#   
-#   # In npm package:
-#   ./update-urls.sh --local|--production
-#
-# Flags:
-#   --local       Switch docs/mock server URL to local development (http://localhost:3000/v2)
-#   --production  Switch docs/mock server URL to production deployment URL
-#
-# Environment variables (optional, with defaults):
-#   LOCAL_URL - Local development URL (default: http://localhost:3000/v2)
-#   DOCS_DEPLOY_URL - Docs/mock deployment URL (default: https://alpha.lunchmoney.dev/v2)
-#
-# Examples:
-#   # Switch to production URL (using defaults)
-#   ./update-urls.sh --production
-#
-#   # Switch to production URL (with custom URL)
-#   DOCS_DEPLOY_URL=https://alpha.lunchmoney.dev/v2 ./update-urls.sh --production
-#
-#   # Switch to local URL
-#   ./update-urls.sh --local
-#
-#   # Switch to local URL (with custom local URL)
-#   LOCAL_URL=http://localhost:4000/v2 ./update-urls.sh --local
-
-set -e
-
-# Get the directory where the script is located
-SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
-
-# Determine if we're in the git repo or npm package
-# In git repo: script is in scripts/ subdirectory, spec is in v2/spec/
-# In npm package: script is at root, spec is at root
-if [ -f "$SCRIPT_DIR/../v2/spec/lunch-money-api-v2.yaml" ]; then
-  # In the git repo (script is in scripts/ subdirectory)
-  REPO_ROOT="$(cd "$SCRIPT_DIR/.." && pwd)"
-  SPEC_FILE="$REPO_ROOT/v2/spec/lunch-money-api-v2.yaml"
-elif [ -f "$SCRIPT_DIR/lunch-money-api-v2.yaml" ]; then
-  # In the npm package (script is at root, spec is in same directory)
-  REPO_ROOT="$SCRIPT_DIR"
-  SPEC_FILE="$REPO_ROOT/lunch-money-api-v2.yaml"
-else
-  echo "Error: Could not find lunch-money-api-v2.yaml"
-  echo "  Looked in: $SCRIPT_DIR/v2/spec/"
-  echo "  Looked in: $SCRIPT_DIR/"
-  exit 1
-fi
-
-# Load environment variables from .env file if it exists and variables are not already set
-if [ -f "$REPO_ROOT/.env" ]; then
-  export $(grep -v '^#' "$REPO_ROOT/.env" | xargs)
-fi
-
-# Set default values for the URLs if not provided
-LOCAL_URL=${LOCAL_URL:-"http://localhost:3000/v2"}
-DOCS_DEPLOY_URL=${DOCS_DEPLOY_URL:-"https://alpha.lunchmoney.dev/v2"}
-
-# Function to show help and exit
-show_help() {
-  echo "Usage: $0 --local|--production"
-  echo ""
-  echo "Flags (required):"
-  echo "  --local       Switch docs/mock server URL to local development"
-  echo "  --production  Switch docs/mock server URL to production deployment"
-  echo ""
-  echo "Environment variables (optional, with defaults):"
-  echo "  LOCAL_URL       Local development URL (default: http://localhost:3000/v2)"
-  echo "  DOCS_DEPLOY_URL Docs/mock deployment URL (default: https://alpha.lunchmoney.dev/v2)"
-  echo ""
-  echo "Examples:"
-  echo "  # Switch to production URL (using defaults)"
-  echo "  $0 --production"
-  echo ""
-  echo "  # Switch to production URL (with custom URL)"
-  echo "  DOCS_DEPLOY_URL=https://alpha.lunchmoney.dev/v2 $0 --production"
-  echo ""
-  echo "  # Switch to local URL"
-  echo "  $0 --local"
-  echo ""
-  echo "  # Switch to local URL (with custom local URL)"
-  echo "  LOCAL_URL=http://localhost:4000/v2 $0 --local"
-  echo ""
-  echo "Note: Environment variables can also be set in a .env file in the repository root."
-  echo "Note: All references to DOCS_DEPLOY_URL throughout the file are updated; the API server URL remains unchanged."
-  exit 1
-}
-
-# Function to replace all occurrences of the docs/mock server URL in the spec file
-replace_docs_url() {
-  local from_url=$1
-  local to_url=$2
-
-  if [ ! -f "$SPEC_FILE" ]; then
-    echo "Error: Spec file not found at $SPEC_FILE"
-    exit 1
-  fi
-
-  echo "Updating all references to docs/mock server URL in $SPEC_FILE..."
-  echo "  From: $from_url"
-  echo "  To: $to_url"
-
-  # Replace all occurrences of the URL throughout the entire file
-  # Using sed with proper escaping for URLs
-  # Escape special regex characters in from_url
-  escaped_from_url=$(echo "$from_url" | sed 's/[[\.*^$()+?{|]/\\&/g')
-  # Use a temporary file for cross-platform compatibility
-  sed "s|$escaped_from_url|$to_url|g" "$SPEC_FILE" > "$SPEC_FILE.tmp" && mv "$SPEC_FILE.tmp" "$SPEC_FILE"
-
-  echo "✓ URLs updated successfully"
-}
-
-# Check for required flag
-if [ "$1" == "--local" ]; then
-  echo "Switching docs/mock server URL to local development..."
-  echo "  Using LOCAL_URL: $LOCAL_URL"
-  replace_docs_url "$DOCS_DEPLOY_URL" "$LOCAL_URL"
-elif [ "$1" == "--production" ]; then
-  echo "Switching docs/mock server URL to production..."
-  echo "  Using DOCS_DEPLOY_URL: $DOCS_DEPLOY_URL"
-  replace_docs_url "$LOCAL_URL" "$DOCS_DEPLOY_URL"
-else
-  echo "Error: A flag is required (--local or --production)"
-  echo ""
-  show_help
-fi
-