API docs by Redocly

API Documentation (1.0.0)

Download OpenAPI specification:

This is a sample API documentation in OpenAPI 3.1 format

Get address

Responses

Response samples

Content type
application/json
{
  • "post-office-box": "PO Box 1234",
  • "extended-address": "Suite 500",
  • "street-address": "123 Main Street",
  • "locality": "San Francisco",
  • "region": "CA",
  • "postal-code": "94102",
  • "country-name": "United States"
}

Get array data

Responses

Response samples

Content type
application/json
{
  • "fruits": [
    ],
  • "vegetables": [
    ],
  • "juice": {
    }
}

Get schedule

path Parameters
year
required
string
month
required
string

Responses

Response samples

Content type
application/json
{
  • "dtstart": "2024-03-15T10:00:00Z",
  • "dtend": "2024-03-15T11:30:00Z",
  • "summary": "Weekly Team Meeting",
  • "location": "Conference Room A / https://meet.example.com/abc",
  • "url": "https://example.com/events/weekly-meeting",
  • "duration": "PT1H30M",
  • "rdate": "2024-03-22T10:00:00Z",
  • "rrule": "FREQ=WEEKLY;BYDAY=MO,WE,FR;COUNT=10",
  • "category": "meeting",
  • "description": "Discuss Q1 progress and plan Q2 objectives."
}

Get card

Responses

Response samples

Content type
application/json
{}

API entry point

Responses

Get data with non-existent schema

Responses

Get numbers

Responses

Response samples

Content type
application/json
[
  • 7
]

Get organization

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "Acme Inc."
}

Get person

query Parameters
id
string
Example: id=person_12345

Unique identifier of the person

Responses

Response samples

Content type
application/json
{
  • "firstName": "John",
  • "familyName": "Doe",
  • "age": 30
}

Register member

query Parameters
firstName
required
string
Example: firstName=John

The person's first/given name

familyName
string
Example: familyName=Doe

The person's family/last name

age
integer
Example: age=30

Age in years

Responses

Update profile

query Parameters
id
required
string
Example: id=person_12345

Unique identifier of the person

firstName
string
Example: firstName=John

The person's first/given name

familyName
string
Example: familyName=Doe

The person's family/last name

age
integer
Example: age=30

Age in years

Responses

Get a ticket

Retrieve detailed information about a specific support ticket.

path Parameters
id
required
string
Example: TKT-2024-001

The unique identifier for a ticket

Responses

Response samples

Content type
application/json
{
  • "id": "TKT-2024-001",
  • "title": "Cannot login to dashboard",
  • "description": "When I click the login button, the page shows a 500 error.",
  • "assignee": "john.smith",
  • "status": "in_progress",
  • "priority": "high",
  • "created": "2024-01-15T09:30:00Z",
  • "updated": "2024-01-16T14:22:00Z"
}

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.

query Parameters
title
required
string
Example: title=Cannot login to dashboard

Brief summary of the issue or request

description
string
Example: description=When I click login, I get a 500 error

Detailed explanation of the issue

assignee
string
Example: assignee=john.smith

Username of the support agent

Responses

Update a ticket

Modify an existing ticket's information.

path Parameters
id
required
string
Example: TKT-2024-001

The unique identifier for a ticket

query Parameters
title
string
Example: title=Cannot login to dashboard

Brief summary of the issue or request

status
string
Example: status=in_progress

Current status of the ticket

assignee
string
Example: assignee=john.smith

Username of the support agent

description
string
Example: description=When I click login, I get a 500 error

Detailed explanation of the issue

Responses

Delete a ticket

Permanently remove a ticket from the system.

path Parameters
id
required
string
Example: TKT-2024-001

The unique identifier for a ticket

Responses

/tickets

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Test union type parameter

Responses

Get user profile

Retrieve detailed profile information for a specific user.

path Parameters
id
required
string
Example: usr_abc123

Unique identifier for the user

query Parameters
options
string
Example: options=full

Display options

Responses

Response samples

Content type
application/json
{
  • "id": "usr_abc123",
  • "firstName": "Jane",
  • "lastName": "Smith",
  • "created": "2024-01-10T08:00:00Z",
  • "modified": "2024-02-15T14:30:00Z",
  • "email": "jane.smith@example.com",
  • "enabled": true,
  • "age": 35,
  • "_links": {
    },
  • "_embedded": {
    }
}

Create a new user

Register a new user account in the system.

query Parameters
name
required
string
Example: name=Jane Smith

Display name of the user

age
required
integer
Example: age=29

Age of the user in years

email
string
Example: email=jane.smith@example.com

Email address for the account

Responses

Update user profile

Modify existing user account information.

path Parameters
id
required
string
Example: usr_abc123

Unique identifier for the user

query Parameters
name
string
Example: name=Jane Smith

Display name of the user

age
integer
Example: age=29

Age of the user in years

email
string
Example: email=jane.smith@example.com

Email address for the account

enabled
boolean
Example: enabled=true

Whether the account is active

Responses

Delete user account

Permanently delete a user account and associated data.

path Parameters
id
required
string
Example: usr_abc123

Unique identifier for the user

Responses

Assign ticket

CQRS domain command. Compare with CRUD operations at /ticket.

Responses