{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:data-mill-north/search":{"get":{"operationId":"open_data_data_mill_north_search","summary":"Search datasets","description":"Full-text search over the portal's datasets, with tags, organizations, formats and resource links.","tags":["open-data"],"parameters":[{"name":"query","in":"query","required":false,"description":"Search words (Solr syntax allowed)","schema":{"type":"string","description":"Search words (Solr syntax allowed)"},"example":"transport"},{"name":"limit","in":"query","required":false,"description":"Number of results","schema":{"type":"integer","default":10,"minimum":1,"maximum":1000,"description":"Number of results"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","default":0,"minimum":0}},{"name":"organization","in":"query","required":false,"description":"Organization name (slug) to filter by","schema":{"type":"string","description":"Organization name (slug) to filter by"}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","default":"score desc, metadata_modified desc"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":900,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:data-mill-north/dataset":{"get":{"operationId":"open_data_data_mill_north_dataset","summary":"Dataset","description":"Full metadata of one dataset, including every resource (file or API) with its download URL.","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":true,"description":"Dataset name or id from the search results","schema":{"type":"string","description":"Dataset name or id from the search results"},"example":"dataset-name"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":3600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:data-mill-north/organizations":{"get":{"operationId":"open_data_data_mill_north_organizations","summary":"Publishers","description":"Organizations that publish on the portal, with dataset counts.","tags":["open-data"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of results","schema":{"type":"integer","default":50,"minimum":1,"maximum":1000,"description":"Number of results"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","default":0,"minimum":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":86400,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:data-mill-north/rows":{"get":{"operationId":"open_data_data_mill_north_rows","summary":"Table rows","description":"Rows of a tabular resource stored in the portal's DataStore (only resources the portal has loaded into its DataStore).","tags":["open-data"],"parameters":[{"name":"resourceId","in":"query","required":true,"description":"Resource id from a dataset","schema":{"type":"string","description":"Resource id from a dataset"},"example":"00000000-0000-0000-0000-000000000000"},{"name":"query","in":"query","required":false,"description":"Full-text filter","schema":{"type":"string","description":"Full-text filter"}},{"name":"limit","in":"query","required":false,"description":"Number of results","schema":{"type":"integer","default":100,"minimum":1,"maximum":1000,"description":"Number of results"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","default":0,"minimum":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":900,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}