Commit bc2f3271 authored by ns17's avatar ns17

adding description of ciganos

parent 021559b6
......@@ -1732,7 +1732,198 @@ paths:
# $ref: '#/components/schemas/CadUnicoReturn'
# '404':
# description: no data found
/ciganos_culture:
get:
summary: Return the type of house and location of the houses that belongs to 'ciganos 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
- cod_local_home
- home_type
- home_location
- 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','2017']
cod_local_home:
type: "array"
items:
type: "string"
enum: ['1','2']
home_type:
type: "array"
items:
type: "string"
enum: ['1','2','3']
home_location:
type: "array"
items:
type: "string"
enum: ['1301902','1303809', '1304237','1500107','1502806','1503705','1503903','1504604','1504901','1505205']
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/CiganosCulture'
'404':
description: no data found
/ciganos_rights:
get:
summary: Return the education level and number of families that belongs to 'ciganos 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
- education_families_conclude
- education_families_level
- education_families
- 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','2017']
education_families_conclude:
type: "array"
items:
type: "string"
enum: ['1','2','null']
education_families_level:
type: "array"
items:
type: "string"
enum: ['1','2','3','4','5','6','7','8','9','null']
education_families:
type: "array"
items:
type: "string"
enum: ['3','4','5','6','7','8','9','12','13','null']
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/CiganosRights'
'404':
description: no data found
/ciganos_sustentability:
get:
summary: Return the average per capita income from families that belongs to 'ciganos 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
- family_type
- per_capita_income
- 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','2017']
vlr_renda_media_fam:
type: "array"
items:
type: "number"
minimum: 0
maximum: 3000
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/CiganosSustentability'
'404':
description: no data found
/african_culture:
get:
summary: Return the type of house and location of the houses that belongs to 'terreiro communities' obtained by CadÚnico. This route uses the IBGE data listed above
......@@ -2359,11 +2550,11 @@ components:
ano_pesquisa:
type: "number"
AfricanSustentability:
CiganosSustentability:
type: object
required: ['total']
description: |
This model represents the return possibilities in african_rights queries
This model represents the return possibilities in ciganos_sustentability queries
properties:
total:
type: "number"
......@@ -2372,6 +2563,52 @@ components:
vlr_renda_media_fam:
type: "number"
CiganosRights:
type: object
required: ['total']
description: |
This model represents the return possibilities in ciganos_rights queries
properties:
total:
type: "number"
ano_pesquisa:
type: "number"
cod_concluiu_frequentou_memb:
type: "string"
cod_ano_serie_frequentou_memb:
type: "string"
cod_curso_frequentou_pessoa_memb:
type: "string"
CiganosCulture:
type: object
required: ['total']
description: |
This model represents the return possibilities in ciganos_culture queries
properties:
total:
type: "number"
ano_pesquisa:
type: "number"
cod_local_domic_fam:
type: "string"
cod_especie_domic_fam:
type: "string"
cd_ibge:
type: "string"
AfricanSustentability:
type: object
required: ['total']
description: |
This model represents the return possibilities in african_sustentability queries
properties:
total:
type: "number"
ano_pesquisa:
type: "number"
vlr_renda_media_fam:
type: "number"
AfricanRights:
type: object
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment