Configurations

Upsert

post

Upsert a configuration entry.

Creates a new configuration if the provided id does not exist, or updates the existing configuration with the given id.

Args: request (Configuration): The configuration data to insert or update. db (AsyncSession): The database session dependency.

Returns: JSONResponse: A JSON response containing the configuration data that was upserted.

Raises: HTTPException: If the operation encounters an unexpected error (not currently implemented, but can be added for error handling).

Notes: - Uses FastCRUD for abstracted DB operations. - Relies on the id field to determine insert vs update.

Required scopes

This endpoint requires the following scopes:

• : Read Permissions

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Body

application/json

Configuration model.

idintegerRequired

namestringRequired

titleany ofRequired

stringOptional

or

nullOptional

valueany ofRequired

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/configurations/upsert

HTTPcURLJavaScriptPython

POST /configurations/upsert HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "id": 1,
  "name": "text",
  "title": "text",
  "value": "text"
}

No content

Get

get

Read multiple ConfigurationModel rows from the database.

• Use page & itemsPerPage for paginated results

• Use offset & limit for specific ranges

• Returns paginated response when using page/itemsPerPage

• Returns simple list response when using offset/limit

Required scopes

This endpoint requires the following scopes:

• : Read Permissions

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Query parameters

offsetany ofOptional

Offset for unpaginated queries

integerOptional

or

nullOptional

limitany ofOptional

Limit for unpaginated queries

integerOptional

or

nullOptional

pageany ofOptional

Page number

integerOptional

or

nullOptional

itemsPerPageany ofOptional

Number of items per page

integerOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany of

or

422

Validation Error

application/json

get

/configurations

HTTPcURLJavaScriptPython

GET /configurations HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "data": [
    {
      "id": 1,
      "name": "text",
      "title": "text",
      "value": "text"
    }
  ],
  "total_count": 1,
  "has_more": true,
  "page": 1,
  "items_per_page": 1
}

Create

post

Create a new ConfigurationModel row in the database.

Required scopes

This endpoint requires the following scopes:

• : Read Permissions

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Body

application/json

Create Configuration model.

namestringRequired

titlestringRequired

valuestringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/configurations

HTTPcURLJavaScriptPython

POST /configurations HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "name": "text",
  "title": "text",
  "value": "text"
}

No content

Get

get

Read a single ConfigurationModel row from the database by its primary keys: ['id'].

Required scopes

This endpoint requires the following scopes:

• : Read Permissions

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

idintegerRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/configurations/{id}

HTTPcURLJavaScriptPython

GET /configurations/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": 1,
  "name": "text",
  "title": "text",
  "value": "text"
}

Delete

delete

Delete a ConfigurationModel row from the database by its primary keys: ['id'].

Required scopes

This endpoint requires the following scopes:

• : Read Permissions

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

idintegerRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/configurations/{id}

HTTPcURLJavaScriptPython

DELETE /configurations/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Update

patch

Update an existing ConfigurationModel row in the database by its primary keys: ['id'].

Required scopes

This endpoint requires the following scopes:

• : Read Permissions

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

idintegerRequired

Body

application/json

Create Configuration model.

namestringRequired

titlestringRequired

valuestringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

patch

/configurations/{id}

HTTPcURLJavaScriptPython

PATCH /configurations/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "name": "text",
  "title": "text",
  "value": "text"
}

No content