racket_reel_matches
A web services for configuring and scoring tennis matches.
This Dart package is automatically generated by the OpenAPI Generator project:
- API version: 0.3.0
- Build package: org.openapitools.codegen.languages.DartClientCodegen For more information, please visit https://github.com/tom-elvidge
Requirements
Dart 2.12 or later
Installation & Usage
Github
If this Dart package is published to Github, add the following dependency to your pubspec.yaml
dependencies:
racket_reel_matches:
git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
Local
To use the package in your local drive, add the following dependency to your pubspec.yaml
dependencies:
racket_reel_matches:
path: /path/to/racket_reel_matches
Tests
TODO
Getting Started
Please follow the installation procedure and then run the following:
import 'package:racket_reel_matches/api.dart';
final api_instance = MatchesApi();
final pageSize = 56; // int | The maximum number of matches to include on a page.
final pageNumber = 56; // int | The page of matches to get.
final orderBy = ; // MatchesOrderByEnum | How to order the collection of matches.
try {
final result = api_instance.apiV1MatchesGet(pageSize, pageNumber, orderBy);
print(result);
} catch (e) {
print('Exception when calling MatchesApi->apiV1MatchesGet: $e\n');
}
Documentation for API Endpoints
All URIs are relative to http://localhost
Class | Method | HTTP request | Description |
---|---|---|---|
MatchesApi | apiV1MatchesGet | GET /api/v1/matches | Get a page of matches from the collection of all ordered matches. |
MatchesApi | apiV1MatchesMatchIdGet | GET /api/v1/matches/{matchId} | Get the match with id. |
MatchesApi | apiV1MatchesPost | POST /api/v1/matches | Create a new match from a configuration. |
StatesApi | apiV1MatchesMatchIdStatesLatestDelete | DELETE /api/v1/matches/{matchId}/states/latest | Delete the latest state from the match with id matchId. |
StatesApi | apiV1MatchesMatchIdStatesLatestGet | GET /api/v1/matches/{matchId}/states/latest | Get the latest state from the match with id matchId. |
StatesApi | apiV1MatchesMatchIdStatesLatestPut | PUT /api/v1/matches/{matchId}/states/latest | Update the latest state from the match with id matchId. |
StatesApi | apiV1MatchesMatchIdStatesPost | POST /api/v1/matches/{matchId}/states | Create a new match state when a participant scores a point. |
StatesApi | apiV1MatchesMatchIdStatesStateIndexGet | GET /api/v1/matches/{matchId}/states/{stateIndex} | Get the state with index stateIndex from the match with id matchId. |
StatesApi | apiV1MatchesMatchIdStatesStateIndexPut | PUT /api/v1/matches/{matchId}/states/{stateIndex} | Update the state with index stateIndex from the match with id matchId. |
Documentation For Models
- CreateMatchRequestBody
- CreateStateRequestBody
- Match
- MatchFormatEnum
- MatchPaginated
- MatchSummary
- MatchesOrderByEnum
- ParticipantScore
- ParticipantSetSummary
- ProblemDetails
- SetSummary
- State
- UpdateStateRequestBody
Documentation For Authorization
All endpoints do not require authorization.