API Doc Title

This is the description of API Doc

Endpoints

Path	Method	Params	Type	Description	Meta	Response
/address	GET Get address	id*	string	Address ID		Address
/array-data	GET Get array data	items	array	List of item IDs to retrieve		Groceries
/calendar/{year}/{month}	GET Get schedule	date	string	Target date (YYYY-MM-DD format)		Calendar Event
/card	GET Get card	id*	string	Card ID		Card
/contact	POST	name*	string
		email*	string
		age	int
		subject*	string
/index	GET API entry point
/input-edge-cases	POST	builtinType*	string
/input-edge-cases	PUT	noCtor*	FakeVendor\FakeProject\Resource\App\NoConstructorInput
/missing-schema	GET Get data with non-existent schema
/numbers	GET Get numbers	count	int	Number of items to return		Numbers
/org	GET Get organization	id*	string	Organization ID		Org
/person	GET Get person goPerson	id	string	Unique identifier of the person	example: person_12345	Person
	POST Register member doCreatePerson	firstName*	string	The person's first/given name	minLength: 1 maxLength: 50 example: John
		familyName	string	The person's family/last name	maxLength: 50 example: Doe
		age	int	Age in years	minimum: 0 maximum: 150 example: 30
	PATCH Update profile	id*	string	Unique identifier of the person	example: person_12345
		firstName	string	The person's first/given name	minLength: 1 maxLength: 50 example: John
		familyName	string	The person's family/last name	maxLength: 50 example: Doe
		age	int	Age in years	minimum: 0 maximum: 150 example: 30
/ticket/{id}	GET Get a ticket Retrieve detailed information about a specific support ticket.	id*	string	The unique identifier for a ticket	example: TKT-2024-001	Ticket
	POST Create a new ticket Create a new support ticket in the system. This endpoint allows you to submit customer inquiries, bug reports, feature requests, and other issues that need to be tracked and resolved by the support team. The ticket will be automatically assigned a unique identifier and timestamps for creation and last update.	title*	string	Brief summary of the issue or request	minLength: 3 maxLength: 255 example: Cannot login to dashboard
		description	string	Detailed explanation of the issue	maxLength: 2000 example: When I click login, I get a 500 error
		assignee	string	Username of the support agent	example: john.smith
	PUT Update a ticket Modify an existing ticket's information.	id*	string	The unique identifier for a ticket	example: TKT-2024-001
		title	string	Brief summary of the issue or request	minLength: 3 maxLength: 255 example: Cannot login to dashboard
		status	string	Current status of the ticket	enum: ["open","in_progress","waiting","resolved","closed"] example: in_progress
		assignee	string	Username of the support agent	example: john.smith
		description	string	Detailed explanation of the issue	maxLength: 2000 example: When I click login, I get a 500 error
	DELETE Delete a ticket Permanently remove a ticket from the system.	id*	string	The unique identifier for a ticket	example: TKT-2024-001
/tickets	GET				Collection of Tickets
/union-type	GET Test union type parameter	id*	string	ID can be int or string
/users/{id}	GET Get user profile Retrieve detailed profile information for a specific user. getUser	id*	string	Unique identifier for the user	example: usr_abc123	User
		options	string	Display options	enum: ["guest","full","minimal"] example: full	User
	POST Create a new user Register a new user account in the system. createUser	name*	string	Display name of the user	example: Jane Smith
		age*	int	Age of the user in years	minimum: 0 maximum: 150 example: 29
		email	string	Email address for the account	format: email example: jane.smith@example.com
	PUT Update user profile Modify existing user account information. updateUser	id*	string	Unique identifier for the user	example: usr_abc123
		name	string	Display name of the user	example: Jane Smith
		age	int	Age of the user in years	minimum: 0 maximum: 150 example: 29
		email	string	Email address for the account	format: email example: jane.smith@example.com
		enabled	bool	Whether the account is active	example: true
	DELETE Delete user account Permanently delete a user account and associated data. deleteUser	id*	string	Unique identifier for the user	example: usr_abc123
/ticket/assign	PUT Assign ticket CQRS domain command. Compare with CRUD operations at /ticket.	id*	string	Ticket ID
/ticket/assign		assignee*	string	Username of the assignee

Objects

📄Address

Name	Type	Description	Meta
post-office-box	string	Post Office Box - PO Box number for mail delivery	example: PO Box 1234
extended-address	string	Apartment, suite, or unit number	example: Suite 500
street-address	string	Street number and name	example: 123 Main Street
locality	string	City or town name	example: San Francisco
region	int\|string	State, province, or region	example: CA
postal-code	string	ZIP or postal code	pattern: ^[0-9A-Za-z\- ]+$ example: 94102
country-name	string	Full country name	example: United States

📄Juice

Name	Type	Description	Meta
juiceName	string	The name of the juice.
juiceLike	bool	Do I like this juice?

📄Groceries

Name	Type	Description
fruits	array	List of fruit names
vegetables	array	List of vegetables with preferences
juice	object	Juice preference details

📄Calendar Event

Name	Type	Description	Meta
dtstart	string	Event start date and time in ISO 8601 format	format: date-time example: 2024-03-15T10:00:00Z
dtend	string	Event end date and time in ISO 8601 format	format: date-time example: 2024-03-15T11:30:00Z
summary	string	Brief title or name of the event	maxLength: 255 example: Weekly Team Meeting
location	string	Physical location or virtual meeting URL	example: Conference Room A / https://meet.example.com/abc
url	string	URL with more information about the event	format: uri example: https://example.com/events/weekly-meeting
duration	string	Event duration in ISO 8601 duration format	example: PT1H30M
rdate	string	Additional recurrence date for the event	format: date-time example: 2024-03-22T10:00:00Z
rrule	string	Recurrence rule in iCalendar RRULE format	example: FREQ=WEEKLY;BYDAY=MO,WE,FR;COUNT=10
category	string	Event category for organization and filtering	example: meeting
description	string	Detailed description of the event and agenda	maxLength: 2000 example: Discuss Q1 progress and plan Q2 objectives.

📄Card.Email

Name	Type	Description	Meta
type	string	Category of email (work, home, other)	example: work
value	string	The email address	format: email example: jane.smith@company.com

📄Card.Tel

Name	Type	Description	Meta
type	string	Category of phone (work, home, mobile, fax)	example: mobile
value	string	The phone number	example: +1-555-123-4567

📄Card.Org

Name	Type	Description	Meta
organizationName	string	Name of the organization	example: Acme Corporation
organizationUnit	string	Department or division within organization	example: Engineering

📄Card

Name	Type	Description	Meta
fn	string	Full formatted name as it should be displayed	example: Dr. Jane M. Smith, PhD
familyName	string	Family name (surname/last name)	example: Smith
givenName	string	Given name (first name)	example: Jane
additionalName	array	Middle names or other additional names	example: ["Marie"]
honorificPrefix	array	Name prefixes and titles (e.g., Dr., Mr., Ms.)	example: ["Dr."]
honorificSuffix	array	Name suffixes and post-nominals (e.g., PhD, Jr., III)	example: ["PhD","MBA"]
nickname	string	Preferred informal name or alias	example: Jenny
url	string	Personal or professional website URL	format: uri example: https://janesmith.example.com
email	object	Email address with type classification
tel	object	Telephone number with type classification
tz	string	Timezone in IANA format or UTC offset	example: America/New_York
photo	string	URL to profile photo image	format: uri example: https://example.com/photos/jsmith.jpg
logo	string	URL to company or organization logo	format: uri example: https://company.com/logo.png
sound	string	URL to audio file with name pronunciation	format: uri example: https://example.com/pronunciation/jsmith.mp3
bday	string	Birthday in ISO 8601 date format	format: date example: 1985-06-15
title	string	Job title or position	example: Senior Software Engineer
role	string	Function or role within organization	example: Technical Lead
org	object	Organization or company affiliation

📄Org

Name	Type	Description	Meta
id	string	Organization ID
name	string	Organization name	example: Acme Inc.

📄Person

Name	Type	Description	Meta
firstName	string	The person's first/given name	minLength: 1 maxLength: 50 example: John
familyName	string	The person's family/last name	maxLength: 50 example: Doe
age	int	Age in years (must be 0 or greater)	minimum: 0 maximum: 150 example: 30
org	embed		src: /org?id={org_id}
goCard	link		href: /card?id={card_id}
goTickets	link		href: /tickets
doDelete	link		href: /person?id={id}

📄Ticket

Name	Type	Description	Meta
id	string	Unique identifier for the ticket	example: TKT-2024-001
title	string	Brief summary of the issue or request	minLength: 3 maxLength: 255 example: Cannot login to dashboard
description	string	Detailed explanation of the issue including steps to reproduce	maxLength: 2000 example: When I click the login button, the page shows a 500 error.
assignee	string	Username of the support agent handling this ticket	maxLength: 50 example: john.smith
status	string	Current status of the ticket in the workflow	enum: ["open","in_progress","waiting","resolved","closed"] example: in_progress
priority	string	Urgency level of the ticket	enum: ["low","medium","high","critical"] example: high
created	string	Timestamp when the ticket was created	format: date-time example: 2024-01-15T09:30:00Z
updated	string	Timestamp when the ticket was last modified	format: date-time example: 2024-01-16T14:22:00Z
goAssignee	link		href: /user{?id}

📄User

Name	Type	Description	Meta
id	string	Unique identifier for the user account	maxLength: 30 example: usr_abc123
firstName	string	User's first/given name	maxLength: 30 pattern: [a-zA-Z\-']+ example: Jane
lastName	string	User's last/family name	maxLength: 30 pattern: [a-zA-Z\-']+ example: Smith
created	string	Timestamp when the account was created	format: date-time example: 2024-01-10T08:00:00Z
modified	string	Timestamp of the last profile update	format: date-time example: 2024-02-15T14:30:00Z
email	string	Primary email address for the account	format: email example: jane.smith@example.com
enabled	bool	Whether the account is active and can login	example: true
age	int	User's age in years	example: 29
ticket	embed		src: /ticket/{id}
goPerson	link		href: /person
goCalendar	link		href: /calendar

API Doc Title

Endpoints

Objects

📄Address

📄Juice

📄Groceries

📄Calendar Event

📄Card.Email

📄Card.Tel

📄Card.Org

📄Card

📄Org

📄Person

📄Ticket

📄User

Arrays

📄Numbers

📄Collection of Tickets

Links