Skip to content

Commit ee20abc

Browse files
committed
Fix schema to be compatible with mintlify
1 parent d8e8d78 commit ee20abc

1 file changed

Lines changed: 99 additions & 57 deletions

File tree

openapi.yaml

Lines changed: 99 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -7017,53 +7017,62 @@ paths:
70177017
responses:
70187018
"200":
70197019
description: List of training sessions
7020-
schema:
7021-
type: array
7022-
items:
7023-
type: object
7024-
$ref: '#/components/schemas/RL.TrainingSession'
7020+
content:
7021+
application/json:
7022+
schema:
7023+
type: array
7024+
items:
7025+
type: object
7026+
$ref: '#/components/schemas/RL.TrainingSession'
70257027
default:
70267028
description: An unexpected error response.
7027-
schema:
7028-
$ref: '#/components/schemas/ErrorResponse'
7029+
content:
7030+
application/json:
7031+
schema:
7032+
$ref: '#/components/schemas/ErrorResponse'
70297033
parameters:
70307034
- name: status
70317035
in: query
70327036
required: false
7033-
type:
7037+
schema:
70347038
$ref: '#/components/schemas/RL.TrainingSessionStatus'
70357039
- name: limit
7036-
description: Maximum number of sessions to return (1-100)
7040+
description: Maximum number of sessions to return (1-100), defaults to 20
70377041
in: query
70387042
required: false
7039-
type: integer
7040-
default: 20
7043+
schema:
7044+
type: integer
70417045
- name: offset
70427046
description: Number of sessions to skip
70437047
in: query
70447048
required: false
7045-
type: integer
7046-
default: 0
7049+
schema:
7050+
type: integer
70477051
post:
70487052
summary: Create training session
70497053
description: Creates a training session and returns its details.
70507054
operationId: startTrainingSession
70517055
tags: [RL]
7056+
requestBody:
7057+
content:
7058+
application/json:
7059+
schema:
7060+
$ref: '#/components/schemas/RL.StartTrainingSessionRequest'
7061+
required: true
70527062
responses:
70537063
"200":
70547064
description: Training session details
7055-
schema:
7056-
$ref: '#/components/schemas/RL.TrainingSession'
7065+
content:
7066+
application/json:
7067+
schema:
7068+
$ref: '#/components/schemas/RL.TrainingSession'
70577069
default:
70587070
description: An unexpected error response.
7059-
schema:
7060-
$ref: '#/components/schemas/ErrorResponse'
7061-
parameters:
7062-
- name: body
7063-
in: body
7064-
required: true
7065-
schema:
7066-
$ref: '#/components/schemas/RL.StartTrainingSessionRequest'
7071+
content:
7072+
application/json:
7073+
schema:
7074+
$ref: '#/components/schemas/ErrorResponse'
7075+
70677076
/rl/training-sessions/{session_id}:
70687077
get:
70697078
summary: Get training session
@@ -7073,12 +7082,16 @@ paths:
70737082
responses:
70747083
"200":
70757084
description: Training session details
7076-
schema:
7077-
$ref: '#/components/schemas/RL.TrainingSession'
7085+
content:
7086+
application/json:
7087+
schema:
7088+
$ref: '#/components/schemas/RL.TrainingSession'
70787089
default:
70797090
description: An unexpected error response.
7080-
schema:
7081-
$ref: '#/components/schemas/ErrorResponse'
7091+
content:
7092+
application/json:
7093+
schema:
7094+
$ref: '#/components/schemas/ErrorResponse'
70827095
parameters:
70837096
- name: session_id
70847097
description: ID of the training session
@@ -7095,12 +7108,16 @@ paths:
70957108
responses:
70967109
"200":
70977110
description: Forward-backward operation details
7098-
schema:
7099-
$ref: '#/components/schemas/RL.ForwardBackwardOperation'
7111+
content:
7112+
application/json:
7113+
schema:
7114+
$ref: '#/components/schemas/RL.ForwardBackwardOperation'
71007115
default:
71017116
description: An unexpected error response.
7102-
schema:
7103-
$ref: '#/components/schemas/ErrorResponse'
7117+
content:
7118+
application/json:
7119+
schema:
7120+
$ref: '#/components/schemas/ErrorResponse'
71047121
parameters:
71057122
- name: session_id
71067123
description: Training session ID
@@ -7123,12 +7140,16 @@ paths:
71237140
responses:
71247141
"200":
71257142
description: ""
7126-
schema:
7127-
$ref: '#/components/schemas/RL.OptimStepOperation'
7143+
content:
7144+
application/json:
7145+
schema:
7146+
$ref: '#/components/schemas/RL.OptimStepOperation'
71287147
default:
71297148
description: An unexpected error response.
7130-
schema:
7131-
$ref: '#/components/schemas/ErrorResponse'
7149+
content:
7150+
application/json:
7151+
schema:
7152+
$ref: '#/components/schemas/ErrorResponse'
71327153
parameters:
71337154
- name: session_id
71347155
description: Training session ID
@@ -7148,69 +7169,89 @@ paths:
71487169
description: Submits a forward-backward pass operation that will asynchronously compute gradients via backpropagation.
71497170
operationId: forwardBackward
71507171
tags: [RL]
7172+
requestBody:
7173+
content:
7174+
application/json:
7175+
schema:
7176+
$ref: '#/components/schemas/RL.ForwardBackwardBody'
7177+
required: true
71517178
responses:
71527179
"200":
71537180
description: ""
7154-
schema:
7155-
$ref: '#/components/schemas/RL.ForwardBackwardOperation'
7181+
content:
7182+
application/json:
7183+
schema:
7184+
$ref: '#/components/schemas/RL.ForwardBackwardOperation'
71567185
default:
71577186
description: An unexpected error response.
7158-
schema:
7159-
$ref: '#/components/schemas/ErrorResponse'
7187+
content:
7188+
application/json:
7189+
schema:
7190+
$ref: '#/components/schemas/ErrorResponse'
71607191
parameters:
71617192
- name: session_id
71627193
description: Training session ID
71637194
in: path
71647195
required: true
71657196
schema:
71667197
type: string
7167-
- name: body
7168-
in: body
7169-
required: true
7170-
schema:
7171-
$ref: '#/components/schemas/RL.ForwardBackwardBody'
71727198
/rl/training-sessions/{session_id}:optim-step:
71737199
post:
71747200
summary: Optimizer step
71757201
description: Submits an optimizer step operation that will asynchronously apply accumulated gradients to update model parameters.
71767202
operationId: OptimStep
71777203
tags: [RL]
7204+
requestBody:
7205+
content:
7206+
application/json:
7207+
schema:
7208+
$ref: '#/components/schemas/RL.OptimStepBody'
7209+
required: true
71787210
responses:
71797211
"200":
71807212
description: Optimizer step operation details
7181-
schema:
7182-
$ref: '#/components/schemas/RL.OptimStepOperation'
7213+
content:
7214+
application/json:
7215+
schema:
7216+
$ref: '#/components/schemas/RL.OptimStepOperation'
71837217
default:
71847218
description: An unexpected error response.
7185-
schema:
7186-
$ref: '#/components/schemas/ErrorResponse'
7219+
content:
7220+
application/json:
7221+
schema:
7222+
$ref: '#/components/schemas/ErrorResponse'
71877223
parameters:
71887224
- name: session_id
71897225
description: Training session ID
71907226
in: path
71917227
required: true
71927228
schema:
71937229
type: string
7194-
- name: body
7195-
in: body
7196-
required: true
7197-
schema:
7198-
$ref: '#/components/schemas/RL.OptimStepBody'
71997230
/rl/training-sessions/{session_id}:stop:
72007231
post:
72017232
summary: Stop training session
72027233
description: Stops a training session.
72037234
operationId: stopTrainingSession
72047235
tags: [RL]
7236+
requestBody:
7237+
content:
7238+
application/json:
7239+
schema:
7240+
$ref: '#/components/schemas/RL.StopTrainingSessionBody'
7241+
required: true
72057242
responses:
72067243
"200":
72077244
description: Training session details
7208-
schema:
7209-
$ref: '#/components/schemas/RL.TrainingSession'
7245+
content:
7246+
application/json:
7247+
schema:
7248+
$ref: '#/components/schemas/RL.TrainingSession'
72107249
default:
72117250
description: An unexpected error response.
7212-
schema:
7213-
$ref: '#/components/schemas/ErrorResponse'
7251+
content:
7252+
application/json:
7253+
schema:
7254+
$ref: '#/components/schemas/ErrorResponse'
72147255
parameters:
72157256
- name: session_id
72167257
description: ID of the training session
@@ -7230,6 +7271,7 @@ components:
72307271
schemas:
72317272
RL.OptimStepBody:
72327273
type: object
7274+
properties: []
72337275
RL.ForwardBackwardBody:
72347276
type: object
72357277
required:

0 commit comments

Comments
 (0)