Competition API 0.0.6-dev

A fictional API for ApiBuilder tool features testing.

Resources

competition

Public resource that can responsible for competitions create, read, start, stop.

Operations

Method and Path Description
POST /competitions
GET /competitions/:id

competitor

Public resource that can responsible for competitor create and read.

Operations

Method and Path Description
POST /competitors
GET /competitors/:id

Headers

No headers

Imports

No imports

Enums

app_sort_by

Name Value Description
name name

created_at created_at

updated_at updated_at

competition_status competition_status

competition_status

The actual status of the competition.

Name Value Description
pending pending

Prepared competition, waiting for start.

active active

Currently active(running) competition.

closed closed

Already closed competition.

sort_order

Name Value Description
asc asc

desc desc

vote_type

The actual status of the competition.

Name Value Description
basic basic

Basic vote.

premium premium

Premium vote.

Interfaces

No interfaces

Models

competition

Example Json: Minimal | Full

Interfaces: None

A competition is a race game for the competitors to collect more vote points.

Field Type Required? Default Description
guid uuid Yes -

Internal unique identifier for this competition.

name string Yes -

status competition_status Yes -

start_at date-time-iso8601 Yes -

end_at date-time-iso8601 Yes -

created_at date-time-iso8601 Yes -

updated_at date-time-iso8601 Yes -

competition_participant

Example Json: Minimal | Full

Interfaces: None

The competition participant is a competitor who is playing in a specific competition and he/she be able to win that.

Field Type Required? Default Description
guid uuid Yes -

Internal unique identifier for this competition_participant.

competition_id uuid Yes -

competitor_id uuid Yes -

competitor

Example Json: Minimal | Full

Interfaces: None

The competitor can who can participate in a competition.

Field Type Required? Default Description
guid uuid Yes -

Internal unique identifier for this competitor.

name string Yes -

vote

Example Json: Minimal | Full

Interfaces: None

The vote is created by voter and it concern for a competition_participant

Field Type Required? Default Description
guid uuid Yes -

Internal unique identifier for this voter.

competition_participant_id uuid Yes -

voter_id uuid Yes -

type string Yes -

points integer Yes -

voter

Example Json: Minimal | Full

Interfaces: None

The voter can vote for competition_participant.

Field Type Required? Default Description
guid uuid Yes -

Internal unique identifier for this voter.

name string Yes -

asdf string Yes -

Unions

No unions

Annotations

No annotations