This commit is contained in:
102
docs/openapi/api.yaml
Normal file
102
docs/openapi/api.yaml
Normal file
@@ -0,0 +1,102 @@
|
||||
openapi: 3.1.0
|
||||
info:
|
||||
description: Easily maintain Calculate Negative Points
|
||||
title: Calculate Negative Points
|
||||
version: v1.0.0
|
||||
paths:
|
||||
/api/process:
|
||||
post:
|
||||
description: Process Negative Points
|
||||
operationId: requests/negative_points_processor.NegativePointsProcessor
|
||||
requestBody:
|
||||
content:
|
||||
multipart/form-data:
|
||||
schema:
|
||||
$ref: '#/components/schemas/FormDataNegativePointsProcessorNegativePointsProcessorInput'
|
||||
responses:
|
||||
"200":
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/NegativePointsProcessorNegativePointsProcessorOutput'
|
||||
description: OK
|
||||
summary: Negative Points Processor
|
||||
tags:
|
||||
- Negative Points Processor
|
||||
/api/users/current:
|
||||
delete:
|
||||
description: Logout current user
|
||||
operationId: requests/users.Logout
|
||||
responses:
|
||||
"200":
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
additionalProperties: {}
|
||||
type:
|
||||
- "null"
|
||||
- object
|
||||
description: OK
|
||||
summary: Logout
|
||||
tags:
|
||||
- Users
|
||||
get:
|
||||
description: Retrieve the current user
|
||||
operationId: requests/users.GetCurrentUser
|
||||
responses:
|
||||
"200":
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/TypesShowResponseClintonambulanceComCalculateNegativePointsInternalTypesUiUser'
|
||||
description: OK
|
||||
summary: Get Current User
|
||||
tags:
|
||||
- Users
|
||||
components:
|
||||
schemas:
|
||||
FormDataNegativePointsProcessorNegativePointsProcessorInput:
|
||||
properties:
|
||||
file:
|
||||
$ref: '#/components/schemas/MultipartFileHeader'
|
||||
description: XLS schedule file to process
|
||||
type: object
|
||||
MultipartFileHeader:
|
||||
contentMediaType: application/octet-stream
|
||||
format: binary
|
||||
type: string
|
||||
NegativePointsProcessorNegativePointsProcessorOutput:
|
||||
properties:
|
||||
employees:
|
||||
description: List of employees who had negative points
|
||||
items:
|
||||
type: string
|
||||
type: array
|
||||
required:
|
||||
- employees
|
||||
type: object
|
||||
TypesShowResponseClintonambulanceComCalculateNegativePointsInternalTypesUiUser:
|
||||
properties:
|
||||
item:
|
||||
$ref: '#/components/schemas/TypesUiUser'
|
||||
required:
|
||||
- item
|
||||
type: object
|
||||
TypesUiUser:
|
||||
properties:
|
||||
first_name:
|
||||
type: string
|
||||
groups:
|
||||
items:
|
||||
type: string
|
||||
type: array
|
||||
id:
|
||||
type: string
|
||||
last_name:
|
||||
type: string
|
||||
name:
|
||||
type: string
|
||||
required:
|
||||
- id
|
||||
- name
|
||||
type: object
|
||||
Reference in New Issue
Block a user