@nasebanal/cli 0.1.0

package/specs/app-template.yaml

@@ -0,0 +1,486 @@
+openapi: 3.0.3
+info:
+  title: NASEBANAL - App Template API
+  description: >-
+    A template API for NASEBANAL applications. Provides sample CRUD endpoints, user authentication via Auth0 JWT and
+    Personal Access Tokens (PAT), and integration with the Account API.
+
+
+    All responses use a uniform envelope: successful responses are `{ "success": true, "data": ... }` and failures are
+    `{ "success": false, "error": { "code", "message" } }`. This mirrors `successResponse()` / `errorResponse()` in the
+    implementation. The `success` discriminator is pinned with `enum` so both Specmatic stub generation and contract
+    tests treat it as a fixed value per response class.
+  version: 1.1.1
+  contact:
+    name: NASEBANAL
+    url: https://www.nasebanal.com
+servers:
+  - url: http://localhost:8789
+    description: Local dev (wrangler dev)
+  - url: https://api.app-template.nasebanal.com
+    description: Production
+security:
+  - BearerAuth: []
+paths:
+  /api/v1/health:
+    get:
+      operationId: getHealth
+      tags:
+        - Health
+      summary: Health check
+      description: Returns the health status of the API.
+      security: []
+      responses:
+        '200':
+          description: API is healthy
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - success
+                  - data
+                properties:
+                  success:
+                    type: boolean
+                    enum: [true]
+                  data:
+                    type: object
+                    required:
+                      - status
+                      - timestamp
+                    properties:
+                      status:
+                        type: string
+                      timestamp:
+                        type: string
+                        format: date-time
+              examples:
+                valid:
+                  value:
+                    success: true
+                    data:
+                      status: ok
+                      timestamp: '2026-05-14T12:00:00Z'
+  /api/v1/me:
+    get:
+      operationId: getCurrentUser
+      tags:
+        - User
+      summary: Get current user profile
+      description: Returns the authenticated user's profile information from the Account API.
+      responses:
+        '200':
+          description: User profile
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UserResponse'
+              examples:
+                valid:
+                  value:
+                    success: true
+                    data:
+                      id: 42
+                      auth0_sub: auth0|0123456789abcdef
+                      email: user@example.com
+                      name: Sample User
+                      language: ja
+                      plan: pro
+                      subscription_status: active
+                      subscription_expires_at: '2026-12-31T23:59:59Z'
+        '401':
+          $ref: '#/components/responses/Unauthorized'
+  /api/v1/items:
+    get:
+      operationId: listItems
+      tags:
+        - Items
+      summary: List items
+      description: Returns all items belonging to the authenticated user.
+      responses:
+        '200':
+          description: List of items
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - success
+                  - data
+                properties:
+                  success:
+                    type: boolean
+                    enum: [true]
+                  data:
+                    type: object
+                    required:
+                      - data
+                      - total
+                    properties:
+                      data:
+                        type: array
+                        items:
+                          $ref: '#/components/schemas/Item'
+                      total:
+                        type: integer
+              examples:
+                valid:
+                  value:
+                    success: true
+                    data:
+                      data:
+                        - id: itm_a1b2c3d4
+                          user_id: 42
+                          name: My Item
+                          description: A sample item description
+                          created_at: '2026-05-14T12:00:00Z'
+                          updated_at: '2026-05-14T12:00:00Z'
+                      total: 1
+        '401':
+          $ref: '#/components/responses/Unauthorized'
+    post:
+      operationId: createItem
+      tags:
+        - Items
+      summary: Create item
+      description: Creates a new item for the authenticated user.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/CreateItemInput'
+            examples:
+              valid:
+                value:
+                  name: My Item
+                  description: A sample item description
+      responses:
+        '201':
+          description: Item created
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ItemResponse'
+              examples:
+                valid:
+                  value:
+                    success: true
+                    data:
+                      id: itm_a1b2c3d4
+                      user_id: 42
+                      name: My Item
+                      description: A sample item description
+                      created_at: '2026-05-14T12:00:00Z'
+                      updated_at: '2026-05-14T12:00:00Z'
+        '401':
+          $ref: '#/components/responses/Unauthorized'
+  /api/v1/items/{id}:
+    get:
+      operationId: getItem
+      tags:
+        - Items
+      summary: Get item
+      description: Returns a single item by ID.
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+          examples:
+            valid:
+              value: itm_a1b2c3d4
+      responses:
+        '200':
+          description: Item details
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ItemResponse'
+              examples:
+                valid:
+                  value:
+                    success: true
+                    data:
+                      id: itm_a1b2c3d4
+                      user_id: 42
+                      name: My Item
+                      description: A sample item description
+                      created_at: '2026-05-14T12:00:00Z'
+                      updated_at: '2026-05-14T12:00:00Z'
+        '401':
+          $ref: '#/components/responses/Unauthorized'
+        '404':
+          $ref: '#/components/responses/NotFound'
+    put:
+      operationId: updateItem
+      tags:
+        - Items
+      summary: Update item
+      description: Updates an existing item.
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+          examples:
+            valid:
+              value: itm_a1b2c3d4
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/UpdateItemInput'
+            examples:
+              valid:
+                value:
+                  name: Updated Item
+                  description: An updated item description
+      responses:
+        '200':
+          description: Item updated
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ItemResponse'
+              examples:
+                valid:
+                  value:
+                    success: true
+                    data:
+                      id: itm_a1b2c3d4
+                      user_id: 42
+                      name: Updated Item
+                      description: An updated item description
+                      created_at: '2026-05-14T12:00:00Z'
+                      updated_at: '2026-05-15T09:30:00Z'
+        '401':
+          $ref: '#/components/responses/Unauthorized'
+        '404':
+          $ref: '#/components/responses/NotFound'
+    delete:
+      operationId: deleteItem
+      tags:
+        - Items
+      summary: Delete item
+      description: Deletes an item by ID.
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+          examples:
+            valid:
+              value: itm_a1b2c3d4
+      responses:
+        '200':
+          description: Item deleted
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SuccessResponse'
+              examples:
+                valid:
+                  value:
+                    success: true
+                    data:
+                      success: true
+        '401':
+          $ref: '#/components/responses/Unauthorized'
+        '404':
+          $ref: '#/components/responses/NotFound'
+components:
+  securitySchemes:
+    BearerAuth:
+      type: http
+      scheme: bearer
+      bearerFormat: JWT or PAT
+      description: Use either an Auth0 JWT token or a Personal Access Token (PAT) starting with `nbpat_`.
+  schemas:
+    User:
+      type: object
+      required:
+        - id
+        - auth0_sub
+        - email
+        - name
+        - language
+        - plan
+      properties:
+        id:
+          type: integer
+        auth0_sub:
+          type: string
+        email:
+          type: string
+          format: email
+        name:
+          type: string
+        language:
+          type: string
+          enum:
+            - ja
+            - en
+        plan:
+          type: string
+          enum:
+            - free
+            - pro
+            - family
+            - enterprise
+        subscription_status:
+          type: string
+          enum:
+            - active
+            - canceled
+            - past_due
+            - trialing
+            - null
+          nullable: true
+        subscription_expires_at:
+          type: string
+          format: date-time
+          nullable: true
+    UserResponse:
+      type: object
+      required:
+        - success
+        - data
+      properties:
+        success:
+          type: boolean
+          enum: [true]
+        data:
+          $ref: '#/components/schemas/User'
+    Item:
+      type: object
+      required:
+        - id
+        - user_id
+        - name
+        - created_at
+        - updated_at
+      properties:
+        id:
+          type: string
+        user_id:
+          type: integer
+        name:
+          type: string
+        description:
+          type: string
+          nullable: true
+        created_at:
+          type: string
+          format: date-time
+        updated_at:
+          type: string
+          format: date-time
+    ItemResponse:
+      type: object
+      required:
+        - success
+        - data
+      properties:
+        success:
+          type: boolean
+          enum: [true]
+        data:
+          $ref: '#/components/schemas/Item'
+    CreateItemInput:
+      type: object
+      required:
+        - name
+      properties:
+        name:
+          type: string
+          minLength: 1
+          maxLength: 200
+        description:
+          type: string
+          maxLength: 1000
+    UpdateItemInput:
+      type: object
+      properties:
+        name:
+          type: string
+          minLength: 1
+          maxLength: 200
+        description:
+          type: string
+          maxLength: 1000
+    SuccessResponse:
+      type: object
+      required:
+        - success
+        - data
+      properties:
+        success:
+          type: boolean
+          enum: [true]
+        data:
+          type: object
+          required:
+            - success
+          properties:
+            success:
+              type: boolean
+              enum: [true]
+    Error:
+      type: object
+      required:
+        - success
+        - error
+      properties:
+        success:
+          type: boolean
+          enum: [false]
+        error:
+          type: object
+          required:
+            - code
+            - message
+          properties:
+            code:
+              type: string
+            message:
+              type: string
+  responses:
+    Unauthorized:
+      description: Authentication required or invalid token
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+          examples:
+            unauthorized:
+              value:
+                success: false
+                error:
+                  code: AUTH_ERROR
+                  message: No authentication token provided
+    NotFound:
+      description: Resource not found
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+          examples:
+            not_found:
+              value:
+                success: false
+                error:
+                  code: NOT_FOUND
+                  message: Resource not found
+tags:
+  - name: Health
+    description: Health check endpoints
+  - name: User
+    description: User profile endpoints
+  - name: Items
+    description: Sample CRUD endpoints (replace with your domain)