API Noise emission
Number of APIs: 2
Welcome to the documentation of the Noise API
Compatibility guidelines
The HTTP API is versioned with a single number, which is currently 1
The first number symbolizes the major version number. New features can be added to the API in the same version number if there is no breaking change.
The version number is present in the url, for instance /noise/api/v1 for the current version.
Authentication
Every endpoints of this API require authentication using an API key.
If you don't have an API Key and you need to use the Noise emission API, you need to ask Sinay to have one.
To use the API Key, you must add a header named API_KEY with your API Key as a value.
Test the API with Swagger-ui
To test the API using Swagger-ui, you must click on the button Authorize and then fill the apiKey field and click on Authorize.
Swagger-ui will then use the api key automatically in each request.
On every endpoints, you can click on Try it out, you can modify the body and then click on Execute
You will be able to see the response.
Release note
1.1.3
- Add required true to query
1.1.0
- Definition of the api with swagger
0.0.4
- Change schemas names for avoiding conflicts
0.0.1
- Noise computation (SEL and thresholds comparisons) for a vessel from a port to another port