Skip to content
Snippets Groups Projects
Commit 89e9e7f5 authored by David Trattnig's avatar David Trattnig
Browse files

Update spec.

parent 709bf63b
No related branches found
No related tags found
No related merge requests found
openapi: 3.0.0
info:
title: AURA Engine API
description: This is the AURA Engine API. Read more at https://gitlab.servus.at/aura/engine.
description: This is the AURA Engine API.
contact:
email: david.trattnig@subsquare.at
license:
name: AGPL 3.0
url: https://www.gnu.org/licenses/agpl-3.0.en.html
version: 1.0.0
externalDocs:
description: Find more info here
url: https://gitlab.servus.at/aura/engine-api
servers:
- url: '{protocol}://{api-host}:{port}/api/{version}'
description: Engine API
......@@ -74,7 +77,7 @@ paths:
"400":
description: bad input parameter
x-openapi-router-controller: src.rest.controllers.public_controller
/trackservice/{trackId}:
/trackservice/{track_id}:
get:
tags:
- public
......@@ -83,7 +86,7 @@ paths:
Retrieves a single track by its ID.
operationId: get_track
parameters:
- name: trackId
- name: track_id
in: path
description: ID of the track-service entry
required: true
......@@ -203,7 +206,7 @@ paths:
"400":
description: bad input parameter
x-openapi-router-controller: src.rest.controllers.internal_controller
/engine/{engineNumber}/health:
/engine/{engine_number}/health:
get:
tags:
- internal
......@@ -212,7 +215,7 @@ paths:
Retrieves the most recent health info of the requested engine
operationId: get_engine_health
parameters:
- name: engineNumber
- name: engine_number
in: path
description: Number of the engine
required: true
......@@ -240,7 +243,7 @@ paths:
Logs another health entry for the given engine
operationId: log_engine_health
parameters:
- name: engineNumber
- name: engine_number
in: path
description: Number of the engine
required: true
......@@ -256,7 +259,7 @@ paths:
"400":
description: bad input parameter
x-openapi-router-controller: src.rest.controllers.internal_controller
/engine/{engineNumber}/activate:
/engine/{engine_number}/activate:
put:
tags:
- internal
......@@ -265,7 +268,7 @@ paths:
Activates one engine and deactivates the other
operationId: activate_engine
parameters:
- name: engineNumber
- name: engine_number
in: path
description: Number of the engine
required: true
......
......@@ -20,7 +20,7 @@ class TestInternalController(BaseTestCase):
Set active engine
"""
response = self.client.open(
'/api/v1/engine/{engineNumber}/activate'.format(engine_number=2),
'/api/v1/engine/{engine_number}/activate'.format(engine_number=2),
method='PUT')
self.assert200(response,
'Response body is : ' + response.data.decode('utf-8'))
......@@ -42,7 +42,7 @@ class TestInternalController(BaseTestCase):
Get most recent health info
"""
response = self.client.open(
'/api/v1/engine/{engineNumber}/health'.format(engine_number=2),
'/api/v1/engine/{engine_number}/health'.format(engine_number=2),
method='GET')
self.assert200(response,
'Response body is : ' + response.data.decode('utf-8'))
......@@ -64,7 +64,7 @@ class TestInternalController(BaseTestCase):
Log health info
"""
response = self.client.open(
'/api/v1/engine/{engineNumber}/health'.format(engine_number=2),
'/api/v1/engine/{engine_number}/health'.format(engine_number=2),
method='POST')
self.assert200(response,
'Response body is : ' + response.data.decode('utf-8'))
......
......@@ -41,7 +41,7 @@ class TestPublicController(BaseTestCase):
Get a single track by ID
"""
response = self.client.open(
'/api/v1/trackservice/{trackId}'.format(track_id=56),
'/api/v1/trackservice/{track_id}'.format(track_id=56),
method='GET')
self.assert200(response,
'Response body is : ' + response.data.decode('utf-8'))
......@@ -66,7 +66,7 @@ class TestPublicController(BaseTestCase):
Get next playlist
"""
response = self.client.open(
'api/v1/playlist/next',
'/api/v1/playlist/next',
method='GET')
self.assert200(response,
'Response body is : ' + response.data.decode('utf-8'))
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment