docs: update doc for region routes

BrasilAPI · Jan 28, 2024 · 1d5b2c4 · 1d5b2c4
1 parent 36c7b6c
commit 1d5b2c4
Showing 1 changed file with 37 additions and 3 deletions.
diff --git a/pages/docs/doc/ibge.json b/pages/docs/doc/ibge.json
@@ -231,7 +231,7 @@
         "/ibge/regioes/v1": {
           "get": {
               "tags": ["IBGE"],
-              "summary": "Retorna as informações das regiões do Brasil",
+              "summary": "Retorna informações de todas as regiões do Brasil",
               "description": "",
               "responses": {
                   "200": {
@@ -250,10 +250,10 @@
               }
           }
         },
-        "/ibge/regioes/v1/{region}": {
+        "/ibge/uf/v1/regiao/{regionCode}": {
           "get": {
               "tags": ["IBGE"],
-              "summary": "Busca as informações de uma região à partir da sigla ou código",
+              "summary": "Busca os estados de uma região à partir da sigla ou código",
               "description": "",
               "responses": {
                   "200": {
@@ -286,6 +286,40 @@
                   }
               }
           }
+        },
+        "/ibge/regioes/v1/{regionCode}": {
+          "get": {
+              "tags": ["IBGE"],
+              "summary": "Busca as informações de uma região em específico",
+              "description": "",
+              "responses": {
+                  "200": {
+                      "description": "Success",
+                      "content": {
+                          "application/json": {
+                              "schema": {
+                                "$ref": "#/components/schemas/Region"
+                              }
+                          }
+                      }
+                  },
+                  "404": {
+                    "description": "O código / sigla da região não foi encontrado",
+                    "content": {
+                        "application/json": {
+                            "schema": {
+                                "$ref": "#/components/schemas/ErrorMessage"
+                            },
+                            "example": {
+                                "name": "NotFoundError",
+                                "message": "Região não encontrada.",
+                                "type": "not_found"
+                            }
+                        }
+                    }
+                  }
+              }
+          }
         }
     },
     "components": {