Files
fielderp-server/documentation/assignment.js
T

169 lines
3.3 KiB
JavaScript

export default {
"/assignment": {
post: {
tags: ["Assignment"],
summary: "Create an assignment",
requestBody: {
content: {
"application/json": {
schema: {
type: "object",
properties: {
user: {
type: "string",
required: true,
},
venue: {
type: "string",
required: true,
},
targetedVisits: {
type: "number",
required: true,
},
},
},
},
},
},
responses: {
200: {
description: "OK",
content: {},
},
},
},
},
"/assignment/{id}": {
patch: {
tags: ["Assignment"],
summary: "Update an assignment",
parameters: [
{
in: "path",
name: "id",
required: true,
schema: {
type: "string",
},
},
],
requestBody: {
content: {
"application/json": {
schema: {
type: "object",
properties: {
user: {
type: "string",
required: true,
},
venue: {
type: "string",
required: true,
},
targetedVisits: {
type: "number",
required: true,
},
},
},
},
},
},
responses: {
200: {
description: "OK",
content: {},
},
},
},
get: {
tags: ["Assignment"],
summary: "Update an assignment",
parameters: [
{
in: "path",
name: "id",
required: true,
schema: {
type: "string",
},
},
],
responses: {
200: {
description: "OK",
content: {},
},
},
},
delete: {
tags: ["Assignment"],
summary: "Delete an assignment",
parameters: [
{
in: "path",
name: "id",
required: true,
schema: {
type: "string",
},
},
],
responses: {
200: {
description: "OK",
content: {},
},
},
},
},
"/assignment/user/{id}": {
get: {
tags: ["Assignment"],
summary: "Get all assignments for a user",
parameters: [
{
in: "path",
name: "id",
description: "User ID",
required: true,
schema: {
type: "string",
},
},
],
responses: {
200: {
description: "OK",
content: {},
},
},
},
},
"/assignment/venue/{id}": {
get: {
tags: ["Assignment"],
summary: "Get all assignments for a Venue",
parameters: [
{
in: "path",
name: "id",
description: "Venue ID",
required: true,
schema: {
type: "string",
},
},
],
responses: {
200: {
description: "OK",
content: {},
},
},
},
},
};