Skip to content
This repository was archived by the owner on Oct 12, 2026. It is now read-only.

feat: validate a whole form in one request #8

Merged
jeferson0306 merged 1 commit into from
Sep 4, 2026
Merged

feat: validate a whole form in one request #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
146 changes: 146 additions & 0 deletions docs/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,155 @@ const docTemplate = `{
}
}
}
},
"/validate/batch": {
"post": {
"description": "Checks a list of values, each with its own document type. Returns one result per item plus a summary.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Validation"
],
"summary": "Validates several values in one request",
"parameters": [
{
"description": "Values to validate",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.BatchRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/models.BatchResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/models.BatchResponse"
}
}
}
}
}
},
"definitions": {
"models.BatchItem": {
"type": "object",
"properties": {
"id": {
"description": "ID is echoed back untouched so the caller can line results up with its\nown form fields without relying on ordering.",
"type": "string"
},
"key": {
"description": "Key is the document type, matching the query parameter names of GET /validate.",
"type": "string"
},
"qualifier": {
"description": "Qualifier carries the extra context a few documents need — today only the\nissuing state for an inscrição estadual.",
"type": "string"
},
"value": {
"type": "string"
}
}
},
"models.BatchRequest": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/models.BatchItem"
}
}
}
},
"models.BatchResponse": {
"type": "object",
"properties": {
"error_code": {
"type": "string"
},
"execution_time_ms": {
"type": "integer"
},
"message": {
"type": "string"
},
"request_id": {
"type": "string"
},
"results": {
"type": "array",
"items": {
"$ref": "#/definitions/models.BatchResult"
}
},
"status_code": {
"type": "integer"
},
"summary": {
"$ref": "#/definitions/models.BatchSummary"
},
"timestamp": {
"type": "string"
}
}
},
"models.BatchResult": {
"type": "object",
"properties": {
"error_code": {
"type": "string"
},
"from_cache": {
"type": "boolean"
},
"id": {
"type": "string"
},
"is_valid": {
"type": "boolean"
},
"key": {
"type": "string"
},
"message": {
"type": "string"
},
"raw_value": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"models.BatchSummary": {
"type": "object",
"properties": {
"invalid": {
"type": "integer"
},
"total": {
"type": "integer"
},
"valid": {
"type": "integer"
}
}
},
"models.ValidationResponse": {
"type": "object",
"properties": {
Expand Down
146 changes: 146 additions & 0 deletions docs/swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,9 +130,155 @@
}
}
}
},
"/validate/batch": {
"post": {
"description": "Checks a list of values, each with its own document type. Returns one result per item plus a summary.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Validation"
],
"summary": "Validates several values in one request",
"parameters": [
{
"description": "Values to validate",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.BatchRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/models.BatchResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/models.BatchResponse"
}
}
}
}
}
},
"definitions": {
"models.BatchItem": {
"type": "object",
"properties": {
"id": {
"description": "ID is echoed back untouched so the caller can line results up with its\nown form fields without relying on ordering.",
"type": "string"
},
"key": {
"description": "Key is the document type, matching the query parameter names of GET /validate.",
"type": "string"
},
"qualifier": {
"description": "Qualifier carries the extra context a few documents need — today only the\nissuing state for an inscrição estadual.",
"type": "string"
},
"value": {
"type": "string"
}
}
},
"models.BatchRequest": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/models.BatchItem"
}
}
}
},
"models.BatchResponse": {
"type": "object",
"properties": {
"error_code": {
"type": "string"
},
"execution_time_ms": {
"type": "integer"
},
"message": {
"type": "string"
},
"request_id": {
"type": "string"
},
"results": {
"type": "array",
"items": {
"$ref": "#/definitions/models.BatchResult"
}
},
"status_code": {
"type": "integer"
},
"summary": {
"$ref": "#/definitions/models.BatchSummary"
},
"timestamp": {
"type": "string"
}
}
},
"models.BatchResult": {
"type": "object",
"properties": {
"error_code": {
"type": "string"
},
"from_cache": {
"type": "boolean"
},
"id": {
"type": "string"
},
"is_valid": {
"type": "boolean"
},
"key": {
"type": "string"
},
"message": {
"type": "string"
},
"raw_value": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"models.BatchSummary": {
"type": "object",
"properties": {
"invalid": {
"type": "integer"
},
"total": {
"type": "integer"
},
"valid": {
"type": "integer"
}
}
},
"models.ValidationResponse": {
"type": "object",
"properties": {
Expand Down
Loading
Loading