54 lines
1.1 KiB
YAML
54 lines
1.1 KiB
YAML
|
openapi: 3.0.2
|
||
|
|
|
||
|
|
|
||
|
|
info:
|
||
|
|
title: Digital fingerprint of plastics - API
|
||
|
|
version: 1.0.0
|
||
|
|
description: Gives access to the project database
|
||
|
|
|
||
|
|
|
||
|
|
servers:
|
||
|
|
- url: http://localhost:3000
|
||
|
|
description: local server
|
||
|
|
- url: https://digital-fingerprint-of-plastics-api.apps.de1.bosch-iot-cloud.com/
|
||
|
|
description: server on the BIC
|
||
|
|
|
||
|
|
|
||
|
|
tags:
|
||
|
|
- name: /
|
||
|
|
|
||
|
|
|
||
|
|
paths:
|
||
|
|
/:
|
||
|
|
get:
|
||
|
|
summary: Root method
|
||
|
|
tags:
|
||
|
|
- /
|
||
|
|
responses:
|
||
|
|
200:
|
||
|
|
description: Server is working
|
||
|
|
content:
|
||
|
|
application/json:
|
||
|
|
schema:
|
||
|
|
properties:
|
||
|
|
message:
|
||
|
|
type: string
|
||
|
|
example: 'API server up and running!'
|
||
|
|
500:
|
||
|
|
$ref: '#/components/responses/500'
|
||
|
|
|
||
|
|
components:
|
||
|
|
responses:
|
||
|
|
500:
|
||
|
|
description: Internal server error
|
||
|
|
content:
|
||
|
|
application/json:
|
||
|
|
schema:
|
||
|
|
properties:
|
||
|
|
message:
|
||
|
|
type: string
|
||
|
|
example: 'Internal server error'
|
||
|
|
error:
|
||
|
|
type: boolean
|
||
|
|
example: true
|