Kain344/History_Api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: generate Swagger API documentation for authentication endpoints
All checks were successful
Build and Release / release (push) Successful in 1m28s
Details

Browse Source
This commit is contained in:
Azen Kain
2026-05-06 06:44:02 +07:00
parent fe9543d896
commit 76c5f55cdd
3 changed files with 134 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
docs/docs.go
View File

@@ -708,6 +708,56 @@ const docTemplate = `{
}
}
},
"/geometries/entity": {
"get": {
"description": "Search entities by name (cursor pagination) and return their linked geometries",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Geometries"
],
"summary": "Search geometries by entity name",
"parameters": [
{
"type": "string",
"name": "cursor",
"in": "query"
},
{
"maximum": 100,
"minimum": 1,
"type": "integer",
"name": "limit",
"in": "query"
},
{
"maxLength": 255,
"type": "string",
"name": "name",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/history-api_internal_dtos_response.CommonResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/history-api_internal_dtos_response.CommonResponse"
}
}
}
}
},
"/geometries/{id}": {
"get": {
"description": "Get detailed information about a specific geometry",

50
docs/swagger.json
View File

@@ -701,6 +701,56 @@
}
}
},
"/geometries/entity": {
"get": {
"description": "Search entities by name (cursor pagination) and return their linked geometries",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Geometries"
],
"summary": "Search geometries by entity name",
"parameters": [
{
"type": "string",
"name": "cursor",
"in": "query"
},
{
"maximum": 100,
"minimum": 1,
"type": "integer",
"name": "limit",
"in": "query"
},
{
"maxLength": 255,
"type": "string",
"name": "name",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/history-api_internal_dtos_response.CommonResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/history-api_internal_dtos_response.CommonResponse"
}
}
}
}
},
"/geometries/{id}": {
"get": {
"description": "Get detailed information about a specific geometry",

34
docs/swagger.yaml
View File

@@ -1095,6 +1095,40 @@ paths:
summary: Get geometry by ID
tags:
- Geometries
/geometries/entity:
get:
consumes:
- application/json
description: Search entities by name (cursor pagination) and return their linked
geometries
parameters:
- in: query
name: cursor
type: string
- in: query
maximum: 100
minimum: 1
name: limit
type: integer
- in: query
maxLength: 255
name: name
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/history-api_internal_dtos_response.CommonResponse'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/history-api_internal_dtos_response.CommonResponse'
summary: Search geometries by entity name
tags:
- Geometries
/historian/application:
get:
consumes: