This commit is contained in:
12
dist/services/ScanStationService.js
vendored
12
dist/services/ScanStationService.js
vendored
@@ -6,7 +6,7 @@ class ScanStationService {
|
||||
/**
|
||||
* Get all
|
||||
* Lists all stations. <br> This includes their associated tracks.
|
||||
* @result ResponseScanStation
|
||||
* @returns ResponseScanStation
|
||||
* @throws ApiError
|
||||
*/
|
||||
static async scanStationControllerGetAll() {
|
||||
@@ -20,7 +20,7 @@ class ScanStationService {
|
||||
* Post
|
||||
* Create a new station. <br> Please remeber to provide the station's track's id. <br> Please also remember that the station key is only visibe on creation.
|
||||
* @param requestBody CreateScanStation
|
||||
* @result ResponseScanStation
|
||||
* @returns ResponseScanStation
|
||||
* @throws ApiError
|
||||
*/
|
||||
static async scanStationControllerPost(requestBody) {
|
||||
@@ -35,7 +35,7 @@ class ScanStationService {
|
||||
* Get one
|
||||
* Lists all information about the station whose id got provided. <br> This includes it's associated track.
|
||||
* @param id
|
||||
* @result ResponseScanStation
|
||||
* @returns ResponseScanStation
|
||||
* @throws ApiError
|
||||
*/
|
||||
static async scanStationControllerGetOne(id) {
|
||||
@@ -50,7 +50,7 @@ class ScanStationService {
|
||||
* Update the station whose id you provided. <br> Please remember that only the description and enabled state can be changed.
|
||||
* @param id
|
||||
* @param requestBody UpdateScanStation
|
||||
* @result ResponseScanStation
|
||||
* @returns ResponseScanStation
|
||||
* @throws ApiError
|
||||
*/
|
||||
static async scanStationControllerPut(id, requestBody) {
|
||||
@@ -66,8 +66,8 @@ class ScanStationService {
|
||||
* Delete the station whose id you provided. <br> If no station with this id exists it will just return 204(no content). <br> If the station still has scans associated you have to provide the force=true query param (warning: this deletes all scans associated with/created by this station - please disable it instead).
|
||||
* @param id
|
||||
* @param force
|
||||
* @result ResponseScanStation
|
||||
* @result ResponseEmpty
|
||||
* @returns ResponseScanStation
|
||||
* @returns ResponseEmpty
|
||||
* @throws ApiError
|
||||
*/
|
||||
static async scanStationControllerRemove(id, force) {
|
||||
|
||||
Reference in New Issue
Block a user