Merged in feature/client (pull request #31)
Client Entity * repolevel * servicefunctions * openapiclientget * openapiupdate * client * vendor
This commit is contained in:
+116
-21
@@ -8,14 +8,91 @@ servers:
|
||||
- url: https://api.example.com/v1
|
||||
description: Production server
|
||||
tags:
|
||||
- name: QueryService
|
||||
description: Operations related to queries
|
||||
- name: ClientService
|
||||
description: Operations related to clients
|
||||
- name: JobCollectorService
|
||||
description: Operations related to job collectors
|
||||
- name: QueryService
|
||||
description: Operations related to queries
|
||||
- name: ExportService
|
||||
description: Operations related to exports
|
||||
|
||||
paths:
|
||||
/clients:
|
||||
post:
|
||||
operationId: createClient
|
||||
tags:
|
||||
- ClientService
|
||||
summary: Create a new client
|
||||
description: Creates a new client with the provided details.
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ClientCreate'
|
||||
responses:
|
||||
'201':
|
||||
description: Client created successfully.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/IdMessage'
|
||||
'400':
|
||||
description: Invalid request body.
|
||||
|
||||
/clients/{id}:
|
||||
get:
|
||||
operationId: getClient
|
||||
tags:
|
||||
- ClientService
|
||||
summary: Get a client by ID
|
||||
description: Retrieves a specific client by its ID.
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: The ID of the client to retrieve.
|
||||
responses:
|
||||
'200':
|
||||
description: Client details.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/JobClient'
|
||||
'400':
|
||||
description: Invalid request parameters.
|
||||
'404':
|
||||
description: Client not found.
|
||||
patch:
|
||||
operationId: updateClient
|
||||
tags:
|
||||
- ClientService
|
||||
summary: Update a client
|
||||
description: Updates an existing client with new details.
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: The ID of the client to update.
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ClientUpdate'
|
||||
responses:
|
||||
'200':
|
||||
description: Client updated successfully.
|
||||
'400':
|
||||
description: Invalid request body.
|
||||
'404':
|
||||
description: Client not found
|
||||
|
||||
/queries:
|
||||
get:
|
||||
operationId: listQueries
|
||||
@@ -58,7 +135,7 @@ paths:
|
||||
|
||||
/queries/{id}:
|
||||
get:
|
||||
operationId: getQueryById
|
||||
operationId: getQuery
|
||||
tags:
|
||||
- QueryService
|
||||
summary: Get a query by ID
|
||||
@@ -105,24 +182,6 @@ paths:
|
||||
description: Query updated successfully.
|
||||
'400':
|
||||
description: Invalid request body.
|
||||
delete:
|
||||
operationId: deprecateQuery
|
||||
tags:
|
||||
- QueryService
|
||||
summary: Deprecate a query
|
||||
description: Deprecates a specific query by its ID.
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: The ID of the query to deprecate.
|
||||
responses:
|
||||
'200':
|
||||
description: Query deprecated successfully.
|
||||
'400':
|
||||
description: Invalid request body.
|
||||
'404':
|
||||
description: Query not found.
|
||||
|
||||
@@ -363,6 +422,42 @@ components:
|
||||
required:
|
||||
- value
|
||||
|
||||
JobClient:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The client id
|
||||
name:
|
||||
type: string
|
||||
description: The client name
|
||||
can_sync:
|
||||
type: boolean
|
||||
description: If the client is allowing active syncs
|
||||
required:
|
||||
- id
|
||||
- name
|
||||
- can_sync
|
||||
|
||||
ClientCreate:
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
description: The client name
|
||||
required:
|
||||
- name
|
||||
|
||||
ClientUpdate:
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
description: The client name
|
||||
can_sync:
|
||||
type: boolean
|
||||
description: If the client is allowing active syncs
|
||||
|
||||
IdMessage:
|
||||
type: object
|
||||
properties:
|
||||
|
||||
Reference in New Issue
Block a user