Skip to content

Commit 36385c9

Browse files
committed
Swagger doc for close marathon match endpoint
1 parent b85dc9c commit 36385c9

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

docs/swagger.yaml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -675,6 +675,51 @@ paths:
675675
description: Internal Server Error
676676
schema:
677677
$ref: "#/definitions/ErrorModel"
678+
/challenges/{challengeId}/close-marathon-match:
679+
post:
680+
tags:
681+
- Challenges
682+
description: >
683+
Close a Marathon Match challenge by selecting winners from final review
684+
summations, closing all phases, and setting the challenge status to
685+
Completed.
686+
security:
687+
- bearer: []
688+
produces:
689+
- application/json
690+
parameters:
691+
- $ref: "#/parameters/app-version"
692+
- name: challengeId
693+
in: path
694+
required: true
695+
type: string
696+
format: UUID
697+
description: The id of the Marathon Match challenge to close
698+
responses:
699+
"200":
700+
description: OK
701+
schema:
702+
$ref: "#/definitions/Challenge"
703+
"400":
704+
description: Bad request. The challenge is not a Marathon Match or required data is missing.
705+
schema:
706+
$ref: "#/definitions/ErrorModel"
707+
"401":
708+
description: Unauthorized. Fail to authenticate the requester.
709+
schema:
710+
$ref: "#/definitions/ErrorModel"
711+
"403":
712+
description: Forbidden. Only admins or M2M tokens with update scope can close the challenge.
713+
schema:
714+
$ref: "#/definitions/ErrorModel"
715+
"404":
716+
description: Challenge not found
717+
schema:
718+
$ref: "#/definitions/ErrorModel"
719+
"500":
720+
description: Internal Server Error
721+
schema:
722+
$ref: "#/definitions/ErrorModel"
678723
/challenge-types:
679724
get:
680725
tags:

0 commit comments

Comments
 (0)