Search Profiles

Upsert

post

Upsert a Search Profile entry.

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

Args: request (SearchProfile): The Search Profile data to insert or update. db (AsyncSession): The database session dependency.

Returns: JSONResponse: A JSON response containing the Search Profile 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 codename field to determine insert vs update.

Required scopes

This endpoint requires the following scopes:

• : Read Permissions

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Body

application/json

Search Profile model.

idintegerRequired

codenamestringRequired

titlestringRequired

typestring · enumRequired

ProfileType is an enumeration that defines various types of profiles used in the application.

Attributes: SEARCH (str): Represents a search profile type. AUTOSUGGEST (str): Represents an autosuggest profile type. SHINGLES (str): Represents a shingles profile type. WEB_SEARCH (str): Represents a web search profile type. DISCOVERY (str): Represents a discovery profile type. DEEP_SEARCH (str): Represents a deep search profile type.

Possible values:

input_processorstring · enumRequired

InputProcessor is an enumeration class that defines various input processing types.

Attributes: CATAPA_MENU (str): Represents the "Catapa Menu" input processing type. GLCHAT (str): Represents the "GLChat" input processing type. NO_MOD (str): Represents the "No Moderation" input processing type.

Possible values:

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/search-profiles/upsert

HTTPcURLJavaScriptPython

POST /search-profiles/upsert HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 153

{
  "id": 1,
  "codename": "text",
  "title": "text",
  "type": "Search",
  "input_processor": "Catapa Menu",
  "providers": [
    {
      "provider_ids": "text",
      "type": "text",
      "params": []
    }
  ]
}

No content

Get

get

Read multiple SearchProfileModel 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

/search-profiles

HTTPcURLJavaScriptPython

GET /search-profiles HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "data": [
    {
      "id": 1,
      "codename": "text",
      "title": "text",
      "type": "Search",
      "input_processor": "Catapa Menu",
      "providers": [
        {
          "provider_ids": "text",
          "type": "text",
          "params": []
        }
      ]
    }
  ],
  "total_count": 1,
  "has_more": true,
  "page": 1,
  "items_per_page": 1
}

Create

post

Create a new SearchProfileModel row in the database.

Required scopes

This endpoint requires the following scopes:

• : Read Permissions

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Body

application/json

Create Search Profile model.

codenamestringRequired

titlestringRequired

typestring · enumRequired

ProfileType is an enumeration that defines various types of profiles used in the application.

Attributes: SEARCH (str): Represents a search profile type. AUTOSUGGEST (str): Represents an autosuggest profile type. SHINGLES (str): Represents a shingles profile type. WEB_SEARCH (str): Represents a web search profile type. DISCOVERY (str): Represents a discovery profile type. DEEP_SEARCH (str): Represents a deep search profile type.

Possible values:

input_processorstring · enumRequired

InputProcessor is an enumeration class that defines various input processing types.

Attributes: CATAPA_MENU (str): Represents the "Catapa Menu" input processing type. GLCHAT (str): Represents the "GLChat" input processing type. NO_MOD (str): Represents the "No Moderation" input processing type.

Possible values:

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/search-profiles

HTTPcURLJavaScriptPython

POST /search-profiles HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 146

{
  "codename": "text",
  "title": "text",
  "type": "Search",
  "input_processor": "Catapa Menu",
  "providers": [
    {
      "provider_ids": "text",
      "type": "text",
      "params": []
    }
  ]
}

No content

Get

get

Read a single SearchProfileModel 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

/search-profiles/{id}

HTTPcURLJavaScriptPython

GET /search-profiles/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": 1,
  "codename": "text",
  "title": "text",
  "type": "Search",
  "input_processor": "Catapa Menu",
  "providers": [
    {
      "provider_ids": "text",
      "type": "text",
      "params": []
    }
  ]
}

Delete

delete

Delete a SearchProfileModel 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

/search-profiles/{id}

HTTPcURLJavaScriptPython

DELETE /search-profiles/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Update

patch

Update an existing SearchProfileModel 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 Search Profile model.

codenamestringRequired

titlestringRequired

typestring · enumRequired

ProfileType is an enumeration that defines various types of profiles used in the application.

Attributes: SEARCH (str): Represents a search profile type. AUTOSUGGEST (str): Represents an autosuggest profile type. SHINGLES (str): Represents a shingles profile type. WEB_SEARCH (str): Represents a web search profile type. DISCOVERY (str): Represents a discovery profile type. DEEP_SEARCH (str): Represents a deep search profile type.

Possible values:

input_processorstring · enumRequired

InputProcessor is an enumeration class that defines various input processing types.

Attributes: CATAPA_MENU (str): Represents the "Catapa Menu" input processing type. GLCHAT (str): Represents the "GLChat" input processing type. NO_MOD (str): Represents the "No Moderation" input processing type.

Possible values:

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

patch

/search-profiles/{id}

HTTPcURLJavaScriptPython

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

{
  "codename": "text",
  "title": "text",
  "type": "Search",
  "input_processor": "Catapa Menu",
  "providers": [
    {
      "provider_ids": "text",
      "type": "text",
      "params": []
    }
  ]
}

No content