dataservices-api/client/renderer/interface.yaml

---
- name: cdb_geocode_admin0_polygon
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: country_name, type: text }

- name: cdb_geocode_admin1_polygon
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: admin1_name, type: text }

- name: cdb_geocode_admin1_polygon
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: admin1_name,  type: text }
    - { name: country_name, type: text }

- name: cdb_geocode_namedplace_point
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: city_name, type: text}

- name: cdb_geocode_namedplace_point
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: city_name,    type: text}
    - { name: country_name, type: text}

- name: cdb_geocode_namedplace_point
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: city_name,    type: text}
    - { name: admin1_name,  type: text}
    - { name: country_name, type: text}

- name: cdb_geocode_postalcode_polygon
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: postal_code,  type: text}
    - { name: country_name, type: text}

- name: cdb_geocode_postalcode_polygon
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: postal_code,  type: double precision}
    - { name: country_name, type: text}

- name: cdb_geocode_postalcode_point
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: postal_code,  type: text}
    - { name: country_name, type: text}

- name: cdb_geocode_postalcode_point
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: postal_code,  type: double precision}
    - { name: country_name, type: text}

- name: cdb_geocode_ipaddress_point
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: ip_address,  type: text}

- name: cdb_geocode_street_point
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: searchtext,  type: text}
    - { name: city,  type: text, default: 'NULL'}
    - { name: state_province,  type: text, default: 'NULL'}
    - { name: country,  type: text, default: 'NULL'}

- name: _cdb_bulk_geocode_street_point
  return_type: SETOF cdb_dataservices_client.geocoding
  multi_row: true
  multi_field: true
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: searches,  type: jsonb } # Array of JSON objects with id, address, city, state and country fields

- name: cdb_here_geocode_street_point
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: searchtext,  type: text}
    - { name: city,  type: text, default: 'NULL'}
    - { name: state_province,  type: text, default: 'NULL'}
    - { name: country,  type: text, default: 'NULL'}

- name: cdb_google_geocode_street_point
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: searchtext,  type: text}
    - { name: city,  type: text, default: 'NULL'}
    - { name: state_province,  type: text, default: 'NULL'}
    - { name: country,  type: text, default: 'NULL'}

- name: cdb_mapbox_geocode_street_point
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: searchtext,  type: text}
    - { name: city,  type: text, default: 'NULL'}
    - { name: state_province,  type: text, default: 'NULL'}
    - { name: country,  type: text, default: 'NULL'}

- name: cdb_tomtom_geocode_street_point
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: searchtext,  type: text}
    - { name: city,  type: text, default: 'NULL'}
    - { name: state_province,  type: text, default: 'NULL'}
    - { name: country,  type: text, default: 'NULL'}

- name: cdb_geocodio_geocode_street_point
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: searchtext,  type: text}
    - { name: city,  type: text, default: 'NULL'}
    - { name: state_province,  type: text, default: 'NULL'}
    - { name: country,  type: text, default: 'NULL'}

- name: cdb_mapzen_geocode_street_point
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: searchtext,  type: text}
    - { name: city,  type: text, default: 'NULL'}
    - { name: state_province,  type: text, default: 'NULL'}
    - { name: country,  type: text, default: 'NULL'}

- name: cdb_isodistance
  return_type: SETOF cdb_dataservices_client.isoline
  multi_row: true
  multi_field: true
  requires_permission: true
  permission_name: isolines
  permission_error: Isolines permission denied
  params:
    - { name: source,  type: "public.geometry(Geometry, 4326)" }
    - { name: mode, type: text }
    - { name: range, type: "integer[]" }
    - { name: options, type: "text[]", default: 'ARRAY[]::text[]' }

- name: cdb_isochrone
  return_type: SETOF cdb_dataservices_client.isoline
  multi_row: true
  multi_field: true
  requires_permission: true
  permission_name: isolines
  permission_error: Isolines permission denied
  params:
    - { name: source,  type: "public.geometry(Geometry, 4326)" }
    - { name: mode, type: text }
    - { name: range, type: "integer[]" }
    - { name: options, type: "text[]", default: 'ARRAY[]::text[]' }

- name: cdb_mapbox_isochrone
  return_type: SETOF cdb_dataservices_client.isoline
  multi_row: true
  multi_field: true
  requires_permission: true
  permission_name: isolines
  permission_error: Isolines permission denied
  params:
    - { name: source,  type: "public.geometry(Geometry, 4326)" }
    - { name: mode, type: text }
    - { name: range, type: "integer[]" }
    - { name: options, type: "text[]", default: 'ARRAY[]::text[]' }

- name: cdb_tomtom_isochrone
  return_type: SETOF cdb_dataservices_client.isoline
  multi_row: true
  multi_field: true
  requires_permission: true
  permission_name: isolines
  permission_error: Isolines permission denied
  params:
    - { name: source,  type: "public.geometry(Geometry, 4326)" }
    - { name: mode, type: text }
    - { name: range, type: "integer[]" }
    - { name: options, type: "text[]", default: 'ARRAY[]::text[]' }

- name: cdb_mapzen_isochrone
  return_type: SETOF cdb_dataservices_client.isoline
  multi_row: true
  multi_field: true
  requires_permission: true
  permission_name: isolines
  permission_error: Isolines permission denied
  params:
    - { name: source,  type: "public.geometry(Geometry, 4326)" }
    - { name: mode, type: text }
    - { name: range, type: "integer[]" }
    - { name: options, type: "text[]", default: 'ARRAY[]::text[]' }

- name: cdb_mapbox_isodistance
  return_type: SETOF cdb_dataservices_client.isoline
  multi_row: true
  multi_field: true
  requires_permission: true
  permission_name: isolines
  permission_error: Isolines permission denied
  params:
    - { name: source,  type: "public.geometry(Geometry, 4326)" }
    - { name: mode, type: text }
    - { name: range, type: "integer[]" }
    - { name: options, type: "text[]", default: 'ARRAY[]::text[]' }

- name: cdb_tomtom_isodistance
  return_type: SETOF cdb_dataservices_client.isoline
  multi_row: true
  multi_field: true
  requires_permission: true
  permission_name: isolines
  permission_error: Isolines permission denied
  params:
    - { name: source,  type: "public.geometry(Geometry, 4326)" }
    - { name: mode, type: text }
    - { name: range, type: "integer[]" }
    - { name: options, type: "text[]", default: 'ARRAY[]::text[]' }

- name: cdb_mapzen_isodistance
  return_type: SETOF cdb_dataservices_client.isoline
  multi_row: true
  multi_field: true
  requires_permission: true
  permission_name: isolines
  permission_error: Isolines permission denied
  params:
    - { name: source,  type: "public.geometry(Geometry, 4326)" }
    - { name: mode, type: text }
    - { name: range, type: "integer[]" }
    - { name: options, type: "text[]", default: 'ARRAY[]::text[]' }

- name: cdb_route_point_to_point
  return_type: cdb_dataservices_client.simple_route
  multi_field: true
  requires_permission: true
  permission_name: routing
  permission_error: Routing permission denied
  params:
    - { name: origin,  type: "public.geometry(Point, 4326)" }
    - { name: destination,  type: "public.geometry(Point, 4326)" }
    - { name: mode, type: text }
    - { name: options, type: "text[]", default: 'ARRAY[]::text[]' }
    - { name: units, type: "text", default: "'kilometers'"}

- name: cdb_route_with_waypoints
  return_type: cdb_dataservices_client.simple_route
  multi_field: true
  requires_permission: true
  permission_name: routing
  permission_error: Routing permission denied
  params:
    - { name: waypoints,  type: "public.geometry(Point, 4326)[]" }
    - { name: mode, type: text }
    - { name: options, type: "text[]", default: 'ARRAY[]::text[]' }
    - { name: units, type: "text", default: "'kilometers'"}

- name: obs_get_demographic_snapshot
  return_type: json
  requires_permission: true
  permission_name: observatory
  permission_error: Data Observatory permission denied
  params:
    - { name: geom,  type: "public.geometry(Geometry, 4326)" }
    - { name: time_span,  type: "text", default: "'2009 - 2013'::text" }
    - { name: geometry_level, type: text, default: 'NULL' }

- name: obs_get_segment_snapshot
  return_type: json
  requires_permission: true
  permission_name: observatory
  permission_error: Data Observatory permission denied
  params:
    - { name: geom,  type: "public.geometry(Geometry, 4326)" }
    - { name: geometry_level, type: text, default: 'NULL' }

- name: obs_getdemographicsnapshot
  return_type: SETOF JSON
  multi_row: true
  requires_permission: true
  permission_name: observatory
  permission_error: Data Observatory permission denied
  params:
    - { name: geom,  type: "public.geometry(Geometry, 4326)" }
    - { name: time_span,  type: "text", default: 'NULL' }
    - { name: geometry_level, type: text, default: 'NULL' }

- name: obs_getsegmentsnapshot
  return_type: SETOF JSON
  multi_row: true
  requires_permission: true
  permission_name: observatory
  permission_error: Data Observatory permission denied
  params:
    - { name: geom,  type: "public.geometry(Geometry, 4326)" }
    - { name: geometry_level, type: text, default: 'NULL' }

- name: obs_getboundary
  return_type: public.Geometry
  requires_permission: true
  permission_name: observatory
  permission_error: Data Observatory permission denied
  params:
    - { name: geom,  type: "public.geometry(Geometry, 4326)" }
    - { name: boundary_id, type: text }
    - { name: time_span, type: text, default: 'NULL'}

- name: obs_getboundaryid
  return_type: text
  requires_permission: true
  permission_name: observatory
  permission_error: Data Observatory permission denied
  params:
    - { name: geom,  type: "public.geometry(Geometry, 4326)" }
    - { name: boundary_id, type: text }
    - { name: time_span, type: text, default: 'NULL'}

- name: obs_getboundarybyid
  return_type: public.Geometry
  requires_permission: true
  permission_name: observatory
  permission_error: Data Observatory permission denied
  params:
    - { name: geometry_id,  type: text }
    - { name: boundary_id, type: text }
    - { name: time_span, type: text, default: 'NULL'}

- name: obs_getboundariesbygeometry
  return_type: TABLE(the_geom geometry, geom_refs text)
  multi_row: true
  multi_field: true
  requires_permission: true
  permission_name: observatory
  permission_error: Data Observatory permission denied
  table_fields:
    - { name: the_geom, type: geometry }
    - { name: geom_refs, type: text }
  params:
    - { name: geom,  type: "public.geometry(Geometry, 4326)" }
    - { name: boundary_id, type: text }
    - { name: time_span, type: text, default: 'NULL'}
    - { name: overlap_type, type: text, default: 'NULL'}

- name: obs_getboundariesbypointandradius
  return_type: TABLE(the_geom geometry, geom_refs text)
  multi_row: true
  multi_field: true
  requires_permission: true
  permission_name: observatory
  permission_error: Data Observatory permission denied
  table_fields:
    - { name: the_geom, type: geometry }
    - { name: geom_refs, type: text }
  params:
    - { name: geom,  type: "public.geometry(Geometry, 4326)" }
    - { name: radius, type: numeric }
    - { name: boundary_id, type: text }
    - { name: time_span, type: text, default: 'NULL'}
    - { name: overlap_type, type: text, default: 'NULL'}

- name: obs_getpointsbygeometry
  return_type: TABLE(the_geom geometry, geom_refs text)
  multi_row: true
  multi_field: true
  requires_permission: true
  permission_name: observatory
  permission_error: Data Observatory permission denied
  table_fields:
    - { name: the_geom, type: geometry }
    - { name: geom_refs, type: text }
  params:
    - { name: geom,  type: "public.geometry(Geometry, 4326)" }
    - { name: boundary_id, type: text }
    - { name: time_span, type: text, default: 'NULL'}
    - { name: overlap_type, type: text, default: 'NULL'}

- name: obs_getpointsbypointandradius
  return_type: TABLE(the_geom geometry, geom_refs text)
  multi_row: true
  multi_field: true
  requires_permission: true
  permission_name: observatory
  permission_error: Data Observatory permission denied
  table_fields:
    - { name: the_geom, type: geometry }
    - { name: geom_refs, type: text }
  params:
    - { name: geom,  type: "public.geometry(Geometry, 4326)" }
    - { name: radius, type: numeric }
    - { name: boundary_id, type: text }
    - { name: time_span, type: text, default: 'NULL'}
    - { name: overlap_type, type: text, default: 'NULL'}

- name: obs_getmeasure
  return_type: numeric
  requires_permission: true
  permission_name: observatory
  permission_error: Data Observatory permission denied
  params:
    - { name: geom,  type: public.Geometry }
    - { name: measure_id, type: text }
    - { name: normalize, type: text, default: 'NULL'}
    - { name: boundary_id, type: text, default: 'NULL' }
    - { name: time_span, type: text, default: 'NULL'}

- name: obs_getmeasurebyid
  return_type: numeric
  requires_permission: true
  permission_name: observatory
  permission_error: Data Observatory permission denied
  params:
    - { name: geom_ref,  type: text }
    - { name: measure_id, type: text }
    - { name: boundary_id, type: text}
    - { name: time_span, type: text, default: 'NULL'}

- name: obs_getdata
  return_type: TABLE(id int, data json)
  multi_row: true
  multi_field: true
  requires_permission: true
  permission_name: observatory
  permission_error: Data Observatory permission denied
  table_fields:
    - { name: id, type: integer }
    - { name: data, type: json }
  params:
    - { name: geomvals,  type: "geomval[]" }
    - { name: params, type: json }
    - { name: merge, type: boolean, default: true }

- name: obs_getdata
  return_type: TABLE(id text, data json)
  multi_row: true
  multi_field: true
  requires_permission: true
  permission_name: observatory
  permission_error: Data Observatory permission denied
  table_fields:
    - { name: id, type: text }
    - { name: data, type: json }
  params:
    - { name: geomrefs,  type: "text[]" }
    - { name: params, type: json }

- name: obs_getmeta
  return_type: json
  requires_permission: true
  permission_name: observatory
  permission_error: Data Observatory permission denied
  params:
    - { name: geom_ref,  type: "public.Geometry(Geometry, 4326)" }
    - { name: params, type: json }
    - { name: max_timespan_rank, type: integer, default: 'NULL' }
    - { name: max_score_rank, type: integer, default: 'NULL' }
    - { name: target_geoms, type: integer, default: 'NULL' }

- name: obs_metadatavalidation
  return_type: TABLE(valid boolean, errors text[])
  multi_row: true
  multi_field: true
  requires_permission: true
  permission_name: observatory
  permission_error: Data Observatory permission denied
  params:
    - { name: geom_extent,  type: "public.Geometry(Geometry, 4326)" }
    - { name: geom_type,  type: text }
    - { name: params, type: json }
    - { name: target_geoms, type: integer, default: 'NULL' }

- name: obs_getcategory
  return_type: text
  requires_permission: true
  permission_name: observatory
  permission_error: Data Observatory permission denied
  params:
    - { name: geom,  type: public.Geometry }
    - { name: category_id, type: text }
    - { name: boundary_id, type: text, default: 'NULL' }
    - { name: time_span, type: text, default: 'NULL'}

- name: obs_getuscensusmeasure
  return_type: numeric
  requires_permission: true
  permission_name: observatory
  permission_error: Data Observatory permission denied
  params:
    - { name: geom,  type: public.Geometry }
    - { name: name, type: text }
    - { name: normalize, type: text, default: 'NULL'}
    - { name: boundary_id, type: text, default: 'NULL' }
    - { name: time_span, type: text, default: 'NULL'}

- name: obs_getuscensuscategory
  return_type: text
  requires_permission: true
  permission_name: observatory
  permission_error: Data Observatory permission denied
  params:
    - { name: geom,  type: public.Geometry }
    - { name: name, type: text }
    - { name: boundary_id, type: text, default: 'NULL' }
    - { name: time_span, type: text, default: 'NULL'}

- name: obs_getpopulation
  return_type: numeric
  requires_permission: true
  permission_name: observatory
  permission_error: Data Observatory permission denied
  params:
    - { name: geom,  type: public.Geometry }
    - { name: normalize, type: text, default: 'NULL'}
    - { name: boundary_id, type: text, default: 'NULL' }
    - { name: time_span, type: text, default: 'NULL'}

- name: obs_search
  return_type: TABLE(id text, description text, name text, aggregate text, source text)
  multi_row: true
  multi_field: true
  requires_permission: true
  permission_name: observatory
  permission_error: Data Observatory permission denied
  table_fields:
    - { name: id, type: text }
    - { name: description, type: text }
    - { name: name, type: text }
    - { name: aggregate, type: text }
    - { name: source, type: text }
  params:
    - { name: search_term, type: text }
    - { name: relevant_boundary, type: text, default: 'NULL' }

- name: obs_getavailableboundaries
  return_type: TABLE(boundary_id text, description text, time_span text, tablename text)
  multi_row: true
  multi_field: true
  requires_permission: true
  permission_name: observatory
  permission_error: Data Observatory permission denied
  table_fields:
    - { name: boundary_id, type: text }
    - { name: description, type: text }
    - { name: time_span, type: text }
    - { name: tablename, type: text }
  params:
    - { name: geom,  type: public.Geometry }
    - { name: timespan, type: text, default: 'NULL'}

- name: obs_dumpversion
  return_type: text
  requires_permission: true
  permission_name: observatory
  permission_error: Data Observatory permission denied
  params:
    - {}

- name: obs_getavailablenumerators
  return_type: SETOF cdb_dataservices_client.obs_meta_numerator
  multi_row: true
  multi_field: true
  requires_permission: true
  permission_name: observatory
  permission_error: Data Observatory permission denied
  params:
    - { name: bounds, type: "public.geometry(Geometry, 4326)", default: 'NULL' }
    - { name: filter_tags, type: "text[]", default: 'NULL' }
    - { name: denom_id, type: text, default: 'NULL' }
    - { name: geom_id, type: text, default: 'NULL' }
    - { name: timespan, type: text, default: 'NULL'}

- name: _obs_getnumerators
  return_type: SETOF cdb_dataservices_client.obs_meta_numerator
  multi_row: true
  multi_field: true
  requires_permission: true
  permission_name: observatory
  permission_error: Data Observatory permission denied
  params:
    - { name: bounds, type: "public.geometry(Geometry, 4326)", default: 'NULL' }
    - { name: section_tags, type: "text[]", default: 'ARRAY[]::TEXT[]' }
    - { name: subsection_tags, type: "text[]", default: 'ARRAY[]::TEXT[]' }
    - { name: other_tags, type: "text[]", default: 'ARRAY[]::TEXT[]' }
    - { name: ids, type: "text[]", default: 'ARRAY[]::TEXT[]' }
    - { name: name, type: text, default: 'NULL' }
    - { name: denom_id, type: text, default: "''" }
    - { name: geom_id, type: text, default: "''" }
    - { name: timespan, type: text, default: "''"}

- name: obs_getavailabledenominators
  return_type: SETOF cdb_dataservices_client.obs_meta_denominator
  multi_row: true
  multi_field: true
  requires_permission: true
  permission_name: observatory
  permission_error: Data Observatory permission denied
  params:
    - { name: bounds, type: "public.geometry(Geometry, 4326)", default: 'NULL' }
    - { name: filter_tags, type: "text[]", default: 'NULL' }
    - { name: numer_id, type: text, default: 'NULL' }
    - { name: geom_id, type: text, default: 'NULL' }
    - { name: timespan, type: text, default: 'NULL'}

- name: obs_getavailablegeometries
  return_type: SETOF cdb_dataservices_client.obs_meta_geometry
  multi_row: true
  multi_field: true
  requires_permission: true
  permission_name: observatory
  permission_error: Data Observatory permission denied
  params:
    - { name: bounds, type: "public.geometry(Geometry, 4326)", default: 'NULL' }
    - { name: filter_tags, type: "text[]", default: 'NULL' }
    - { name: numer_id, type: text, default: 'NULL' }
    - { name: denom_id, type: text, default: 'NULL' }
    - { name: timespan, type: text, default: 'NULL'}
    - { name: number_geometries, type: integer, default: 'NULL'}

- name: obs_getavailabletimespans
  return_type: SETOF cdb_dataservices_client.obs_meta_timespan
  multi_row: true
  multi_field: true
  requires_permission: true
  permission_name: observatory
  permission_error: Data Observatory permission denied
  params:
    - { name: bounds, type: "public.geometry(Geometry, 4326)", default: 'NULL' }
    - { name: filter_tags, type: "text[]", default: 'NULL' }
    - { name: numer_id, type: text, default: 'NULL' }
    - { name: denom_id, type: text, default: 'NULL' }
    - { name: geom_id, type: text, default: 'NULL'}

- name: obs_legacybuildermetadata
  return_type: TABLE(name text, subsection json)
  multi_row: true
  multi_field: true
  requires_permission: true
  permission_name: observatory
  permission_error: Data Observatory permission denied
  params:
    - { name: aggregate_type, type: text, default: 'NULL' }

- name: cdb_service_quota_info
  return_type: SETOF service_quota_info
  multi_row: true
  multi_field: true
  params:
    - {}

- name: cdb_service_quota_info_batch
  return_type: SETOF service_quota_info_batch
  multi_row: true
  multi_field: true
  params:
    - {}

- name: cdb_enough_quota
  return_type: BOOLEAN
  params:
    - { name: service, type: TEXT }
    - { name: input_size, type: NUMERIC }

- name: cdb_service_get_rate_limit
  return_type: json
  params:
    - { name: service,  type: "text" }

- name: cdb_service_set_user_rate_limit
  superuser: true
  return_type: void
  params:
    - { name: service,  type: "text" }
    - { name: rate_limit, type: json }

- name: cdb_service_set_org_rate_limit
  superuser: true
  return_type: void
  params:
    - { name: service,  type: "text" }
    - { name: rate_limit, type: json }

- name: cdb_service_set_server_rate_limit
  superuser: true
  return_type: void
  params:
    - { name: service,  type: "text" }
    - { name: rate_limit, type: json }