Skip to content

Commit cde8e79

Browse files
committed
docs: update openAPI spec
1 parent fba41cd commit cde8e79

File tree

3 files changed

+85
-17
lines changed

3 files changed

+85
-17
lines changed

docs/index.html

Lines changed: 47 additions & 17 deletions
Large diffs are not rendered by default.

docs/openapi/llmo-api.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,7 @@ llmo-config:
194194
Retrieves the LLMO (Large Language Model Optimizer) configuration for a specific site.
195195
This endpoint retrieves the configuration directly from S3 storage. The configuration
196196
includes entities (categories, topics), brand aliases, and competitor information.
197+
Categories may include optional URLs for content matching.
197198
198199
If a version parameter is provided, the specific version of the configuration will be
199200
retrieved. If the version does not exist, a 404 error will be returned. If no version
@@ -238,6 +239,9 @@ llmo-config:
238239
This operation completely overwrites the existing configuration with the provided payload.
239240
The payload is validated against the LLMO configuration schema before being stored in S3.
240241
The configuration must include entities, brands, and competitors sections.
242+
243+
Categories can optionally include URLs that can be either exact URLs or URL prefixes
244+
(ending with /*) to match against specific content areas.
241245
operationId: postLlmoConfig
242246
requestBody:
243247
required: true

docs/openapi/schemas.yaml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3805,6 +3805,11 @@ LlmoConfig:
38053805
"123e4567-e89b-12d3-a456-426614174000":
38063806
name: "Technology"
38073807
region: "us"
3808+
urls:
3809+
- value: "https://example.com/tech"
3810+
type: "url"
3811+
- value: "https://example.com/technology/*"
3812+
type: "prefix"
38083813
topics:
38093814
type: object
38103815
description: A record of topics with nested prompts keyed by UUID
@@ -3884,8 +3889,37 @@ LlmoCategory:
38843889
pattern: '^[a-z][a-z]$'
38853890
description: Array of two-letter region codes
38863891
example: ["us", "eu"]
3892+
urls:
3893+
type: array
3894+
description: Optional array of URLs associated with this category
3895+
items:
3896+
$ref: '#/LlmoCategoryUrl'
3897+
example:
3898+
- value: "https://example.com/tech"
3899+
type: "url"
3900+
- value: "https://example.com/news/*"
3901+
type: "prefix"
38873902
additionalProperties: true
38883903

3904+
LlmoCategoryUrl:
3905+
type: object
3906+
description: A URL configuration for a category
3907+
required:
3908+
- value
3909+
- type
3910+
properties:
3911+
value:
3912+
type: string
3913+
description: The URL value - can be a complete URL or a URL prefix
3914+
minLength: 1
3915+
example: "https://example.com/tech"
3916+
type:
3917+
type: string
3918+
enum: ["url", "prefix"]
3919+
description: The type of URL - 'url' for exact URLs, 'prefix' for URL prefixes (ending with /*)
3920+
example: "url"
3921+
additionalProperties: false
3922+
38893923
LlmoTopic:
38903924
type: object
38913925
description: A topic in the LLMO configuration with nested prompts

0 commit comments

Comments
 (0)