API docs by Redocly

TripFlow API (v1.0.0)

Download OpenAPI specification:

API documentation for TripFlow, the travel planning application.

Statistics

Endpoints for retrieving statistics

Get User Statistics

Retrieves statistics related to the authenticated user.

Authorizations:
auth_token

Responses

Health Check

Endpoint for checking the health status of the application

Health Check Endpoint

Returns the health status of the application.

Authorizations:
auth_token

Responses

Health Check Endpoint

Returns the health status of the application.

Authorizations:
auth_token

Responses

Authentication

Endpoints for user authentication and authorization

User Registration Endpoint

Registers a new user with the provided details.

Authorizations:
auth_token
Request Body schema: application/json
required
username
string
password
string
confirmPassword
string

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string",
  • "confirmPassword": "string"
}

Token Refresh Endpoint

Refreshes the authentication token using a valid refresh token.

Authorizations:
auth_token
cookie Parameters
refresh_token
required
string

Responses

User Logout Endpoint

Logs out the authenticated user and terminates the session.

Authorizations:
auth_token

Responses

User Login Endpoint

Authenticates a user and initiates a session.

Authorizations:
auth_token
Request Body schema: application/json
required
username
string
password
string

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

Itinerary Management

Endpoints for managing itineraries

Get Itinerary by ID

Retrieves the details of a specific itinerary by its ID for the authenticated user.

Authorizations:
auth_token
path Parameters
id
required
integer <int64>

Responses

Update Itinerary

Updates an existing itinerary for the authenticated user.

Authorizations:
auth_token
path Parameters
id
required
integer <int64>
Request Body schema: application/json
required
id
integer <int64>
title
string
place
string
icon
string
people
integer <int32>
budget
number <double>
date
string
tags
Array of strings
updatedCount
integer <int64>
status
string
Enum: "DRAFT" "PLANNED" "ONGOING" "COMPLETED"
Array of objects (ItineraryDayDTO)
countDays
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "place": "string",
  • "icon": "string",
  • "people": 0,
  • "budget": 0.1,
  • "date": "string",
  • "tags": [
    ],
  • "updatedCount": 0,
  • "status": "DRAFT",
  • "days": [
    ],
  • "countDays": 0
}

Delete Itinerary

Deletes an existing itinerary for the authenticated user.

Authorizations:
auth_token
path Parameters
id
required
integer <int64>

Responses

Get All Itineraries

Retrieves a paginated list of itineraries for the authenticated user.

Authorizations:
auth_token
query Parameters
required
object (Pageable)
search
string

Responses

Create Itinerary

Creates a new itinerary for the authenticated user.

Authorizations:
auth_token
Request Body schema: application/json
required
id
integer <int64>
title
string
place
string
icon
string
people
integer <int32>
budget
number <double>
date
string
tags
Array of strings
updatedCount
integer <int64>
status
string
Enum: "DRAFT" "PLANNED" "ONGOING" "COMPLETED"
Array of objects (ItineraryDayDTO)
countDays
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "place": "string",
  • "icon": "string",
  • "people": 0,
  • "budget": 0.1,
  • "date": "string",
  • "tags": [
    ],
  • "updatedCount": 0,
  • "status": "DRAFT",
  • "days": [
    ],
  • "countDays": 0
}

Get All Itineraries

Retrieves a paginated list of itineraries for the authenticated user.

Authorizations:
auth_token
query Parameters
required
object (Pageable)
search
string

Responses

Create Itinerary

Creates a new itinerary for the authenticated user.

Authorizations:
auth_token
Request Body schema: application/json
required
id
integer <int64>
title
string
place
string
icon
string
people
integer <int32>
budget
number <double>
date
string
tags
Array of strings
updatedCount
integer <int64>
status
string
Enum: "DRAFT" "PLANNED" "ONGOING" "COMPLETED"
Array of objects (ItineraryDayDTO)
countDays
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "place": "string",
  • "icon": "string",
  • "people": 0,
  • "budget": 0.1,
  • "date": "string",
  • "tags": [
    ],
  • "updatedCount": 0,
  • "status": "DRAFT",
  • "days": [
    ],
  • "countDays": 0
}