{"components":{"schemas":{"Dataset":{"additionalProperties":false,"properties":{"_score":{"type":"number"},"_sort":{"items":{},"type":"array"},"dcat":{"additionalProperties":{},"type":"object"},"description":{"type":"string"},"harvest_record":{"format":"url","type":"string"},"harvest_record_raw":{"format":"url","type":"string"},"harvest_record_transformed":{"format":"url","type":"string"},"has_download":{"type":"boolean"},"has_spatial":{"type":"boolean"},"identifier":{"type":"string"},"keyword":{"items":{"type":"string"},"type":"array"},"last_harvested_date":{"format":"date","type":"string"},"organization":{"$ref":"#/components/schemas/Organization"},"popularity":{"type":"integer"},"publisher":{"type":"string"},"slug":{"type":"string"}},"type":"object"},"GeoJson":{"additionalProperties":false,"properties":{"coordinates":{"items":{"items":{"items":{"type":"number"},"maxItems":2,"minItems":2,"type":"array"},"type":"array"},"type":"array"},"type":{"type":"string"}},"type":"object"},"HTTPError":{"properties":{"detail":{"type":"object"},"message":{"type":"string"}},"type":"object"},"KeywordAndCount":{"additionalProperties":false,"properties":{"count":{"type":"integer"},"keyword":{"type":"string"}},"type":"object"},"KeywordsResults":{"additionalProperties":false,"properties":{"keywords":{"items":{"$ref":"#/components/schemas/KeywordAndCount"},"type":"array"},"min_count":{"type":"integer"},"size":{"type":"integer"},"total":{"type":"integer"}},"type":"object"},"LocationDetail":{"additionalProperties":false,"properties":{"geometry":{"$ref":"#/components/schemas/GeoJson"},"id":{"format":"uuid","type":"string"}},"type":"object"},"LocationResponse":{"additionalProperties":false,"properties":{"display_name":{"type":"string"},"id":{"format":"uuid","type":"string"}},"type":"object"},"LocationsResults":{"additionalProperties":false,"properties":{"locations":{"items":{"$ref":"#/components/schemas/LocationResponse"},"type":"array"},"size":{"type":"integer"},"total":{"type":"integer"}},"type":"object"},"OpensearchHealth":{"additionalProperties":false,"properties":{"status":{"type":"string"}},"type":"object"},"Organization":{"additionalProperties":false,"properties":{"aliases":{"items":{"type":"string"},"type":"array"},"description":{"type":"string"},"id":{"format":"uuid","type":"string"},"logo":{"format":"url","type":"string"},"name":{"type":"string"},"organization_type":{"enum":["Federal Government","City Government","State Government","County Government","University","Tribal","Non-Profit"],"type":"string"},"slug":{"type":"string"}},"type":"object"},"OrganizationResponse":{"additionalProperties":false,"properties":{"aliases":{"items":{"type":"string"},"type":"array"},"count":{"type":"integer"},"id":{"format":"uuid","type":"string"},"name":{"type":"string"},"organization_type":{"enum":["Federal Government","City Government","State Government","County Government","University","Tribal","Non-Profit"],"type":"string"},"slug":{"type":"string"}},"type":"object"},"OrganizationsResults":{"additionalProperties":false,"properties":{"organizations":{"items":{"$ref":"#/components/schemas/OrganizationResponse"},"type":"array"},"total":{"type":"integer"}},"type":"object"},"PublisherResponse":{"additionalProperties":false,"properties":{"count":{"type":"integer"},"name":{"type":"string"}},"type":"object"},"PublishersResults":{"additionalProperties":false,"properties":{"publishers":{"items":{"$ref":"#/components/schemas/PublisherResponse"},"type":"array"},"total":{"type":"integer"}},"type":"object"},"SearchResults":{"additionalProperties":false,"properties":{"after":{"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Dataset"},"type":"array"},"sort":{"enum":["relevance","popularity","distance","last_harvested_date"],"type":"string"}},"required":["results","sort"],"type":"object"},"StatsMeta":{"additionalProperties":false,"properties":{"date":{"type":"string"}},"type":"object"},"StatsMetrics":{"additionalProperties":false,"properties":{"datasetsBarMetric":{"type":"string"},"orgBarMetric":{"type":"string"}},"type":"object"},"StatsResult":{"additionalProperties":false,"properties":{"meta":{"$ref":"#/components/schemas/StatsMeta"},"metrics":{"$ref":"#/components/schemas/StatsMetrics"},"results":{"$ref":"#/components/schemas/StatsResults"}},"type":"object"},"StatsResults":{"additionalProperties":false,"properties":{"datasets":{"type":"integer"},"datasetsWithIsPartOf":{"type":"integer"}},"type":"object"},"ValidationError":{"properties":{"detail":{"properties":{"<location>":{"properties":{"<field_name>":{"items":{"type":"string"},"type":"array"}},"type":"object"}},"type":"object"},"message":{"type":"string"}},"type":"object"}}},"info":{"title":"Datagov Catalog","version":"0.1.0"},"openapi":"3.1.0","paths":{"/api/dataset/{slug_or_id}":{"get":{"description":"Get a single opensearch document based on slug name","parameters":[{"in":"path","name":"slug_or_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResults"}}},"description":"Successful response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"summary":"gets a single document based on the dataset slug name or dataset id","tags":["Api"]}},"/api/keywords":{"get":{"description":"Get a list of the most popular keywords and how often they occur","parameters":[{"in":"query","name":"size","required":false,"schema":{"type":"integer"}},{"in":"query","name":"min_count","required":false,"schema":{"type":"integer"}},{"in":"query","name":"search","required":false,"schema":{"type":"string"}},{"explode":true,"in":"query","name":"keyword","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeywordsResults"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"summary":"Get unique keywords with counts.","tags":["Api"]}},"/api/location/{location_id}":{"get":{"description":"To display a location client-side, this gives us the location's geometry.","parameters":[{"in":"path","name":"location_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationDetail"}}},"description":"Successful response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"summary":"Get geometry for one location","tags":["Api"]}},"/api/locations/search":{"get":{"description":"For autocomplete, we use an API to search our locations database for the typed query","parameters":[{"in":"query","name":"q","required":false,"schema":{"type":"string"}},{"in":"query","name":"size","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationsResults"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"summary":"Search location display names and ids.","tags":["Api"]}},"/api/opensearch/health":{"get":{"parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpensearchHealth"}}},"description":"Successful response"}},"summary":"Fetch OpenSearch cluster health.","tags":["Api"]}},"/api/organizations":{"get":{"description":"Get the complete list of organizations","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationsResults"}}},"description":"Successful response"}},"summary":"Fetch the complete list of organizations.","tags":["Api"]}},"/api/publishers":{"get":{"description":"Get the top 100 publishers","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishersResults"}}},"description":"Successful response"}},"summary":"Fetch the top 100 publishers.","tags":["Api"]}},"/api/stats":{"get":{"parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatsResult"}}},"description":"Successful response"}},"summary":"Endpoint for stats consumers.","tags":["Api"]}},"/search":{"get":{"description":"Search the catalog for datasets based on query parameters","parameters":[{"in":"query","name":"q","required":false,"schema":{"type":"string"}},{"in":"query","name":"sort","required":false,"schema":{"enum":["relevance","popularity","distance","last_harvested_date"],"type":"string"}},{"description":"Number of results per page. Must be between 1 and 1000.","in":"query","name":"per_page","required":false,"schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"in":"query","name":"after","required":false,"schema":{"type":"string"}},{"description":"URL-encoded JSON value, such as GeoJSON.","in":"query","name":"spatial_geometry","required":false,"schema":{"type":"string"}},{"in":"query","name":"spatial_within","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"geography_label","required":false,"schema":{"type":"string"}},{"explode":true,"in":"query","name":"keyword","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"in":"query","name":"org_slug","required":false,"schema":{"type":"string"}},{"explode":true,"in":"query","name":"org_type","required":false,"schema":{"items":{"enum":["Federal Government","City Government","State Government","County Government","University","Tribal","Non-Profit"],"type":"string"},"type":"array"},"style":"form"},{"in":"query","name":"publisher","required":false,"schema":{"type":"string"}},{"in":"query","name":"spatial_filter","required":false,"schema":{"enum":["geospatial","non-geospatial"],"type":"string"}},{"in":"query","name":"collection","required":false,"schema":{"type":"string"}},{"in":"query","name":"has_download","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResults"}}},"description":"Dataset search results"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"summary":"Search for datasets.","tags":["Api"]}}},"servers":[{"url":"https://catalog.data.gov"}],"tags":[{"name":"Api"}]}