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": {