Skip to content

feat!: breaking changes v1.5.0 — remove phone field + narrow order status enum #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zsobpeter-code wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat!: breaking changes v1.5.0 — remove phone field + narrow order status enum #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 2 additions & 11 deletions api/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ openapi: "3.0.3"
info:
title: Acme API
description: "The Acme API provides programmatic access to user management, order processing, payment handling, and webhook integrations for the Acme platform."
version: "1.4.0"
version: "1.5.0"
contact:
name: Acme API Team
email: api@acme.example.com
Expand Down Expand Up @@ -38,7 +38,6 @@ paths:
id: "usr_abc123"
email: "jane@example.com"
name: "Jane Doe"
phone: "+1-555-0100"
created_at: "2025-01-15T10:30:00Z"
"404":
description: User not found
Expand All @@ -63,7 +62,6 @@ paths:
example:
email: "jane@example.com"
name: "Jane Doe"
phone: "+1-555-0100"
responses:
"201":
description: User created successfully
Expand Down Expand Up @@ -286,10 +284,6 @@ components:
name:
type: string
description: "User's display name."
phone:
type: string
nullable: true
description: "User's phone number in E.164 format."
created_at:
type: string
format: date-time
Expand All @@ -307,9 +301,6 @@ components:
name:
type: string
description: "Display name for the new account."
phone:
type: string
description: "Optional phone number."
Order:
type: object
description: "Represents a customer order with line items and status."
Expand All @@ -334,7 +325,7 @@ components:
description: "ISO 4217 currency code."
status:
type: string
enum: [pending, confirmed, shipped, delivered]
enum: [pending, confirmed, shipped]
description: "Current order fulfillment status."
items:
type: array
Expand Down