99 lines
2.6 KiB
YAML
99 lines
2.6 KiB
YAML
|
openapi: 3.1.0
|
||
|
|
info:
|
||
|
|
title: StrafesNET Internal - OpenAPI 3.1
|
||
|
|
description: Internal operations inaccessible from the public internet.
|
||
|
|
version: 0.1.0
|
||
|
|
tags:
|
||
|
|
- name: Submissions
|
||
|
|
description: Submission operations
|
||
|
|
paths:
|
||
|
|
/submissions/{SubmissionID}/status/validator-validated:
|
||
|
|
post:
|
||
|
|
summary: (Internal endpoint) Role Validator changes status from Validating -> Validated
|
||
|
|
operationId: actionSubmissionValidated
|
||
|
|
tags:
|
||
|
|
- Submissions
|
||
|
|
parameters:
|
||
|
|
- $ref: '#/components/parameters/SubmissionID'
|
||
|
|
responses:
|
||
|
|
"204":
|
||
|
|
description: Successful response
|
||
|
|
default:
|
||
|
|
description: General Error
|
||
|
|
content:
|
||
|
|
application/json:
|
||
|
|
schema:
|
||
|
|
$ref: "#/components/schemas/Error"
|
||
|
|
/submissions/{SubmissionID}/status/validator-uploaded:
|
||
|
|
post:
|
||
|
|
summary: (Internal endpoint) Role Validator changes status from Uploading -> Uploaded
|
||
|
|
operationId: actionSubmissionUploaded
|
||
|
|
tags:
|
||
|
|
- Submissions
|
||
|
|
parameters:
|
||
|
|
- $ref: '#/components/parameters/SubmissionID'
|
||
|
|
responses:
|
||
|
|
"204":
|
||
|
|
description: Successful response
|
||
|
|
default:
|
||
|
|
description: General Error
|
||
|
|
content:
|
||
|
|
application/json:
|
||
|
|
schema:
|
||
|
|
$ref: "#/components/schemas/Error"
|
||
|
|
/submissions/{SubmissionID}/status/releaser-released:
|
||
|
|
post:
|
||
|
|
summary: (Internal endpoint) Role Releaser changes status from releasing -> released
|
||
|
|
operationId: actionSubmissionReleased
|
||
|
|
tags:
|
||
|
|
- Submissions
|
||
|
|
parameters:
|
||
|
|
- $ref: '#/components/parameters/SubmissionID'
|
||
|
|
responses:
|
||
|
|
"204":
|
||
|
|
description: Successful response
|
||
|
|
default:
|
||
|
|
description: General Error
|
||
|
|
content:
|
||
|
|
application/json:
|
||
|
|
schema:
|
||
|
|
$ref: "#/components/schemas/Error"
|
||
|
|
components:
|
||
|
|
parameters:
|
||
|
|
SubmissionID:
|
||
|
|
name: SubmissionID
|
||
|
|
in: path
|
||
|
|
required: true
|
||
|
|
description: The unique identifier for a submission.
|
||
|
|
schema:
|
||
|
|
type: integer
|
||
|
|
format: int64
|
||
|
|
schemas:
|
||
|
|
Pagination:
|
||
|
|
type: object
|
||
|
|
required:
|
||
|
|
- Page
|
||
|
|
- Limit
|
||
|
|
properties:
|
||
|
|
Page:
|
||
|
|
type: integer
|
||
|
|
format: int32
|
||
|
|
minimum: 1
|
||
|
|
Limit:
|
||
|
|
type: integer
|
||
|
|
format: int32
|
||
|
|
minimum: 1
|
||
|
|
maximum: 100
|
||
|
|
Error:
|
||
|
|
description: Represents error object
|
||
|
|
type: object
|
||
|
|
properties:
|
||
|
|
code:
|
||
|
|
type: integer
|
||
|
|
format: int64
|
||
|
|
message:
|
||
|
|
type: string
|
||
|
|
required:
|
||
|
|
- code
|
||
|
|
- message
|