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

feat: initialize Swagger documentation for authentication and proxy endpoints
Build and Release / release (push) Successful in 1m36s
Details

Browse Source
This commit is contained in:
Azen Kain
2026-05-27 18:36:56 +07:00
parent d02006390b
commit 1d0733819d
3 changed files with 384 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docs.go
+144
View File
@@ -2885,6 +2885,150 @@ const docTemplate = `{
}
}
},
"/relations/entities-by-geometries": {
"get": {
"description": "Get entities grouped by geometry IDs",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Relations"
],
"summary": "Get entities by geometry IDs",
"parameters": [
{
"minItems": 1,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv",
"name": "geometry_ids",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/history-api_internal_dtos_response.CommonResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/history-api_internal_dtos_response.CommonResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/history-api_internal_dtos_response.CommonResponse"
}
}
}
}
},
"/relations/wiki-contents/preview": {
"get": {
"description": "Get previews of specific wiki contents by a list of their IDs",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Relations"
],
"summary": "Get wiki content previews by IDs",
"parameters": [
{
"minItems": 1,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv",
"name": "ids",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/history-api_internal_dtos_response.CommonResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/history-api_internal_dtos_response.CommonResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/history-api_internal_dtos_response.CommonResponse"
}
}
}
}
},
"/relations/wikis-by-entities": {
"get": {
"description": "Get wikis grouped by entity IDs",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Relations"
],
"summary": "Get wikis by entity IDs",
"parameters": [
{
"minItems": 1,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv",
"name": "entity_ids",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/history-api_internal_dtos_response.CommonResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/history-api_internal_dtos_response.CommonResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/history-api_internal_dtos_response.CommonResponse"
}
}
}
}
},
"/roles": {
"get": {
"security": [
docs/swagger.json
+144
View File
@@ -2878,6 +2878,150 @@
}
}
},
"/relations/entities-by-geometries": {
"get": {
"description": "Get entities grouped by geometry IDs",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Relations"
],
"summary": "Get entities by geometry IDs",
"parameters": [
{
"minItems": 1,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv",
"name": "geometry_ids",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/history-api_internal_dtos_response.CommonResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/history-api_internal_dtos_response.CommonResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/history-api_internal_dtos_response.CommonResponse"
}
}
}
}
},
"/relations/wiki-contents/preview": {
"get": {
"description": "Get previews of specific wiki contents by a list of their IDs",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Relations"
],
"summary": "Get wiki content previews by IDs",
"parameters": [
{
"minItems": 1,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv",
"name": "ids",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/history-api_internal_dtos_response.CommonResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/history-api_internal_dtos_response.CommonResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/history-api_internal_dtos_response.CommonResponse"
}
}
}
}
},
"/relations/wikis-by-entities": {
"get": {
"description": "Get wikis grouped by entity IDs",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Relations"
],
"summary": "Get wikis by entity IDs",
"parameters": [
{
"minItems": 1,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv",
"name": "entity_ids",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/history-api_internal_dtos_response.CommonResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/history-api_internal_dtos_response.CommonResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/history-api_internal_dtos_response.CommonResponse"
}
}
}
}
},
"/roles": {
"get": {
"security": [
docs/swagger.yaml
+96
View File
@@ -2623,6 +2623,102 @@ paths:
summary: Get raster tile metadata
tags:
- Tile
/relations/entities-by-geometries:
get:
consumes:
- application/json
description: Get entities grouped by geometry IDs
parameters:
- collectionFormat: csv
in: query
items:
type: string
minItems: 1
name: geometry_ids
required: true
type: array
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/history-api_internal_dtos_response.CommonResponse'
"400":
description: Bad Request
schema:
$ref: '#/definitions/history-api_internal_dtos_response.CommonResponse'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/history-api_internal_dtos_response.CommonResponse'
summary: Get entities by geometry IDs
tags:
- Relations
/relations/wiki-contents/preview:
get:
consumes:
- application/json
description: Get previews of specific wiki contents by a list of their IDs
parameters:
- collectionFormat: csv
in: query
items:
type: string
minItems: 1
name: ids
required: true
type: array
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/history-api_internal_dtos_response.CommonResponse'
"400":
description: Bad Request
schema:
$ref: '#/definitions/history-api_internal_dtos_response.CommonResponse'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/history-api_internal_dtos_response.CommonResponse'
summary: Get wiki content previews by IDs
tags:
- Relations
/relations/wikis-by-entities:
get:
consumes:
- application/json
description: Get wikis grouped by entity IDs
parameters:
- collectionFormat: csv
in: query
items:
type: string
minItems: 1
name: entity_ids
required: true
type: array
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/history-api_internal_dtos_response.CommonResponse'
"400":
description: Bad Request
schema:
$ref: '#/definitions/history-api_internal_dtos_response.CommonResponse'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/history-api_internal_dtos_response.CommonResponse'
summary: Get wikis by entity IDs
tags:
- Relations
/roles:
get:
consumes: