diff --git a/ SMPPIR-API Specification.yaml b/ SMPPIR-API Specification.yaml
index 16d3baaa010745aa6e8e13595c3f2fd11719f0b4..a79e649100bfa66cc0c7613a45bed5f1430818d8 100644
--- a/ SMPPIR-API Specification.yaml
+++ b/ SMPPIR-API Specification.yaml
@@ -1650,88 +1650,88 @@ paths:
# '404':
# description: no data found
- /cad_unico:
- get:
- summary: Return the number of people and families from that belongs to 'terreiro communities' obtained by CadÚnico. This route uses the IBGE data listed above
- tags:
- - CadÚnico
- parameters:
- - name: dims
- in: query
- description: Group data using a metric parameter
- allowReserved: true
- required: false
- explode: false
- style: form
- example: year,home_type
- schema:
- type: array
- items:
- type: string
- enum:
- - year
- - per_capita_income
- - home_type
- - home_location
- - education_families
- - education_families_level
- - education_families_conclude
- - name: filter
- in: query
- description: Filter data
- allowReserved: true
- required: false
- explode: false
- style: form
- example: ethnic:["2","6"],gender:"1"
- schema:
- type: array
- items:
- type: object
- properties:
- year:
- type: "array"
- items:
- type: "string"
- enum: ['2012', '2013', '2014', '2015', '2016']
- per_capita_income:
- type: "array"
- items:
- type: "string"
- home_type:
- type: "array"
- items:
- type: "string"
- enum: [null, '1','2','3']
- home_location:
- type: 'array'
- items:
- type: "number"
- education_families_conclude:
- type: "array"
- items:
- type: "string"
- enum: [null, '1', '2']
- education_families:
- type: 'array'
- items:
- type: "string"
- enum: [null, '1','2','3','4','5','6','7','8','9','10','11','12','13','14','15']
- education_families_level:
- type: 'array'
- items:
- type: "string"
- enum: [null,'1','2','3','4','5','6','7','8','9','10']
+# /cad_unico:
+# get:
+# summary: Return the number of people and families from that belongs to 'terreiro communities' obtained by CadÚnico. This route uses the IBGE data listed above
+# tags:
+# - CadÚnico
+# parameters:
+# - name: dims
+# in: query
+# description: Group data using a metric parameter
+# allowReserved: true
+# required: false
+# explode: false
+# style: form
+# example: year,home_type
+# schema:
+# type: array
+# items:
+# type: string
+# enum:
+# - year
+# - per_capita_income
+# - home_type
+# - home_location
+# - education_families
+# - education_families_level
+# - education_families_conclude
+# - name: filter
+# in: query
+# description: Filter data
+# allowReserved: true
+# required: false
+# explode: false
+# style: form
+# example: ethnic:["2","6"],gender:"1"
+# schema:
+# type: array
+# items:
+# type: object
+# properties:
+# year:
+# type: "array"
+# items:
+# type: "string"
+# enum: ['2012', '2013', '2014', '2015', '2016']
+# per_capita_income:
+# type: "array"
+# items:
+# type: "string"
+# home_type:
+# type: "array"
+# items:
+# type: "string"
+# enum: [null, '1','2','3']
+# home_location:
+# type: 'array'
+# items:
+# type: "number"
+# education_families_conclude:
+# type: "array"
+# items:
+# type: "string"
+# enum: [null, '1', '2']
+# education_families:
+# type: 'array'
+# items:
+# type: "string"
+# enum: [null, '1','2','3','4','5','6','7','8','9','10','11','12','13','14','15']
+# education_families_level:
+# type: 'array'
+# items:
+# type: "string"
+# enum: [null,'1','2','3','4','5','6','7','8','9','10']
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CadUnicoReturn'
- '404':
- description: no data found
+# responses:
+# '200':
+# description: successful operation
+# content:
+# application/json:
+# schema:
+# $ref: '#/components/schemas/CadUnicoReturn'
+# '404':
+# description: no data found
/african_culture:
get:
@@ -1926,7 +1926,7 @@ paths:
/eixo_2:
get:
- summary: Return the infraestructure and life quality information about quilombola families obtained by CadÚnico. This route uses the IBGE data listed above
+ summary: Return the infraestructure and life quality information about quilombola families obtained by CadÚnico. This route uses the CadUnico data listed above
tags:
- CadÚnico
parameters:
@@ -2030,7 +2030,7 @@ paths:
/eixo_3:
get:
- summary: Return the local development and productive inclusion about quilombola families obtained by CadÚnico. This route uses the IBGE data listed above
+ summary: Return the local development and productive inclusion about quilombola families obtained by CadÚnico. This route uses the CadUnico data listed above
tags:
- CadÚnico
parameters:
@@ -2123,7 +2123,7 @@ paths:
/eixo_4:
get:
- summary: Return the rights and citizenship information about quilombola families obtained by CadÚnico. This route uses the IBGE data listed above
+ summary: Return the rights and citizenship information about quilombola families obtained by CadÚnico. This route uses the CadUnico data listed above
tags:
- CadÚnico
parameters:
@@ -2213,6 +2213,57 @@ paths:
$ref: '#/components/schemas/Eixo4'
'404':
description: no data found
+
+ /quilombola_metrics:
+ get:
+ summary: Return the useful metrics for quilombola families obtained by CadÚnico, like the maximum, minimum and average income they have, per year. This route uses the CadUnico data listed above
+ tags:
+ - CadÚnico
+ parameters:
+ - name: dims
+ in: query
+ description: Group data using a metric parameter
+ allowReserved: true
+ required: false
+ explode: false
+ style: form
+ example: year,home_type
+ schema:
+ type: array
+ items:
+ type: string
+ enum:
+ - year
+
+ - name: filter
+ in: query
+ description: Filter data
+ allowReserved: true
+ required: false
+ explode: false
+ style: form
+ example: year:"2016"
+ schema:
+ type: array
+ items:
+ type: object
+ properties:
+ year:
+ type: "array"
+ items:
+ type: "string"
+ enum: ['2012', '2013', '2014', '2015', '2016','2017']
+
+
+ responses:
+ '200':
+ description: successful operation
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/metrics'
+ '404':
+ description: no data found
components:
schemas:
@@ -2297,8 +2348,17 @@ components:
region:
type: "string"
genero:
- type: "string"
+ type: "string"
+ metrics:
+ type: object
+ required: ['total']
+ description: |
+ This model represents the return possibilities in quilombola_metrics queries
+ properties:
+ ano_pesquisa:
+ type: "number"
+
AfricanSustentability:
type: object
required: ['total']
@@ -2347,28 +2407,28 @@ components:
cd_ibge:
type: "string"
- CadUnicoReturn:
- type: object
- required: ['total']
- description: |
- This model represents the return possibilities in CadUnico queries
- properties:
- total:
- type: "number"
- ano_pesquisa:
- type: "number"
- vlr_renda_media_fam:
- type: "number"
- cod_especie_domic_fam:
- type: "string"
- cd_ibge:
- type: "string"
- cod_concluiu_frequentou_memb:
- type: "string"
- cod_ano_serie_frequentou_memb:
- type: "string"
- cod_curso_frequentou_pessoa_memb:
- type: "string"
+# CadUnicoReturn:
+# type: object
+# required: ['total']
+# description: |
+# This model represents the return possibilities in CadUnico queries
+# properties:
+# total:
+# type: "number"
+# ano_pesquisa:
+# type: "number"
+# vlr_renda_media_fam:
+# type: "number"
+# cod_especie_domic_fam:
+# type: "string"
+# cd_ibge:
+# type: "string"
+# cod_concluiu_frequentou_memb:
+# type: "string"
+# cod_ano_serie_frequentou_memb:
+# type: "string"
+# cod_curso_frequentou_pessoa_memb:
+# type: "string"
course:
type: object