Skip to content
Snippets Groups Projects
Commit 785305f5 authored by Mattia Mancini's avatar Mattia Mancini
Browse files

OSB-11: updated api definition

parent 5a943e6b
No related branches found
No related tags found
2 merge requests!89Monitoring maintenance Epic branch merge,!1Resolve OSB-13 "Monitoringmaintenance "
swagger: '2.0'
openapi: 3.0.0
info:
title: Maintenance API
description: ''
version: ''
host: '127.0.0.1:8000'
schemes:
- http
servers:
- url: 'http://lofarmonitortest.control.lofar:8000/api'
description: Prototype test server
paths:
/rtsm/:
get:
operationId: rtsm_list
description: list latest RTSM tests output
summary: list latest RTSM tests results
description: list latest RTSM tests output sorted by descending date
summary: list latest RTSM tests output sorted by descending date
responses:
'200':
description: ''
......@@ -20,12 +20,32 @@ paths:
required: false
in: query
description: A page number within the paginated result set.
type: integer
schema:
type: integer
format: int64
- name: page_size
required: false
in: query
description: Number of results to return per page.
type: integer
schema:
type: integer
format: int64
tags:
- rtsm
'/rtsm/{id}/':
get:
operationId: rtsm_read
summary: select a specific RTSM test result
responses:
'200':
description: ''
parameters:
- name: id
required: true
in: path
description: A unique integer value identifying this rtsm observation.
schema:
type: integer
tags:
- rtsm
/rtsm/errors/:
......@@ -41,12 +61,14 @@ paths:
required: false
in: query
description: A page number within the paginated result set.
type: integer
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
type: integer
schema:
type: integer
tags:
- rtsm
'/rtsm/errors/{id}/':
......@@ -60,7 +82,8 @@ paths:
required: true
in: path
description: A unique integer value identifying this rtsm error.
type: integer
schema:
type: integer
tags:
- rtsm
/rtsm/errors_detailed/:
......@@ -74,12 +97,14 @@ paths:
required: false
in: query
description: A page number within the paginated result set.
type: integer
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
type: integer
schema:
type: integer
tags:
- rtsm
'/rtsm/errors_detailed/{id}/':
......@@ -93,16 +118,18 @@ paths:
required: true
in: path
description: A unique integer value identifying this rtsm error.
type: integer
schema:
type: integer
tags:
- rtsm
/rtsm/insert_raw:
/rtsm/raw/insert:
post:
operationId: rtsm_insert_raw_create
responses:
'201':
description: ''
parameters: []
summary: insert the raw RTSM test
description: >-
This function is meant to parse a request of the form
......@@ -118,7 +145,6 @@ paths:
:param request: HTTP request
:return:
summary: This function is meant to parse a request of the form
tags:
- rtsm
/rtsm/summary/:
......@@ -132,12 +158,14 @@ paths:
required: false
in: query
description: A page number within the paginated result set.
type: integer
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
type: integer
schema:
type: integer
tags:
- rtsm
'/rtsm/summary/{id}/':
......@@ -151,12 +179,60 @@ paths:
required: true
in: path
description: A unique integer value identifying this rtsm observation.
type: integer
schema:
type: integer
tags:
- rtsm
'/rtsm/{id}/':
/stationtests/station_test/:
get:
operationId: rtsm_read
operationId: stationtests_station_test_list
summary: list the latest station tests
responses:
'200':
description: ''
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: start_datetime
required: false
in: query
description: ''
schema:
type: string
- name: end_datetime
required: false
in: query
description: ''
schema:
type: string
- name: checks
required: false
in: query
description: ''
schema:
type: string
- name: station
required: false
in: query
description: ''
schema:
type: string
tags:
- stationtests
'/stationtests/station_test/{id}/':
get:
operationId: stationtests_station_test_read
summary: select a specific station test with the given id
responses:
'200':
description: ''
......@@ -164,10 +240,111 @@ paths:
- name: id
required: true
in: path
description: A unique integer value identifying this rtsm observation.
type: integer
description: A unique integer value identifying this station test.
schema:
type: integer
- name: start_datetime
required: false
in: query
description: ''
schema:
type: string
- name: end_datetime
required: false
in: query
description: ''
schema:
type: string
- name: checks
required: false
in: query
description: ''
schema:
type: string
- name: station
required: false
in: query
description: ''
schema:
type: string
tags:
- rtsm
- stationtests
/stationtests/station/:
get:
operationId: stationtests_station_list
description: list the stations that have been tested by the stationtests
summary: List all the stations that have been tested by the stationtests
responses:
'200':
description: ''
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: location
required: false
in: query
description: ''
schema:
type: string
- name: name
required: false
in: query
description: ''
schema:
type: string
- name: type
required: false
in: query
description: ''
schema:
type: string
tags:
- stationtests
'/stationtests/station/{id}/':
get:
operationId: stationtests_station_read
summary: select a specific station
description: returns the summary of a specific station
responses:
'200':
description: ''
parameters:
- name: id
required: true
in: path
description: A unique integer value identifying this station.
schema:
type: integer
- name: location
required: false
in: query
description: ''
schema:
type: string
- name: name
required: false
in: query
description: ''
schema:
type: string
- name: type
required: false
in: query
description: ''
schema:
type: string
tags:
- stationtests
/stationtests/component/:
get:
operationId: stationtests_component_list
......@@ -181,27 +358,32 @@ paths:
required: false
in: query
description: A page number within the paginated result set.
type: integer
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
type: integer
schema:
type: integer
- name: type
required: false
in: query
description: Type of error
type: string
schema:
type: string
- name: component_id
required: false
in: query
description: Id of the component
type: number
schema:
type: number
- name: station
required: false
in: query
description: station name of the component
type: string
schema:
type: string
tags:
- stationtests
'/stationtests/component/{id}/':
......@@ -217,22 +399,26 @@ paths:
required: true
in: path
description: A unique integer value identifying this component.
type: integer
schema:
type: integer
- name: type
required: false
in: query
description: Type of error
type: string
schema:
type: string
- name: component_id
required: false
in: query
description: id of the component
type: number
schema:
type: number
- name: station
required: false
in: query
description: station name of the component
type: string
schema:
type: string
tags:
- stationtests
/stationtests/component_error/:
......@@ -247,47 +433,56 @@ paths:
required: false
in: query
description: A page number within the paginated result set.
type: integer
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
type: integer
schema:
type: integer
- name: component_id
required: false
in: query
description: id of the component
type: number
schema:
type: number
- name: component_type
required: false
in: query
description: type of the component
type: string
schema:
type: string
- name: station_name
required: false
in: query
description: name of the station
type: string
schema:
type: string
- name: station_type
required: false
in: query
description: type of the station
type: string
schema:
type: string
- name: from_date
required: false
in: query
description: select errors from date
type: string
schema:
type: string
- name: to_date
required: false
in: query
description: select errors to date
type: string
schema:
type: string
- name: type
required: false
in: query
description: select error type
type: string
schema:
type: string
tags:
- stationtests
'/stationtests/component_error/{id}/':
......@@ -303,52 +498,62 @@ paths:
required: true
in: path
description: A unique integer value identifying this component error.
type: integer
schema:
type: integer
- name: page
required: false
in: query
description: A page number within the paginated result set.
type: integer
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
type: integer
schema:
type: integer
- name: component_id
required: false
in: query
description: id of the component
type: number
schema:
type: number
- name: component_type
required: false
in: query
description: type of the component
type: string
schema:
type: string
- name: station_name
required: false
in: query
description: name of the station
type: string
schema:
type: string
- name: station_type
required: false
in: query
description: type of the station
type: string
schema:
type: string
- name: from_date
required: false
in: query
description: select errors from date
type: string
schema:
type: string
- name: to_date
required: false
in: query
description: select errors to date
type: string
schema:
type: string
- name: type
required: false
in: query
description: select error type
type: string
schema:
type: string
tags:
- stationtests
/stationtests/element/:
......@@ -363,22 +568,26 @@ paths:
required: false
in: query
description: A page number within the paginated result set.
type: integer
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
type: integer
schema:
type: integer
- name: component
required: false
in: query
description: id of the component
type: string
schema:
type: string
- name: element_id
required: false
in: query
description: id of the element
type: number
schema:
type: number
tags:
- stationtests
'/stationtests/element/{id}/':
......@@ -393,23 +602,26 @@ paths:
required: true
in: path
description: A unique integer value identifying this element.
type: integer
schema:
type: integer
- name: component
required: false
in: query
description: ''
type: string
schema:
type: string
- name: element_id
required: false
in: query
description: ''
type: number
schema:
type: number
tags:
- stationtests
/stationtests/element_error/:
get:
operationId: stationtests_element_error_list
summary: list of the element which have experienced an error
summary: list of the element which have experienced an error
responses:
'200':
description: ''
......@@ -418,37 +630,44 @@ paths:
required: false
in: query
description: A page number within the paginated result set.
type: integer
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
type: integer
schema:
type: integer
- name: element
required: false
in: query
description: ''
type: string
schema:
type: string
- name: component_error
required: false
in: query
description: ''
type: string
schema:
type: string
- name: station_test
required: false
in: query
description: ''
type: string
schema:
type: string
- name: type
required: false
in: query
description: ''
type: string
schema:
type: string
- name: details
required: false
in: query
description: ''
type: string
schema:
type: string
tags:
- stationtests
'/stationtests/element_error/{id}/':
......@@ -463,32 +682,38 @@ paths:
required: true
in: path
description: A unique integer value identifying this element error.
type: integer
schema:
type: integer
- name: element
required: false
in: query
description: ''
type: string
schema:
type: string
- name: component_error
required: false
in: query
description: ''
type: string
schema:
type: string
- name: station_test
required: false
in: query
description: ''
type: string
schema:
type: string
- name: type
required: false
in: query
description: ''
type: string
schema:
type: string
- name: details
required: false
in: query
description: ''
type: string
schema:
type: string
tags:
- stationtests
/stationtests/error_details/:
......@@ -496,7 +721,6 @@ paths:
operationId: stationtests_error_details_list
summary: list all the error details
description: list all the error details for either a component or an element error
responses:
'200':
description: ''
......@@ -505,522 +729,34 @@ paths:
required: false
in: query
description: A page number within the paginated result set.
type: integer
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
type: integer
- name: x
required: false
in: query
description: ''
type: string
- name: 'y'
required: false
in: query
description: ''
type: string
- name: xval
required: false
in: query
description: ''
type: number
- name: yval
required: false
in: query
description: ''
type: number
- name: xoff
required: false
in: query
description: ''
type: number
- name: yoff
required: false
in: query
description: ''
type: number
- name: xval_no_delay
required: false
in: query
description: ''
type: number
- name: yval_no_delay
required: false
in: query
description: ''
type: number
- name: xsb_no_delay
required: false
in: query
description: ''
type: number
- name: ysb_no_delay
required: false
in: query
description: ''
type: number
- name: xref_no_delay
required: false
in: query
description: ''
type: number
- name: yref_no_delay
required: false
in: query
description: ''
type: number
- name: xref
required: false
in: query
description: ''
type: number
- name: yref
required: false
in: query
description: ''
type: number
- name: xsb_full_delay
required: false
in: query
description: ''
type: number
- name: ysb_full_delay
required: false
in: query
description: ''
type: number
- name: xref_full_delay
required: false
in: query
description: ''
type: number
- name: yref_full_delay
required: false
in: query
description: ''
type: number
- name: xval_full_delay
required: false
in: query
description: ''
type: number
- name: yval_full_delay
required: false
in: query
description: ''
type: number
- name: xlimit
required: false
in: query
description: ''
type: number
- name: ylimit
required: false
in: query
description: ''
type: number
- name: xproc
required: false
in: query
description: ''
type: number
- name: yproc
required: false
in: query
description: ''
type: number
- name: xdiff
required: false
in: query
description: ''
type: number
- name: ydiff
required: false
in: query
description: ''
type: number
- name: xmean
required: false
in: query
description: ''
type: number
- name: ymean
required: false
in: query
description: ''
type: number
- name: tp
required: false
in: query
description: ''
type: string
- name: mp
required: false
in: query
description: ''
type: string
- name: ap
required: false
in: query
description: ''
type: string
- name: bp
required: false
in: query
description: ''
type: string
- name: mp0
required: false
in: query
description: ''
type: string
- name: mp1
required: false
in: query
description: ''
type: string
- name: mp2
required: false
in: query
description: ''
type: string
- name: mp3
required: false
in: query
description: ''
type: string
- name: ap0
required: false
in: query
description: ''
type: string
- name: ap1
required: false
in: query
description: ''
type: string
- name: ap2
required: false
in: query
schema:
type: integer
tags:
- stationtests
'/stationtests/error_details/{id}/':
get:
operationId: stationtests_error_details_read
summary: select an error details object with a specific id
description: select an error details object with a specific id
responses:
'200':
description: ''
type: string
- name: ap3
required: false
in: query
description: ''
type: string
- name: pcb
required: false
in: query
description: ''
type: string
- name: rcu_5_0v
required: false
in: query
description: ''
type: number
- name: lba_8_0v
required: false
in: query
description: ''
type: number
- name: hba_48v
required: false
in: query
description: ''
type: number
- name: spu_3_3v
required: false
in: query
description: ''
type: number
- name: v1_2
required: false
in: query
description: ''
type: number
- name: v2_5
required: false
in: query
description: ''
type: number
- name: v3_3
required: false
in: query
description: ''
type: number
- name: error_code
required: false
in: query
description: ''
type: string
tags:
- stationtests
'/stationtests/error_details/{id}/':
get:
operationId: stationtests_error_details_read
summary: select an error details object with a specific id
description: select an error details object with a specific id
responses:
'200':
description: ''
parameters:
- name: id
required: true
in: path
description: A unique integer value identifying this error details.
type: integer
- name: x
required: false
in: query
description: ''
type: string
- name: 'y'
required: false
in: query
description: ''
type: string
- name: xval
required: false
in: query
description: ''
type: number
- name: yval
required: false
in: query
description: ''
type: number
- name: xoff
required: false
in: query
description: ''
type: number
- name: yoff
required: false
in: query
description: ''
type: number
- name: xval_no_delay
required: false
in: query
description: ''
type: number
- name: yval_no_delay
required: false
in: query
description: ''
type: number
- name: xsb_no_delay
required: false
in: query
description: ''
type: number
- name: ysb_no_delay
required: false
in: query
description: ''
type: number
- name: xref_no_delay
required: false
in: query
description: ''
type: number
- name: yref_no_delay
required: false
in: query
description: ''
type: number
- name: xref
required: false
in: query
description: ''
type: number
- name: yref
required: false
in: query
description: ''
type: number
- name: xsb_full_delay
required: false
in: query
description: ''
type: number
- name: ysb_full_delay
required: false
in: query
description: ''
type: number
- name: xref_full_delay
required: false
in: query
description: ''
type: number
- name: yref_full_delay
required: false
in: query
description: ''
type: number
- name: xval_full_delay
required: false
in: query
description: ''
type: number
- name: yval_full_delay
required: false
in: query
description: ''
type: number
- name: xlimit
required: false
in: query
description: ''
type: number
- name: ylimit
required: false
in: query
description: ''
type: number
- name: xproc
required: false
in: query
description: ''
type: number
- name: yproc
required: false
in: query
description: ''
type: number
- name: xdiff
required: false
in: query
description: ''
type: number
- name: ydiff
required: false
in: query
description: ''
type: number
- name: xmean
required: false
in: query
description: ''
type: number
- name: ymean
required: false
in: query
description: ''
type: number
- name: tp
required: false
in: query
description: ''
type: string
- name: mp
required: false
in: query
description: ''
type: string
- name: ap
required: false
in: query
description: ''
type: string
- name: bp
required: false
in: query
description: ''
type: string
- name: mp0
required: false
in: query
description: ''
type: string
- name: mp1
required: false
in: query
description: ''
type: string
- name: mp2
required: false
in: query
description: ''
type: string
- name: mp3
required: false
in: query
description: ''
type: string
- name: ap0
required: false
in: query
description: ''
type: string
- name: ap1
required: false
in: query
description: ''
type: string
- name: ap2
required: false
in: query
description: ''
type: string
- name: ap3
required: false
in: query
description: ''
type: string
- name: pcb
required: false
in: query
description: ''
type: string
- name: rcu_5_0v
required: false
in: query
description: ''
type: number
- name: lba_8_0v
required: false
in: query
description: ''
type: number
- name: hba_48v
required: false
in: query
description: ''
type: number
- name: spu_3_3v
required: false
in: query
description: ''
type: number
- name: v1_2
required: false
in: query
description: ''
type: number
- name: v2_5
required: false
in: query
description: ''
type: number
- name: v3_3
required: false
in: query
description: ''
type: number
- name: error_code
required: false
in: query
description: ''
type: string
schema:
type: integer
tags:
- stationtests
/stationtests/insert_raw:
/stationtests/raw/insert:
post:
operationId: stationtests_insert_raw_create
responses:
......@@ -1029,157 +765,11 @@ paths:
'400':
description: an error occurred while parsing
parameters: []
description: >-
description: |-
This function is meant to parse a request of the form
{
"content": "[STATION TEST RAW TEXT]"
}
summary: Insert raw station test output
tags:
- stationtests
/stationtests/station/:
get:
operationId: stationtests_station_list
description: list the stations that have been tested by the stationtests
summary: List all the stations that have been tested by the stationtests
responses:
'200':
description: ''
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
type: integer
- name: location
required: false
in: query
description: ''
type: string
- name: name
required: false
in: query
description: ''
type: string
- name: type
required: false
in: query
description: ''
type: string
tags:
- stationtests
'/stationtests/station/{id}/':
get:
operationId: stationtests_station_read
summary: select a specific station
description: returns the summary of a specific station
responses:
'200':
description: ''
parameters:
- name: id
required: true
in: path
description: A unique integer value identifying this station.
type: integer
- name: location
required: false
in: query
description: ''
type: string
- name: name
required: false
in: query
description: ''
type: string
- name: type
required: false
in: query
description: ''
type: string
tags:
- stationtests
/stationtests/station_test/:
get:
operationId: stationtests_station_test_list
summary: list the latest station tests
responses:
'200':
description: ''
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
type: integer
- name: start_datetime
required: false
in: query
description: ''
type: string
- name: end_datetime
required: false
in: query
description: ''
type: string
- name: checks
required: false
in: query
description: ''
type: string
- name: station
required: false
in: query
description: ''
type: string
tags:
- stationtests
'/stationtests/station_test/{id}/':
get:
operationId: stationtests_station_test_read
summary: select a specific station test with the given id
responses:
'200':
description: ''
parameters:
- name: id
required: true
in: path
description: A unique integer value identifying this station test.
type: integer
- name: start_datetime
required: false
in: query
description: ''
type: string
- name: end_datetime
required: false
in: query
description: ''
type: string
- name: checks
required: false
in: query
description: ''
type: string
- name: station
required: false
in: query
description: ''
type: string
tags:
- stationtests
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