it's called a submission ok

This commit is contained in:
Quaternions 2024-11-25 21:56:55 -08:00
parent 866dc96111
commit db7cbe6e35

View File

@ -1,26 +1,25 @@
openapi: 3.1.0 openapi: 3.1.0
info: info:
title: StrafesNET Maptest - OpenAPI 3.1 title: StrafesNET Submissions - OpenAPI 3.1
description: Browse and manage maps in the staging pipeline. description: Browse and manage map submissions in the staging pipeline.
version: 0.1.0 version: 0.1.0
servers: servers:
- url: https://maptest.strafes.net/v1 - url: https://submissions.strafes.net/v1
tags: tags:
- name: Maps - name: Submissions
description: Map operations description: Submission operations
paths: paths:
# create
# status # status
# submit # submit
# accept # accept
# publish # publish
# complete # complete
/maps: /submissions:
get: get:
summary: Get list of submissions summary: Get list of submissions
operationId: listMaps operationId: listSubmissions
tags: tags:
- Maps - Submissions
parameters: parameters:
- name: page - name: page
in: query in: query
@ -31,7 +30,7 @@ paths:
in: query in: query
required: false required: false
schema: schema:
$ref: "#/components/schemas/MapFilter" $ref: "#/components/schemas/SubmissionFilter"
responses: responses:
"200": "200":
description: Successful response description: Successful response
@ -40,7 +39,7 @@ paths:
schema: schema:
type: array type: array
items: items:
$ref: "#/components/schemas/Map" $ref: "#/components/schemas/Submission"
default: default:
description: General Error description: General Error
content: content:
@ -49,36 +48,35 @@ paths:
$ref: "#/components/schemas/Error" $ref: "#/components/schemas/Error"
post: post:
summary: Create new submission summary: Create new submission
operationId: createMap operationId: createSubmission
tags: tags:
- Maps - Submissions
parameters: # how to do this? body should have the submission in json or something
- name: map # content:
in: query # application/json:
required: true # schema:
schema: # $ref: "#/components/schemas/SubmissionCreate"
$ref: "#/components/schemas/MapCreate"
responses: responses:
"200": "200":
description: Successful response description: Successful response
content: content:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/Map" $ref: "#/components/schemas/Submission"
default: default:
description: General Error description: General Error
content: content:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/Error" $ref: "#/components/schemas/Error"
/maps/{MapID}: /submissions/{SubmissionID}:
get: get:
summary: Retrieve map with ID summary: Retrieve map with ID
operationId: getMap operationId: getSubmission
tags: tags:
- Maps - Submissions
parameters: parameters:
- name: MapID - name: SubmissionID
in: path in: path
required: true required: true
schema: schema:
@ -90,7 +88,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/Map" $ref: "#/components/schemas/Submission"
default: default:
description: General Error description: General Error
content: content:
@ -110,7 +108,7 @@ components:
StateID: StateID:
type: integer type: integer
format: int32 format: int32
Map: Submission:
type: object type: object
properties: properties:
ID: ID:
@ -126,7 +124,7 @@ components:
Date: Date:
type: integer type: integer
format: int64 format: int64
MapFilter: SubmissionFilter:
type: object type: object
properties: properties:
ID: ID: