atualizando documentação e teste

dadosjusbr · Dec 19, 2024 · a912b9c · a912b9c
1 parent c403c47
commit a912b9c
Show file tree

Hide file tree

Showing 5 changed files with 87 additions and 62 deletions.
diff --git a/docs/docs.go b/docs/docs.go
@@ -1185,6 +1185,9 @@ const docTemplate = `{
                 "id_orgao": {
                     "type": "string"
                 },
+                "inconsistente": {
+                    "type": "boolean"
+                },
                 "indice_transparencia": {
                     "$ref": "#/definitions/papi.score"
                 },
@@ -1309,6 +1312,9 @@ const docTemplate = `{
                 "descontos_por_mes": {
                     "type": "number"
                 },
+                "inconsistente": {
+                    "type": "boolean"
+                },
                 "meses_com_dados": {
                     "type": "integer"
                 },
@@ -1686,6 +1692,9 @@ const docTemplate = `{
                 "error": {
                     "$ref": "#/definitions/uiapi.procError"
                 },
+                "inconsistente": {
+                    "type": "boolean"
+                },
                 "mes": {
                     "type": "integer"
                 },

diff --git a/docs/swagger.json b/docs/swagger.json
@@ -1176,6 +1176,9 @@
                 "id_orgao": {
                     "type": "string"
                 },
+                "inconsistente": {
+                    "type": "boolean"
+                },
                 "indice_transparencia": {
                     "$ref": "#/definitions/papi.score"
                 },
@@ -1300,6 +1303,9 @@
                 "descontos_por_mes": {
                     "type": "number"
                 },
+                "inconsistente": {
+                    "type": "boolean"
+                },
                 "meses_com_dados": {
                     "type": "integer"
                 },
@@ -1677,6 +1683,9 @@
                 "error": {
                     "$ref": "#/definitions/uiapi.procError"
                 },
+                "inconsistente": {
+                    "type": "boolean"
+                },
                 "mes": {
                     "type": "integer"
                 },

diff --git a/docs/swagger.yaml b/docs/swagger.yaml
@@ -278,6 +278,8 @@ definitions:
         $ref: '#/definitions/papi.miError'
       id_orgao:
         type: string
+      inconsistente:
+        type: boolean
       indice_transparencia:
         $ref: '#/definitions/papi.score'
       mes:
@@ -364,6 +366,8 @@ definitions:
         type: number
       descontos_por_mes:
         type: number
+      inconsistente:
+        type: boolean
       meses_com_dados:
         type: integer
       num_membros:
@@ -612,6 +616,8 @@ definitions:
         type: number
       error:
         $ref: '#/definitions/uiapi.procError'
+      inconsistente:
+        type: boolean
       mes:
         type: integer
       outras_remuneracoes:

diff --git a/papi/handlers.go b/papi/handlers.go
@@ -39,14 +39,14 @@ func (h handler) V1GetAgencyById(c echo.Context) error {
 	return c.JSON(http.StatusOK, agency)
 }
 
-// @ID				GetAgencyById
-// @Tags			public_api
-// @Description	Busca um órgão específico utilizando seu ID.
-// @Produce		json
-// @Param			orgao				path		string	true	"ID do órgão. Exemplos: tjal, tjba, mppb."
-// @Success		200					{object}	agency	"Requisição bem sucedida."
-// @Failure		404					{string}	string	"Órgão não encontrado."
-// @Router			/v2/orgao/{orgao} 	[get]
+//	@ID				GetAgencyById
+//	@Tags			public_api
+//	@Description	Busca um órgão específico utilizando seu ID.
+//	@Produce		json
+//	@Param			orgao				path		string	true	"ID do órgão. Exemplos: tjal, tjba, mppb."
+//	@Success		200					{object}	agency	"Requisição bem sucedida."
+//	@Failure		404					{string}	string	"Órgão não encontrado."
+//	@Router			/v2/orgao/{orgao} 	[get]
 func (h handler) V2GetAgencyById(c echo.Context) error {
 	agencyName := c.Param("orgao")
 	strAgency, err := h.client.Db.GetAgency(agencyName)
@@ -92,13 +92,13 @@ func (h handler) V1GetAllAgencies(c echo.Context) error {
 	return c.JSON(http.StatusOK, agencies)
 }
 
-// @ID				GetAllAgencies
-// @Tags			public_api
-// @Description	Busca todos os órgãos disponíveis.
-// @Produce		json
-// @Success		200			{object}	[]agency	"Requisição bem sucedida."
-// @Failure		500			{string}	string		"Erro interno do servidor."
-// @Router			/v2/orgaos 	[get]
+//	@ID				GetAllAgencies
+//	@Tags			public_api
+//	@Description	Busca todos os órgãos disponíveis.
+//	@Produce		json
+//	@Success		200			{object}	[]agency	"Requisição bem sucedida."
+//	@Failure		500			{string}	string		"Erro interno do servidor."
+//	@Router			/v2/orgaos 	[get]
 func (h handler) V2GetAllAgencies(c echo.Context) error {
 	strAgencies, err := h.client.Db.GetAllAgencies()
 	if err != nil {
@@ -264,17 +264,17 @@ func (h handler) GetMonthlyInfo(c echo.Context) error {
 	return c.JSON(http.StatusOK, sumMI)
 }
 
-// @ID				GetMonthlyInfo
-// @Tags			public_api
-// @Description	Busca um dado mensal de um órgão
-// @Produce		json
-// @Success		200		{object}	summaryzedMI	"Requisição bem sucedida"
-// @Failure		400		{string}	string			"Parâmetros inválidos"
-// @Failure		404		{string}	string			"Não existem dados para os parâmetros informados"
-// @Param			ano		path		int				true	"Ano"
-// @Param			orgao	path		string			true	"Órgão"
-// @Param			mes		path		int				true	"Mês"
-// @Router			/v2/dados/{orgao}/{ano}/{mes} [get]
+//	@ID				GetMonthlyInfo
+//	@Tags			public_api
+//	@Description	Busca um dado mensal de um órgão
+//	@Produce		json
+//	@Success		200		{object}	summaryzedMI	"Requisição bem sucedida"
+//	@Failure		400		{string}	string			"Parâmetros inválidos"
+//	@Failure		404		{string}	string			"Não existem dados para os parâmetros informados"
+//	@Param			ano		path		int				true	"Ano"
+//	@Param			orgao	path		string			true	"Órgão"
+//	@Param			mes		path		int				true	"Mês"
+//	@Router			/v2/dados/{orgao}/{ano}/{mes} [get]
 func (h handler) V2GetMonthlyInfo(c echo.Context) error {
 	year, err := strconv.Atoi(c.Param("ano"))
 	if err != nil {
@@ -398,16 +398,16 @@ func (h handler) V2GetMonthlyInfo(c echo.Context) error {
 	return c.JSON(http.StatusOK, sumMI)
 }
 
-// @ID				GetMonthlyInfosByYear
-// @Tags			public_api
-// @Description	Busca os dados mensais de um órgão por ano
-// @Produce		json
-// @Success		200		{object}	[]summaryzedMI	"Requisição bem sucedida"
-// @Failure		400		{string}	string			"Parâmetros inválidos"
-// @Failure		404		{string}	string			"Não existem dados para os parâmetros informados"
-// @Param			ano		path		int				true	"Ano"
-// @Param			orgao	path		string			true	"Órgão"
-// @Router			/v2/dados/{orgao}/{ano} [get]
+//	@ID				GetMonthlyInfosByYear
+//	@Tags			public_api
+//	@Description	Busca os dados mensais de um órgão por ano
+//	@Produce		json
+//	@Success		200		{object}	[]summaryzedMI	"Requisição bem sucedida"
+//	@Failure		400		{string}	string			"Parâmetros inválidos"
+//	@Failure		404		{string}	string			"Não existem dados para os parâmetros informados"
+//	@Param			ano		path		int				true	"Ano"
+//	@Param			orgao	path		string			true	"Órgão"
+//	@Router			/v2/dados/{orgao}/{ano} [get]
 func (h handler) GetMonthlyInfosByYear(c echo.Context) error {
 	year, err := strconv.Atoi(c.Param("ano"))
 	if err != nil {
@@ -532,16 +532,16 @@ func (h handler) GetMonthlyInfosByYear(c echo.Context) error {
 	return c.JSON(http.StatusOK, sumMI)
 }
 
-// @ID				GetAggregateIndexesWithParams
-// @Tags			public_api
-// @Description	Busca as informações de índices de um grupo ou órgão específico.
-// @Produce		json
-// @Success		200							{object}	[]aggregateIndexes	"Requisição bem sucedida."
-// @Failure		400							{string}	string				"Requisição inválida."
-// @Failure		500							{string}	string				"Erro interno do servidor."
-// @Param			param						path		string				true	"'grupo' ou 'orgao'"
-// @Param			valor						path		string				true	"Jurisdição ou ID do órgao"
-// @Router			/v2/indice/{param}/{valor} 	[get]
+//	@ID				GetAggregateIndexesWithParams
+//	@Tags			public_api
+//	@Description	Busca as informações de índices de um grupo ou órgão específico.
+//	@Produce		json
+//	@Success		200							{object}	[]aggregateIndexes	"Requisição bem sucedida."
+//	@Failure		400							{string}	string				"Requisição inválida."
+//	@Failure		500							{string}	string				"Erro interno do servidor."
+//	@Param			param						path		string				true	"'grupo' ou 'orgao'"
+//	@Param			valor						path		string				true	"Jurisdição ou ID do órgao"
+//	@Router			/v2/indice/{param}/{valor} 	[get]
 func (h handler) V2GetAggregateIndexesWithParams(c echo.Context) error {
 	param := c.Param("param")
 	valor := c.Param("valor")
@@ -689,13 +689,13 @@ func (h handler) V2GetAggregateIndexesWithParams(c echo.Context) error {
 	return c.JSON(http.StatusOK, aggregate)
 }
 
-// @ID				GetAggregateIndexes
-// @Tags			public_api
-// @Description	Busca as informações de índices de todos os órgãos.
-// @Produce		json
-// @Success		200			{object}	[]aggregateIndexesByGroup	"Requisição bem sucedida."
-// @Failure		500			{string}	string						"Erro interno do servidor."
-// @Router			/v2/indice 																																																																																																					[get]
+//	@ID				GetAggregateIndexes
+//	@Tags			public_api
+//	@Description	Busca as informações de índices de todos os órgãos.
+//	@Produce		json
+//	@Success		200			{object}	[]aggregateIndexesByGroup	"Requisição bem sucedida."
+//	@Failure		500			{string}	string						"Erro interno do servidor."
+//	@Router			/v2/indice 																																																																																																													[get]
 func (h handler) V2GetAggregateIndexes(c echo.Context) error {
 	agregado := c.QueryParam("agregado")
 	detalhe := c.QueryParam("detalhe")
@@ -799,14 +799,14 @@ func (h handler) V2GetAggregateIndexes(c echo.Context) error {
 	return c.JSON(http.StatusOK, dados)
 }
 
-// @ID				GetAllAgencyInformation
-// @Tags			public_api
-// @Description	Busca todas as informações de um órgão específico.
-// @Produce		json
-// @Success		200					{object}	allAgencyInformation	"Requisição bem sucedida."
-// @Failure		400					{string}	string					"Requisição inválida."
-// @Param			orgao				path		string					true	"órgão"
-// @Router			/v2/dados/{orgao} 	[get]
+//	@ID				GetAllAgencyInformation
+//	@Tags			public_api
+//	@Description	Busca todas as informações de um órgão específico.
+//	@Produce		json
+//	@Success		200					{object}	allAgencyInformation	"Requisição bem sucedida."
+//	@Failure		400					{string}	string					"Requisição inválida."
+//	@Param			orgao				path		string					true	"órgão"
+//	@Router			/v2/dados/{orgao} 	[get]
 func (h handler) V2GetAllAgencyInformation(c echo.Context) error {
 	agency := strings.ToLower(c.Param("orgao"))
 

diff --git a/uiapi/uiapi_test.go b/uiapi/uiapi_test.go
@@ -1219,7 +1219,8 @@ func (g getTotalsOfAgencyYear) testWhenDataExists(t *testing.T) {
 						"licenca_compensatoria": 120,
 						"auxilio_saude": 300,
         	            "outras": 200
-					}
+					},
+					"inconsistente": false
 				}
 			],
 			"package": {