52 lines
3.3 KiB
XML
52 lines
3.3 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE topic
|
|
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
|
|
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
|
|
title="System-wide search" id="systemWideSearchGet">
|
|
|
|
<!-- AUTO-GENERATED, DO NOT EDIT -->
|
|
<p>This endpoint documentation is generated directly from <code>openapi.yaml</code>.</p>
|
|
<chapter title="Endpoint" id="endpoint">
|
|
<code-block lang="http">GET /search/system</code-block>
|
|
</chapter>
|
|
<chapter title="Operation" id="operation">
|
|
<p>Operation ID: <code>systemWideSearchGet</code></p>
|
|
<p>Search across all supported entities with permission-aware filtering and optional intent parsing debug metadata. Customer records and customer-related entities are matched against a local e-conomic customer index (name/address/email/CVR) that is refreshed by cron. Intent parsing is invoked adaptively when lexical confidence is low or when the query looks intent-driven. Results are ordered by relevance, with recent records preferred when relevance is comparable.</p>
|
|
</chapter>
|
|
<chapter title="Authentication" id="authentication">
|
|
<p>Security requirements:</p>
|
|
<table>
|
|
<tr><td>Scheme</td><td>Scopes</td></tr>
|
|
<tr><td>BearerAuth</td><td>-</td></tr>
|
|
</table>
|
|
</chapter>
|
|
<chapter title="Parameters" id="parameters">
|
|
<table>
|
|
<tr><td>Name</td><td>In</td><td>Required</td><td>Type</td><td>Description</td></tr>
|
|
<tr><td>query</td><td>query</td><td>yes</td><td>string</td><td>Free-text query to search for. Supports natural-language intent fallback and domain synonyms such as `rabat` -> `discount`.</td></tr>
|
|
<tr><td>include_types</td><td>query</td><td>no</td><td>array<SystemSearchEntityType></td><td>Comma-separated list of entity types to include. Defaults to all allowed types.</td></tr>
|
|
<tr><td>exclude_types</td><td>query</td><td>no</td><td>array<SystemSearchEntityType></td><td>Comma-separated list of entity types to exclude.</td></tr>
|
|
<tr><td>include_associations</td><td>query</td><td>no</td><td>boolean</td><td>Include associated objects when matching a primary entity such as a customer.</td></tr>
|
|
<tr><td>debug_intent</td><td>query</td><td>no</td><td>boolean</td><td>Include intent parser diagnostics in `meta.intent_parser`.</td></tr>
|
|
<tr><td>limit</td><td>query</td><td>no</td><td>integer</td><td></td></tr>
|
|
<tr><td>offset</td><td>query</td><td>no</td><td>integer</td><td></td></tr>
|
|
</table>
|
|
</chapter>
|
|
<chapter title="Responses" id="responses">
|
|
<table>
|
|
<tr><td>Status</td><td>Description</td><td>Content Types</td></tr>
|
|
<tr><td>200</td><td>Search results returned successfully</td><td>application/json</td></tr>
|
|
<tr><td>400</td><td></td><td></td></tr>
|
|
<tr><td>401</td><td></td><td></td></tr>
|
|
<tr><td>403</td><td></td><td></td></tr>
|
|
</table>
|
|
<p>Schema for response <code>200</code> (<code>application/json</code>):</p>
|
|
<code-block lang="json">
|
|
{
|
|
"$ref": "#/components/schemas/SystemSearchResponse"
|
|
}
|
|
</code-block>
|
|
</chapter>
|
|
</topic>
|