mazyar/tm_back
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update Configuration and Enhance Tender Approval Pagination

Browse Source 
- Changed the server port from 8081 to 8082 for the web application.
- Updated MongoDB URI to include authentication credentials for improved security.
- Added new query parameters `limit` and `offset` for pagination in tender approval retrieval, enhancing the API's flexibility.
- Modified the response structure to include metadata for pagination, improving the clarity of responses.
- Updated API documentation to reflect the new pagination parameters and response format, ensuring consistency for API consumers.
This commit is contained in:
n.nakhostin
2025-09-06 12:07:32 +03:30
parent 61a217cf09
commit eb69a842f0
10 changed files with 171 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cmd/web/docs/docs.go
+33 -5
View File
@@ -6006,6 +6006,23 @@ const docTemplate = `{
],
"summary": "Get tender approvals by company ID",
"parameters": [
{
"maximum": 100,
"minimum": 1,
"type": "integer",
"default": 20,
"description": "Number of approvals per page (1-100)",
"name": "limit",
"in": "query"
},
{
"minimum": 0,
"type": "integer",
"default": 0,
"description": "Number of approvals to skip for pagination",
"name": "offset",
"in": "query"
},
{
"enum": [
"self-apply",
@@ -6051,10 +6068,7 @@ const docTemplate = `{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/tender_approval.TenderApprovalWithTenderResponse"
}
"$ref": "#/definitions/tender_approval.TenderApprovalWithTenderListResponse"
}
}
}
@@ -8171,6 +8185,20 @@ const docTemplate = `{
}
}
},
"tender_approval.TenderApprovalWithTenderListResponse": {
"type": "object",
"properties": {
"metadata": {
"$ref": "#/definitions/response.Meta"
},
"tenders": {
"type": "array",
"items": {
"$ref": "#/definitions/tender_approval.TenderApprovalWithTenderResponse"
}
}
}
},
"tender_approval.TenderApprovalWithTenderResponse": {
"type": "object",
"properties": {
@@ -8585,7 +8613,7 @@ const docTemplate = `{
// SwaggerInfo holds exported Swagger Info so clients can modify it
var SwaggerInfo = &swag.Spec{
Version: "2.0.0",
Host: "localhost:8081",
Host: "localhost:8082",
BasePath: "/",
Schemes: []string{},
Title: "Tender Management API",
cmd/web/docs/swagger.json
+33 -5
View File
@@ -15,7 +15,7 @@
},
"version": "2.0.0"
},
"host": "localhost:8081",
"host": "localhost:8082",
"basePath": "/",
"paths": {
"/admin/tenders": {
@@ -6000,6 +6000,23 @@
],
"summary": "Get tender approvals by company ID",
"parameters": [
{
"maximum": 100,
"minimum": 1,
"type": "integer",
"default": 20,
"description": "Number of approvals per page (1-100)",
"name": "limit",
"in": "query"
},
{
"minimum": 0,
"type": "integer",
"default": 0,
"description": "Number of approvals to skip for pagination",
"name": "offset",
"in": "query"
},
{
"enum": [
"self-apply",
@@ -6045,10 +6062,7 @@
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/tender_approval.TenderApprovalWithTenderResponse"
}
"$ref": "#/definitions/tender_approval.TenderApprovalWithTenderListResponse"
}
}
}
@@ -8165,6 +8179,20 @@
}
}
},
"tender_approval.TenderApprovalWithTenderListResponse": {
"type": "object",
"properties": {
"metadata": {
"$ref": "#/definitions/response.Meta"
},
"tenders": {
"type": "array",
"items": {
"$ref": "#/definitions/tender_approval.TenderApprovalWithTenderResponse"
}
}
}
},
"tender_approval.TenderApprovalWithTenderResponse": {
"type": "object",
"properties": {
cmd/web/docs/swagger.yaml
+24 -4
View File
@@ -1045,6 +1045,15 @@ definitions:
total_approvals:
type: integer
type: object
tender_approval.TenderApprovalWithTenderListResponse:
properties:
metadata:
$ref: '#/definitions/response.Meta'
tenders:
items:
$ref: '#/definitions/tender_approval.TenderApprovalWithTenderResponse'
type: array
type: object
tender_approval.TenderApprovalWithTenderResponse:
properties:
company_id:
@@ -1288,7 +1297,7 @@ definitions:
username:
type: string
type: object
host: localhost:8081
host: localhost:8082
info:
contact:
email: api-support@tender-management.com
@@ -5061,6 +5070,19 @@ paths:
description: Retrieve all tender approvals for a specific company with optional
filtering
parameters:
- default: 20
description: Number of approvals per page (1-100)
in: query
maximum: 100
minimum: 1
name: limit
type: integer
- default: 0
description: Number of approvals to skip for pagination
in: query
minimum: 0
name: offset
type: integer
- description: Filter by submission mode Enums(self-apply, partnership)
enum:
- self-apply
@@ -5093,9 +5115,7 @@ paths:
- $ref: '#/definitions/response.APIResponse'
- properties:
data:
items:
$ref: '#/definitions/tender_approval.TenderApprovalWithTenderResponse'
type: array
$ref: '#/definitions/tender_approval.TenderApprovalWithTenderListResponse'
type: object
"400":
description: Bad request - Invalid company ID