Skip to content

Commit b08ad35

Browse files
authored
add de-onboarding endpoint (#1362)
1 parent 27a89e2 commit b08ad35

File tree

12 files changed

+3456
-988
lines changed

12 files changed

+3456
-988
lines changed

docs/openapi/api.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -294,6 +294,8 @@ paths:
294294
$ref: './llmo-api.yaml#/llmo-cdn-logs-bucket-config'
295295
/llmo/onboard:
296296
$ref: './llmo-api.yaml#/llmo-onboard'
297+
/sites/{siteId}/llmo/offboard:
298+
$ref: './llmo-api.yaml#/llmo-offboard'
297299
/sites/{siteId}/reports:
298300
$ref: './site-api.yaml#/site-reports'
299301
/sites/{siteId}/reports/{reportId}:

docs/openapi/llmo-api.yaml

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -359,6 +359,67 @@ llmo-onboard:
359359
$ref: './responses.yaml#/500'
360360
security: []
361361

362+
llmo-offboard:
363+
parameters:
364+
- $ref: './parameters.yaml#/siteId'
365+
post:
366+
tags:
367+
- llmo
368+
summary: Offboard customer from LLMO
369+
description: |
370+
Offboards a customer from LLMO (Large Language Model Optimizer).
371+
This endpoint handles disabling audits and cleaning up LLMO configuration for a site.
372+
The site must have LLMO enabled and the user must have appropriate permissions.
373+
operationId: offboardCustomer
374+
responses:
375+
'200':
376+
description: LLMO offboarding completed successfully
377+
content:
378+
application/json:
379+
schema:
380+
type: object
381+
properties:
382+
message:
383+
type: string
384+
description: Success message
385+
example: "LLMO offboarding completed successfully"
386+
siteId:
387+
type: string
388+
format: uuid
389+
description: The site ID that was offboarded
390+
example: "987fcdeb-51a2-43d1-9f12-345678901234"
391+
baseURL:
392+
type: string
393+
format: uri
394+
description: The site's base URL
395+
example: "https://example.com"
396+
status:
397+
type: string
398+
enum: ["completed", "failed"]
399+
description: The offboarding status
400+
example: "completed"
401+
completedAt:
402+
type: string
403+
format: date-time
404+
description: The timestamp when offboarding was completed
405+
example: "2025-01-15T10:30:00Z"
406+
required:
407+
- message
408+
- siteId
409+
- status
410+
'400':
411+
$ref: './responses.yaml#/400'
412+
'401':
413+
$ref: './responses.yaml#/401'
414+
'403':
415+
$ref: './responses.yaml#/403'
416+
'404':
417+
$ref: './responses.yaml#/404'
418+
'500':
419+
$ref: './responses.yaml#/500'
420+
security:
421+
- api_key: [ ]
422+
362423
llmo-questions:
363424
parameters:
364425
- $ref: './parameters.yaml#/siteId'

0 commit comments

Comments
 (0)