Klagarge/MSE-SoftwEng
1
0
Fork 0
Code Issues Pull Requests Releases Activity

feat(gateway): small adaption for softweng project

Browse Source 
Signed-off-by: Klagarge <remi@heredero.ch>
This commit is contained in:
Rémi Heredero
2025-04-15 01:03:57 +02:00
parent 0b57f26688
commit f4d088decd
7 changed files with 100 additions and 116 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
gateway/src/docs/docs.go
View File

@@ -59,7 +59,15 @@ const docTemplate = `{
"parameters": [
{
"type": "string",
"example": "Garage",
"example": "remi",
"description": "User name",
"name": "user",
"in": "query",
"required": true
},
{
"type": "string",
"example": "Bedroom",
"description": "Room name",
"name": "room",
"in": "query",
@@ -67,7 +75,7 @@ const docTemplate = `{
},
{
"type": "string",
"example": "Door",
"example": "DoorSensor",
"description": "Device name",
"name": "device",
"in": "query",
@@ -78,7 +86,8 @@ const docTemplate = `{
"200": {
"description": "Returns a map of field names to their latest values.",
"schema": {
"$ref": "#/definitions/main.GarageDoorExample"
"type": "object",
"additionalProperties": true
}
},
"500": {
@@ -109,7 +118,15 @@ const docTemplate = `{
"parameters": [
{
"type": "string",
"example": "Garage",
"example": "remi",
"description": "User name",
"name": "user",
"in": "query",
"required": true
},
{
"type": "string",
"example": "Bedroom",
"description": "Room name",
"name": "room",
"in": "query",
@@ -117,7 +134,7 @@ const docTemplate = `{
},
{
"type": "string",
"example": "Door",
"example": "DoorSensor",
"description": "Device name",
"name": "device",
"in": "query",
@@ -170,32 +187,6 @@ const docTemplate = `{
"example": "UP"
}
}
},
"main.GarageDoorExample": {
"description": "Example response for Garage Door status",
"type": "object",
"properties": {
"IsClosed": {
"description": "example: true",
"type": "boolean"
},
"IsDownButtonPressed": {
"description": "example: false",
"type": "boolean"
},
"IsIRSensor": {
"description": "example: false",
"type": "boolean"
},
"IsOpen": {
"description": "example: false",
"type": "boolean"
},
"IsUpButtonPressed": {
"description": "example: false",
"type": "boolean"
}
}
}
},
"securityDefinitions": {

53
gateway/src/docs/swagger.json
View File

@@ -53,7 +53,15 @@
"parameters": [
{
"type": "string",
"example": "Garage",
"example": "remi",
"description": "User name",
"name": "user",
"in": "query",
"required": true
},
{
"type": "string",
"example": "Bedroom",
"description": "Room name",
"name": "room",
"in": "query",
@@ -61,7 +69,7 @@
},
{
"type": "string",
"example": "Door",
"example": "DoorSensor",
"description": "Device name",
"name": "device",
"in": "query",
@@ -72,7 +80,8 @@
"200": {
"description": "Returns a map of field names to their latest values.",
"schema": {
"$ref": "#/definitions/main.GarageDoorExample"
"type": "object",
"additionalProperties": true
}
},
"500": {
@@ -103,7 +112,15 @@
"parameters": [
{
"type": "string",
"example": "Garage",
"example": "remi",
"description": "User name",
"name": "user",
"in": "query",
"required": true
},
{
"type": "string",
"example": "Bedroom",
"description": "Room name",
"name": "room",
"in": "query",
@@ -111,7 +128,7 @@
},
{
"type": "string",
"example": "Door",
"example": "DoorSensor",
"description": "Device name",
"name": "device",
"in": "query",
@@ -164,32 +181,6 @@
"example": "UP"
}
}
},
"main.GarageDoorExample": {
"description": "Example response for Garage Door status",
"type": "object",
"properties": {
"IsClosed": {
"description": "example: true",
"type": "boolean"
},
"IsDownButtonPressed": {
"description": "example: false",
"type": "boolean"
},
"IsIRSensor": {
"description": "example: false",
"type": "boolean"
},
"IsOpen": {
"description": "example: false",
"type": "boolean"
},
"IsUpButtonPressed": {
"description": "example: false",
"type": "boolean"
}
}
}
},
"securityDefinitions": {

42
gateway/src/docs/swagger.yaml
View File

@@ -12,25 +12,6 @@ definitions:
required:
- command
type: object
main.GarageDoorExample:
description: Example response for Garage Door status
properties:
IsClosed:
description: 'example: true'
type: boolean
IsDownButtonPressed:
description: 'example: false'
type: boolean
IsIRSensor:
description: 'example: false'
type: boolean
IsOpen:
description: 'example: false'
type: boolean
IsUpButtonPressed:
description: 'example: false'
type: boolean
type: object
host: rest.mse.kb28.ch
info:
contact: {}
@@ -59,14 +40,20 @@ paths:
- application/json
description: Request data from InfluxDB for a specific device in a room
parameters:
- description: User name
example: remi
in: query
name: user
required: true
type: string
- description: Room name
example: Garage
example: Bedroom
in: query
name: room
required: true
type: string
- description: Device name
example: Door
example: DoorSensor
in: query
name: device
required: true
@@ -77,7 +64,8 @@ paths:
"200":
description: Returns a map of field names to their latest values.
schema:
$ref: '#/definitions/main.GarageDoorExample'
additionalProperties: true
type: object
"500":
description: Internal Server Error
schema:
@@ -92,14 +80,20 @@ paths:
- application/json
description: Publish a command to a specific device in a room
parameters:
- description: User name
example: remi
in: query
name: user
required: true
type: string
- description: Room name
example: Garage
example: Bedroom
in: query
name: room
required: true
type: string
- description: Device name
example: Door
example: DoorSensor
in: query
name: device
required: true