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

Update Tender Approval Status to Include Submitted State and Revise API Documentation

Browse Source 
- Changed the approval status from "approved" to "submitted" in various locations, including entity definitions, forms, and service methods, to accurately reflect the tender approval process.
- Updated API documentation in Swagger JSON, YAML, and Go files to describe the new status options ("submitted" and "rejected") and their corresponding descriptions.
- Enhanced the tender approval statistics structures to include a count for submitted tenders, improving the overall data model for tender management.
- These changes ensure clarity in the tender approval workflow and enhance the usability of the API for clients interacting with tender approvals.
This commit is contained in:
n.nakhostin
2025-08-25 13:51:14 +03:30
parent 0e14a11daf
commit 3024998e7e
9 changed files with 89 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cmd/web/docs/docs.go
+15 -15
View File
@@ -4080,7 +4080,7 @@ const docTemplate = `{
"BearerAuth": []
}
],
"description": "Retrieve tender approvals filtered by their status (approved, rejected)",
"description": "Retrieve tender approvals filtered by their status (submitted, rejected)",
"consumes": [
"application/json"
],
@@ -4094,7 +4094,7 @@ const docTemplate = `{
"parameters": [
{
"enum": [
"approved",
"submitted",
"rejected"
],
"type": "string",
@@ -6018,11 +6018,11 @@ const docTemplate = `{
},
{
"enum": [
"approved",
"submitted",
"rejected"
],
"type": "string",
"description": "Filter by status Enums(approved, rejected)",
"description": "Filter by status Enums(submitted, rejected)",
"name": "status",
"in": "query"
}
@@ -7989,28 +7989,25 @@ const docTemplate = `{
"tender_approval.ApprovalStatus": {
"type": "string",
"enum": [
"approved",
"submitted",
"rejected"
],
"x-enum-comments": {
"ApprovalStatusApproved": "Company approved the tender",
"ApprovalStatusRejected": "Company rejected the tender"
"ApprovalStatusRejected": "Company rejected the tender",
"ApprovalStatusSubmitted": "Company submitted the tender"
},
"x-enum-descriptions": [
"Company approved the tender",
"Company submitted the tender",
"Company rejected the tender"
],
"x-enum-varnames": [
"ApprovalStatusApproved",
"ApprovalStatusSubmitted",
"ApprovalStatusRejected"
]
},
"tender_approval.CompanyTenderApprovalStatsResponse": {
"type": "object",
"properties": {
"approved_tenders": {
"type": "integer"
},
"company_id": {
"type": "string"
},
@@ -8026,6 +8023,9 @@ const docTemplate = `{
"self_apply_count": {
"type": "integer"
},
"submitted_tenders": {
"type": "integer"
},
"total_approvals": {
"type": "integer"
}
@@ -8121,15 +8121,15 @@ const docTemplate = `{
"tender_approval.TenderApprovalStatsResponse": {
"type": "object",
"properties": {
"approved_tenders": {
"type": "integer"
},
"last_updated": {
"type": "integer"
},
"rejected_tenders": {
"type": "integer"
},
"submitted_tenders": {
"type": "integer"
},
"total_approvals": {
"type": "integer"
}
cmd/web/docs/swagger.json
+15 -15
View File
@@ -4074,7 +4074,7 @@
"BearerAuth": []
}
],
"description": "Retrieve tender approvals filtered by their status (approved, rejected)",
"description": "Retrieve tender approvals filtered by their status (submitted, rejected)",
"consumes": [
"application/json"
],
@@ -4088,7 +4088,7 @@
"parameters": [
{
"enum": [
"approved",
"submitted",
"rejected"
],
"type": "string",
@@ -6012,11 +6012,11 @@
},
{
"enum": [
"approved",
"submitted",
"rejected"
],
"type": "string",
"description": "Filter by status Enums(approved, rejected)",
"description": "Filter by status Enums(submitted, rejected)",
"name": "status",
"in": "query"
}
@@ -7983,28 +7983,25 @@
"tender_approval.ApprovalStatus": {
"type": "string",
"enum": [
"approved",
"submitted",
"rejected"
],
"x-enum-comments": {
"ApprovalStatusApproved": "Company approved the tender",
"ApprovalStatusRejected": "Company rejected the tender"
"ApprovalStatusRejected": "Company rejected the tender",
"ApprovalStatusSubmitted": "Company submitted the tender"
},
"x-enum-descriptions": [
"Company approved the tender",
"Company submitted the tender",
"Company rejected the tender"
],
"x-enum-varnames": [
"ApprovalStatusApproved",
"ApprovalStatusSubmitted",
"ApprovalStatusRejected"
]
},
"tender_approval.CompanyTenderApprovalStatsResponse": {
"type": "object",
"properties": {
"approved_tenders": {
"type": "integer"
},
"company_id": {
"type": "string"
},
@@ -8020,6 +8017,9 @@
"self_apply_count": {
"type": "integer"
},
"submitted_tenders": {
"type": "integer"
},
"total_approvals": {
"type": "integer"
}
@@ -8115,15 +8115,15 @@
"tender_approval.TenderApprovalStatsResponse": {
"type": "object",
"properties": {
"approved_tenders": {
"type": "integer"
},
"last_updated": {
"type": "integer"
},
"rejected_tenders": {
"type": "integer"
},
"submitted_tenders": {
"type": "integer"
},
"total_approvals": {
"type": "integer"
}
cmd/web/docs/swagger.yaml
+13 -12
View File
@@ -947,22 +947,20 @@ definitions:
type: object
tender_approval.ApprovalStatus:
enum:
- approved
- submitted
- rejected
type: string
x-enum-comments:
ApprovalStatusApproved: Company approved the tender
ApprovalStatusRejected: Company rejected the tender
ApprovalStatusSubmitted: Company submitted the tender
x-enum-descriptions:
- Company approved the tender
- Company submitted the tender
- Company rejected the tender
x-enum-varnames:
- ApprovalStatusApproved
- ApprovalStatusSubmitted
- ApprovalStatusRejected
tender_approval.CompanyTenderApprovalStatsResponse:
properties:
approved_tenders:
type: integer
company_id:
type: string
last_updated:
@@ -973,6 +971,8 @@ definitions:
type: integer
self_apply_count:
type: integer
submitted_tenders:
type: integer
total_approvals:
type: integer
type: object
@@ -1036,12 +1036,12 @@ definitions:
type: object
tender_approval.TenderApprovalStatsResponse:
properties:
approved_tenders:
type: integer
last_updated:
type: integer
rejected_tenders:
type: integer
submitted_tenders:
type: integer
total_approvals:
type: integer
type: object
@@ -3933,11 +3933,12 @@ paths:
get:
consumes:
- application/json
description: Retrieve tender approvals filtered by their status (approved, rejected)
description: Retrieve tender approvals filtered by their status (submitted,
rejected)
parameters:
- description: Tender approval status
enum:
- approved
- submitted
- rejected
in: path
name: status
@@ -5067,9 +5068,9 @@ paths:
in: query
name: submission_mode
type: string
- description: Filter by status Enums(approved, rejected)
- description: Filter by status Enums(submitted, rejected)
enum:
- approved
- submitted
- rejected
in: query
name: status