{
  "openapi": "3.0.3",
  "info": {
    "title": "Rede ciclável | Cycling network",
    "version": "1.0.0",
    "description": "Informação acerca da rede ciclável da cidade de Lisboa: localização, largura, comprimento, tipologia da via e estado do piso das ciclovias.\n\nInformation about the cycling network of the city of Lisbon: location, width, length, type of road and surface condition of the cycle lanes.\n\nPeriodicidade de atualização: Irregular. Todos os registos em cada ficheiro.",
    "contact": {
      "name": "EMEL, E.M.",
      "email": "info@emel.pt",
      "url": "https://dados.emel.pt"
    },
    "license": {
      "name": "CC BY-SA 4.0",
      "url": "https://creativecommons.org/licenses/by-sa/4.0/"
    }
  },
  "servers": [
    {
      "url": "https://dados.emel.pt",
      "description": "Portal de dados abertos da EMEL"
    }
  ],
  "externalDocs": {
    "description": "Página do conjunto de dados",
    "url": "https://dados.emel.pt/dataset/cyclinglanes"
  },
  "paths": {
    "/dataset/4f2d47a7-1ec4-41f9-8894-76695f728bc2/resource/f084da97-b3e8-49dc-83b3-93975bdaa2c1/download/cyclinglanes.csv": {
      "get": {
        "summary": "Descarregar o conjunto de dados em CSV",
        "description": "Ficheiro do conjunto de dados «Rede ciclável», alojado no portal dados.emel.pt, atualizado automaticamente.",
        "operationId": "descarregar_csv",
        "responses": {
          "200": {
            "description": "Ficheiro completo (todos os registos).",
            "content": {
              "text/csv": {
                "schema": {
                  "type": "string",
                  "description": "CSV com cabeçalho (separador vírgula), uma linha por registo."
                }
              }
            }
          },
          "404": {
            "description": "Recurso inexistente ou dataset ainda não público."
          }
        }
      }
    },
    "/dataset/4f2d47a7-1ec4-41f9-8894-76695f728bc2/resource/28a240a3-f549-4652-a97a-38a990345160/download/cyclinglanes.json": {
      "get": {
        "summary": "Descarregar o conjunto de dados em JSON",
        "description": "Ficheiro do conjunto de dados «Rede ciclável», alojado no portal dados.emel.pt, atualizado automaticamente.",
        "operationId": "descarregar_json",
        "responses": {
          "200": {
            "description": "Ficheiro completo (todos os registos).",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Registo"
                  }
                }
              }
            }
          },
          "404": {
            "description": "Recurso inexistente ou dataset ainda não público."
          }
        }
      }
    },
    "/dataset/4f2d47a7-1ec4-41f9-8894-76695f728bc2/resource/8a592f21-b3f1-401a-9381-48b231290697/download/bikelines.xml": {
      "get": {
        "summary": "Descarregar o conjunto de dados em XML (DATEX II)",
        "description": "Ficheiro do conjunto de dados «Rede ciclável», alojado no portal dados.emel.pt, atualizado automaticamente.",
        "operationId": "descarregar_xml",
        "responses": {
          "200": {
            "description": "Ficheiro completo (todos os registos).",
            "content": {
              "application/xml": {
                "schema": {
                  "type": "string",
                  "description": "Documento XML (DATEX II)."
                }
              }
            }
          },
          "404": {
            "description": "Recurso inexistente ou dataset ainda não público."
          }
        }
      }
    },
    "/api/3/action/datastore_search": {
      "get": {
        "summary": "Consultar registos do conjunto de dados (API de consulta)",
        "description": "Consulta programática aos registos de «Rede ciclável», com filtros, pesquisa de texto, seleção de campos, ordenação e paginação. Cada registo tem a mesma estrutura do ficheiro JSON do conjunto de dados. Exemplo: https://dados.emel.pt/api/3/action/datastore_search?resource_id=c182ebeb-5fe4-427e-8344-3aa3df71b0b0&limit=10",
        "operationId": "consultar_registos",
        "parameters": [
          {
            "name": "resource_id",
            "in": "query",
            "required": true,
            "description": "Identificador da tabela deste conjunto de dados.",
            "schema": {
              "type": "string",
              "enum": [
                "c182ebeb-5fe4-427e-8344-3aa3df71b0b0"
              ],
              "default": "c182ebeb-5fe4-427e-8344-3aa3df71b0b0"
            }
          },
          {
            "name": "q",
            "in": "query",
            "required": false,
            "description": "Pesquisa de texto em todos os campos.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "filters",
            "in": "query",
            "required": false,
            "description": "Filtro por igualdade, objeto JSON {campo: valor}.",
            "schema": {
              "type": "string"
            },
            "example": "{\"campo\": \"valor\"}"
          },
          {
            "name": "fields",
            "in": "query",
            "required": false,
            "description": "Campos a devolver, separados por vírgula.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "required": false,
            "description": "Ordenação, por exemplo «campo asc».",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "description": "Número máximo de registos (por omissão 100).",
            "schema": {
              "type": "integer",
              "default": 100,
              "maximum": 32000
            }
          },
          {
            "name": "offset",
            "in": "query",
            "required": false,
            "description": "Registos a saltar (paginação).",
            "schema": {
              "type": "integer",
              "default": 0
            }
          },
          {
            "name": "include_total",
            "in": "query",
            "required": false,
            "description": "Incluir o total de registos na resposta.",
            "schema": {
              "type": "boolean",
              "default": true
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Registos que cumprem os critérios.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean"
                    },
                    "result": {
                      "type": "object",
                      "properties": {
                        "resource_id": {
                          "type": "string"
                        },
                        "total": {
                          "type": "integer",
                          "description": "Total de registos que cumprem os critérios."
                        },
                        "limit": {
                          "type": "integer"
                        },
                        "fields": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string"
                              },
                              "type": {
                                "type": "string"
                              }
                            }
                          }
                        },
                        "records": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/RegistoAPI"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Tabela inexistente."
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Registo": {
        "type": "object",
        "properties": {
          "idTrocoCiclovia": {
            "type": "string"
          },
          "idCiclovia": {
            "type": "string"
          },
          "localizacao": {
            "type": "string"
          },
          "hierarquia": {
            "type": "string"
          },
          "via": {
            "type": "string"
          },
          "passeio": {
            "type": "string"
          },
          "itinerario": {
            "nullable": true
          },
          "restricaoAcesso": {
            "nullable": true
          },
          "situacao": {
            "type": "string"
          },
          "freguesia": {
            "type": "string"
          },
          "largura": {
            "type": "number"
          },
          "comprimento": {
            "type": "number"
          },
          "dataAbertura": {
            "type": "string"
          },
          "dataAtualizacao": {
            "type": "string"
          },
          "tipo": {
            "type": "string"
          },
          "viaDupla": {
            "type": "string"
          },
          "pavQualidade": {
            "type": "string"
          },
          "coordenadas": {
            "type": "array",
            "items": {
              "type": "array",
              "items": {
                "type": "number"
              }
            }
          }
        }
      },
      "RegistoAPI": {
        "type": "object",
        "properties": {
          "_id": {
            "type": "integer",
            "description": "Identificador interno da linha (CKAN)."
          },
          "idTrocoCiclovia": {
            "type": "string"
          },
          "idCiclovia": {
            "type": "string"
          },
          "localizacao": {
            "type": "string"
          },
          "hierarquia": {
            "type": "string"
          },
          "via": {
            "type": "string"
          },
          "passeio": {
            "type": "string"
          },
          "itinerario": {
            "nullable": true
          },
          "restricaoAcesso": {
            "nullable": true
          },
          "situacao": {
            "type": "string"
          },
          "freguesia": {
            "type": "string"
          },
          "largura": {
            "type": "number"
          },
          "comprimento": {
            "type": "number"
          },
          "dataAbertura": {
            "type": "string"
          },
          "dataAtualizacao": {
            "type": "string"
          },
          "tipo": {
            "type": "string"
          },
          "viaDupla": {
            "type": "string"
          },
          "pavQualidade": {
            "type": "string"
          },
          "coordenadas": {
            "type": "array",
            "items": {
              "type": "array",
              "items": {
                "type": "number"
              }
            }
          }
        }
      }
    }
  }
}