swagger.json

{"swagger":"2.0","info":{"description":"Interra Open Data Catalog APIs. These are all read endpoints since Interra Generate runs without a server. Full CRUD APIs are available with Interra Admin.","version":"0.0.1","title":"DKAN Demo Data Catalog API"},"paths":{"/data.json":{"get":{"summary":"Project Open Data inspired endpoint","operationId":"dataJson","description":"A list of all of the datasets as fully rendered documents. If using the pod-full schema this will be Project Open Data compliant.","produces":["application/json"],"responses":{"200":{"description":"This is a file so will either be 200 or 404","schema":{"type":"array","items":{"$ref":"#/definitions/dataset"}}}}}},"/schema.json":{"get":{"summary":"Schema for the catalog","operationId":"schema","description":"A list of all of the schemas for the catalog.","produces":["application/json"],"responses":{"200":{"description":"This is a file so will either be 200 or 404","schema":{"type":"object","properties":{"collections":{"type":"array","items":{"type":"string","title":"Collections","description":"A list of strings of the collections in the catalog."}},"schema":{"type":"object","title":"Schema","description":"Schemas for all of the catalog collections"},"map":{"type":"object","description":"A mapping of expected keys for collections and the actual value. For example every collection should have an identifier. Map allows implementing a different key for identifier or other required keys.","title":"Map"},"uiSchema":{"type":"object","title":"UISchema","description":"A UISchema for the forms for each collection. See Mozilla's react-json-schema-form for details."}}}}}}},"/routes.json":{"get":{"summary":"A list of routes for the catalog.","description":"This list is used by the front end to determine what routes are rendered as well as the build process for rendering each HTML page.","operationId":"routes","produces":["application/json"],"responses":{"200":{"description":"This is a file so will either be 200 or 404","schema":{"type":"array","items":{"type":"string"}}}}}},"/latest.json":{"get":{"summary":"A list of datasets in descending date order.","description":"This list is used by the front end to determine what routes are rendered as well as the build process for rendering each HTML page.","operationId":"latest","produces":["application/json"],"responses":{"200":{"description":"This is a file so will either be 200 or 404","schema":{"type":"array","items":{"type":"object","properties":{"identifier":{"type":"string"},"modified":{"type":"string"}}}}}}}},"/collections/organization.json":{"get":{"summary":"All results for organization collection","operationId":"organizationCollection","produces":["application/json"],"responses":{"200":{"description":"This is a file so will either be 200 or 404","schema":{"type":"array","items":{"$ref":"#/definitions/organization"}}}}}},"/collections/organization/{document}.json":{"get":{"summary":"All results for organization collection","operationId":"organizationCollectionDoc","produces":["application/json"],"responses":{"200":{"description":"This is a file so will either be 200 or 404","schema":{"type":"array","items":{"$ref":"#/definitions/organization"}}}},"description":"An individual document in the organization","parameters":[{"in":"path","name":"document","type":"string","required":true,"description":"The identifier for the document."}]}},"/collections/distribution.json":{"get":{"summary":"All results for distribution collection","operationId":"distributionCollection","produces":["application/json"],"responses":{"200":{"description":"This is a file so will either be 200 or 404","schema":{"type":"array","items":{"$ref":"#/definitions/distribution"}}}}}},"/collections/distribution/{document}.json":{"get":{"summary":"All results for distribution collection","operationId":"distributionCollectionDoc","produces":["application/json"],"responses":{"200":{"description":"This is a file so will either be 200 or 404","schema":{"type":"array","items":{"$ref":"#/definitions/distribution"}}}},"description":"An individual document in the distribution","parameters":[{"in":"path","name":"document","type":"string","required":true,"description":"The identifier for the document."}]}},"/collections/keyword.json":{"get":{"summary":"All results for keyword collection","operationId":"keywordCollection","produces":["application/json"],"responses":{"200":{"description":"This is a file so will either be 200 or 404","schema":{"type":"array","items":{"$ref":"#/definitions/keyword"}}}}}},"/collections/keyword/{document}.json":{"get":{"summary":"All results for keyword collection","operationId":"keywordCollectionDoc","produces":["application/json"],"responses":{"200":{"description":"This is a file so will either be 200 or 404","schema":{"type":"array","items":{"$ref":"#/definitions/keyword"}}}},"description":"An individual document in the keyword","parameters":[{"in":"path","name":"document","type":"string","required":true,"description":"The identifier for the document."}]}},"/collections/license.json":{"get":{"summary":"All results for license collection","operationId":"licenseCollection","produces":["application/json"],"responses":{"200":{"description":"This is a file so will either be 200 or 404","schema":{"type":"array","items":{"$ref":"#/definitions/license"}}}}}},"/collections/license/{document}.json":{"get":{"summary":"All results for license collection","operationId":"licenseCollectionDoc","produces":["application/json"],"responses":{"200":{"description":"This is a file so will either be 200 or 404","schema":{"type":"array","items":{"$ref":"#/definitions/license"}}}},"description":"An individual document in the license","parameters":[{"in":"path","name":"document","type":"string","required":true,"description":"The identifier for the document."}]}},"/collections/theme.json":{"get":{"summary":"All results for theme collection","operationId":"themeCollection","produces":["application/json"],"responses":{"200":{"description":"This is a file so will either be 200 or 404","schema":{"type":"array","items":{"$ref":"#/definitions/theme"}}}}}},"/collections/theme/{document}.json":{"get":{"summary":"All results for theme collection","operationId":"themeCollectionDoc","produces":["application/json"],"responses":{"200":{"description":"This is a file so will either be 200 or 404","schema":{"type":"array","items":{"$ref":"#/definitions/theme"}}}},"description":"An individual document in the theme","parameters":[{"in":"path","name":"document","type":"string","required":true,"description":"The identifier for the document."}]}},"/collections/dataset.json":{"get":{"summary":"All results for dataset collection","operationId":"datasetCollection","produces":["application/json"],"responses":{"200":{"description":"This is a file so will either be 200 or 404","schema":{"type":"array","items":{"$ref":"#/definitions/dataset"}}}}}},"/collections/dataset/{document}.json":{"get":{"summary":"All results for dataset collection","operationId":"datasetCollectionDoc","produces":["application/json"],"responses":{"200":{"description":"This is a file so will either be 200 or 404","schema":{"type":"array","items":{"$ref":"#/definitions/dataset"}}}},"description":"An individual document in the dataset","parameters":[{"in":"path","name":"document","type":"string","required":true,"description":"The identifier for the document."}]}}},"definitions":{"organization":{"title":"Organization","description":"A Dataset Publisher Organization.","type":"object","required":["name"],"properties":{"@type":{"title":"Metadata Context","description":"IRI for the JSON-LD data type. This should be org:Organization for each publisher","type":"string","default":"org:Organization"},"name":{"title":"Publisher Name","description":"A full formatted name, eg Firstname Lastname","type":"string","minLength":1},"description":{"title":"Description","type":"string","description":"Description of the organization"},"identifier":{"type":"string","title":"Identifier"},"image":{"title":"Image","description":"Image or logo for the organization","type":"string","format":"uri"},"subOrganizationOf":{"title":"Parent Organization","type":"string"}}},"distribution":{"title":"Project Open Data Distribution","type":"object","required":["title"],"properties":{"@type":{"title":"Metadata Context","description":"IRI for the JSON-LD data type. This should be dcat:Distribution for each Distribution","default":"dcat:Distribution","type":"string"},"title":{"title":"Title","description":"Human-readable name of the distribution","type":"string","minLength":1},"identifier":{"title":"Identifier","description":"Distribution identifier","type":"string"},"description":{"title":"Description","description":"Human-readable description of the distribution","type":"string","minLength":1},"fileLocation":{"title":" ","type":"string"},"format":{"title":"Format","description":"A human-readable description of the file format of a distribution","type":"string"},"mediaType":{"title":"Media Type","description":"The machine-readable file format (IANA Media Type or MIME Type) of the distribution’s downloadURL","pattern":"^[-\\w]+/[-\\w]+(\\.[-\\w]+)*([+][-\\w]+)?$","type":"string"},"mediaSize":{"title":"Media Size","description":"The size of the meida file.","type":"integer"},"downloadURL":{"title":"Download URL","description":"URL providing direct access to a downloadable file of a dataset","type":"string","format":"uri"},"accessURL":{"title":"Access URL","description":"URL providing indirect access to a dataset","type":"string","format":"uri"},"conformsTo":{"title":"Data Standard","description":"URL providing indirect access to a dataset","type":"string","format":"uri"},"describedBy":{"title":"Data Dictionary","description":"URL to the data dictionary for the distribution found at the downloadURL","type":"string","format":"uri"},"describedByType":{"title":"Data Dictionary Type","description":"The machine-readable file format (IANA Media Type or MIME Type) of the distribution’s describedBy URL","pattern":"^[-\\w]+/[-\\w]+(\\.[-\\w]+)*([+][-\\w]+)?$","type":"string"},"isssued":{"title":"Release Date","description":"Date of formal issuance.","type":"string","pattern":"^([\\+-]?\\d{4}(?!\\d{2}\\b))((-?)((0[1-9]|1[0-2])(\\3([12]\\d|0[1-9]|3[01]))?|W([0-4]\\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\\d|[12]\\d{2}|3([0-5]\\d|6[1-6])))([T\\s]((([01]\\d|2[0-3])((:?)[0-5]\\d)?|24\\:?00)([\\.,]\\d+(?!:))?)?(\\17[0-5]\\d([\\.,]\\d+)?)?([zZ]|([\\+-])([01]\\d|2[0-3]):?([0-5]\\d)?)?)?)?$"}}},"keyword":{"title":"Tags","description":"Tags (or keywords) help users discover your dataset; please include terms that would be used by technical and non-technical users.","type":"object","required":["title","identifier"],"properties":{"title":{"title":"Title","type":"string"},"identifier":{"type":"string","title":"Identifier"},"created":{"type":"string","title":"Created","format":"date-time"},"modified":{"type":"string","title":"Modified","format":"date-time"},"icon":{"type":"string","title":"icon"}}},"license":{"title":"License","description":"A license for datasets","type":"object","required":["title","identifier"],"properties":{"title":{"title":"Title","type":"string"},"identifier":{"type":"string","title":"Identifier"},"created":{"type":"string","title":"Created","format":"date-time"},"modified":{"type":"string","title":"Modified","format":"date-time"},"link":{"type":"string","description":"A link to the license definition","title":"definition","format":"uri"}}},"theme":{"title":"Category","description":"Main thematic category of the dataset.","type":"object","required":["title","identifier","created","modified"],"properties":{"title":{"title":"Title","type":"string"},"identifier":{"type":"string","title":"Identifier"},"created":{"type":"string","title":"Created","format":"date-time"},"modified":{"type":"string","title":"Modified","format":"date-time"},"icon":{"type":"string","title":"icon"}}},"dataset":{"title":"Project Open Data Dataset","description":"The metadata format for all federal open data. Validates a single JSON object entry (as opposed to entire Data.json catalog).","type":"object","required":["title","description","identifier","accessLevel"],"properties":{"@type":{"title":"Metadata Context","type":"string","description":"IRI for the JSON-LD data type. This should be dcat:Dataset for each Dataset","default":"dcat:Dataset"},"title":{"title":"Title","description":"Human-readable name of the asset. Should be in plain English and include sufficient detail to facilitate search and discovery.","type":"string","minLength":1},"identifier":{"title":"Unique Identifier","description":"A unique identifier for the dataset or API as maintained within an Agency catalog or database.","type":"string","minLength":1},"description":{"title":"Description","description":"Human-readable description (e.g., an abstract) with sufficient detail to enable a user to quickly understand whether the asset is of interest.","type":"string","minLength":1},"accessLevel":{"description":"The degree to which this dataset could be made publicly-available, regardless of whether it has been made available. Choices: public (Data asset is or could be made publicly available to all without restrictions), restricted public (Data asset is available under certain use restrictions), or non-public (Data asset is not available to members of the public)","title":"Public Access Level","type":"string","enum":["public","restricted public","non-public"]},"rights":{"title":"Rights","description":"This may include information regarding access or restrictions based on privacy, security, or other policies. This should also provide an explanation for the selected \"accessLevel\" including instructions for how to access a restricted file, if applicable, or explanation for why a \"non-public\" or \"restricted public\" data assetis not \"public,\" if applicable. Text, 255 characters.","type":"string","maxLength":255},"accrualPeriodicity":{"title":"Frequency","description":"Frequency with which dataset is published.","type":"string"},"bureauCode":{"title":"Bureau Code","description":"Federal agencies, combined agency and bureau code from <a href=\"http://www.whitehouse.gov/sites/default/files/omb/assets/a11_current_year/app_c.pdf\">OMB Circular A-11, Appendix C</a> in the format of <code>015:010</code>.","type":"array","items":{"type":"string","pattern":"[0-9]{3}:[0-9]{2}"},"minItems":1,"uniqueItems":true},"describedBy":{"title":"Data Dictionary","description":"URL to the data dictionary for the dataset or API. Note that documentation other than a data dictionary can be referenced using Related Documents as shown in the expanded fields.","type":"string","format":"uri"},"describedByType":{"title":"Data Dictionary Type","description":"The machine-readable file format (IANA Media Type or MIME Type) of the distribution’s describedBy URL","pattern":"^[-\\w]+/[-\\w]+(\\.[-\\w]+)*([+][-\\w]+)?$","type":"string"},"conformsTo":{"title":"Data Standard","description":"URI used to identify a standardized specification the dataset conforms to","type":"string","format":"uri"},"dataQuality":{"title":"Data Quality","description":"Whether the dataset meets the agency’s Information Quality Guidelines (true/false).","type":"boolean"},"contactPoint":{"title":"Contact","description":"Contact person for dataset.","type":"object","items":{"type":"object","properties":{"@type":{"type":"string","title":"Metadata Context","description":"IRI for the JSON-LD data type. This should be vcard:Contact for contactPoint","default":"vcard:Contact"},"fn":{"title":"Contact Name","description":"A full formatted name, eg Firstname Lastname","type":"string","minLength":1},"hasEmail":{"title":"Email","description":"Email address for the contact","pattern":"^mailto:[\\w\\_\\~\\!\\$\\&\\'\\(\\)\\*\\+\\,\\;\\=\\:.-]+@[\\w.-]+\\.[\\w.-]+?$","type":"string"}}}},"distribution":{"title":"Distribution","description":"A container for the array of Distribution objects","type":"array","items":{"minItems":1,"uniqueItems":true,"title":"Project Open Data Distribution","type":"object","required":["title"],"properties":{"@type":{"title":"Metadata Context","description":"IRI for the JSON-LD data type. This should be dcat:Distribution for each Distribution","default":"dcat:Distribution","type":"string"},"title":{"title":"Title","description":"Human-readable name of the distribution","type":"string","minLength":1},"identifier":{"title":"Identifier","description":"Distribution identifier","type":"string"},"description":{"title":"Description","description":"Human-readable description of the distribution","type":"string","minLength":1},"fileLocation":{"title":" ","type":"string"},"format":{"title":"Format","description":"A human-readable description of the file format of a distribution","type":"string"},"mediaType":{"title":"Media Type","description":"The machine-readable file format (IANA Media Type or MIME Type) of the distribution’s downloadURL","pattern":"^[-\\w]+/[-\\w]+(\\.[-\\w]+)*([+][-\\w]+)?$","type":"string"},"mediaSize":{"title":"Media Size","description":"The size of the meida file.","type":"integer"},"downloadURL":{"title":"Download URL","description":"URL providing direct access to a downloadable file of a dataset","type":"string","format":"uri"},"accessURL":{"title":"Access URL","description":"URL providing indirect access to a dataset","type":"string","format":"uri"},"conformsTo":{"title":"Data Standard","description":"URL providing indirect access to a dataset","type":"string","format":"uri"},"describedBy":{"title":"Data Dictionary","description":"URL to the data dictionary for the distribution found at the downloadURL","type":"string","format":"uri"},"describedByType":{"title":"Data Dictionary Type","description":"The machine-readable file format (IANA Media Type or MIME Type) of the distribution’s describedBy URL","pattern":"^[-\\w]+/[-\\w]+(\\.[-\\w]+)*([+][-\\w]+)?$","type":"string"},"isssued":{"title":"Release Date","description":"Date of formal issuance.","type":"string","pattern":"^([\\+-]?\\d{4}(?!\\d{2}\\b))((-?)((0[1-9]|1[0-2])(\\3([12]\\d|0[1-9]|3[01]))?|W([0-4]\\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\\d|[12]\\d{2}|3([0-5]\\d|6[1-6])))([T\\s]((([01]\\d|2[0-3])((:?)[0-5]\\d)?|24\\:?00)([\\.,]\\d+(?!:))?)?(\\17[0-5]\\d([\\.,]\\d+)?)?([zZ]|([\\+-])([01]\\d|2[0-3]):?([0-5]\\d)?)?)?)?$"}}}},"issued":{"title":"Release Date","description":"Date of formal issuance.","type":"string","pattern":"^([\\+-]?\\d{4}(?!\\d{2}\\b))((-?)((0[1-9]|1[0-2])(\\3([12]\\d|0[1-9]|3[01]))?|W([0-4]\\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\\d|[12]\\d{2}|3([0-5]\\d|6[1-6])))([T\\s]((([01]\\d|2[0-3])((:?)[0-5]\\d)?|24\\:?00)([\\.,]\\d+(?!:))?)?(\\17[0-5]\\d([\\.,]\\d+)?)?([zZ]|([\\+-])([01]\\d|2[0-3]):?([0-5]\\d)?)?)?)?$"},"keyword":{"title":"Tags","description":"Tags (or keywords) help users discover your dataset; please include terms that would be used by technical and non-technical users.","type":"array","items":{"$schema":"http://json-schema.org/draft-04/schema","title":"Tags","description":"Tags (or keywords) help users discover your dataset; please include terms that would be used by technical and non-technical users.","type":"object","required":["title","identifier"],"properties":{"title":{"title":"Title","type":"string"},"identifier":{"type":"string","title":"Identifier"},"created":{"type":"string","title":"Created","format":"date-time"},"modified":{"type":"string","title":"Modified","format":"date-time"},"icon":{"type":"string","title":"icon"}}}},"landingPage":{"title":"Homepage URL","description":"Alternative landing page used to redirect user to a contextual, Agency-hosted “homepage” for the Dataset or API when selecting this resource from the Data.gov user interface.","type":"string","format":"uri"},"language":{"title":"Language","description":"The language of the dataset.","type":"array","default":["en"],"items":{"type":"string","pattern":"^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$"}},"license":{"title":"License","description":"The license dataset or API is published with. See <a href=\"https://project-open-data.cio.gov/open-licenses/\">Open Licenses</a> for more information.","type":"string","format":"uri"},"modified":{"title":"Last Update","description":"Most recent date on which the dataset was changed, updated or modified.","type":"string","pattern":"^([\\+-]?\\d{4}(?!\\d{2}\\b))((-?)((0[1-9]|1[0-2])(\\3([12]\\d|0[1-9]|3[01]))?|W([0-4]\\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\\d|[12]\\d{2}|3([0-5]\\d|6[1-6])))([T\\s]((([01]\\d|2[0-3])((:?)[0-5]\\d)?|24\\:?00)([\\.,]\\d+(?!:))?)?(\\17[0-5]\\d([\\.,]\\d+)?)?([zZ]|([\\+-])([01]\\d|2[0-3]):?([0-5]\\d)?)?)?)?$"},"primaryITInvestmentUII":{"title":"Primary IT Investment UII","description":"For linking a dataset with an IT Unique Investment Identifier (UII)","type":"string","pattern":"[0-9]{3}-[0-9]{9}"},"programCode":{"title":"Program Code","description":"Federal agencies, list the primary program related to this data asset, from the <a href=\"http://goals.performance.gov/sites/default/files/images/FederalProgramInventory_FY13_MachineReadable_091613.xls\">Federal Program Inventory</a>. Use the format of <code>015:001</code>","type":"array","items":{"type":"string","pattern":"[0-9]{3}:[0-9]{3}"},"minItems":1,"uniqueItems":true},"publisher":{"type":"object","properties":{"$schema":"http://json-schema.org/draft-04/schema#","id":"https://project-open-data.cio.gov/v1.1/schema/organization.json#","title":"Organization","description":"A Dataset Publisher Organization.","type":"object","required":["name"],"properties":{"@type":{"title":"Metadata Context","description":"IRI for the JSON-LD data type. This should be org:Organization for each publisher","type":"string","default":"org:Organization"},"name":{"title":"Publisher Name","description":"A full formatted name, eg Firstname Lastname","type":"string","minLength":1},"description":{"title":"Description","type":"string","description":"Description of the organization"},"identifier":{"type":"string","title":"Identifier"},"image":{"title":"Image","description":"Image or logo for the organization","type":"string","format":"uri"},"subOrganizationOf":{"title":"Parent Organization","type":"string"}}}},"references":{"title":"Related Documents","description":"Related documents such as technical information about a dataset, developer documentation, etc.","type":"array","items":{"type":"string","format":"uri"}},"spatial":{"title":"Spatial","description":"The range of spatial applicability of a dataset. Could include a spatial region like a bounding box or a named place.","type":"string","minLength":1},"systemOfRecords":{"title":"System of Records","description":"If the systems is designated as a system of records under the Privacy Act of 1974, provide the URL to the System of Records Notice related to this dataset.","minLength":1,"type":"string"},"temporal":{"title":"Temporal","description":"The range of temporal applicability of a dataset (i.e., a start and end date of applicability for the data).","type":"string","pattern":"^([\\+-]?\\d{4}(?!\\d{2}\\b))((-?)((0[1-9]|1[0-2])(\\3([12]\\d|0[1-9]|3[01]))?|W([0-4]\\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\\d|[12]\\d{2}|3([0-5]\\d|6[1-6])))([T\\s]((([01]\\d|2[0-3])((:?)[0-5]\\d)?|24\\:?00)([\\.,]\\d+(?!:))?)?(\\17[0-5]\\d([\\.,]\\d+)?)?([zZ]|([\\+-])([01]\\d|2[0-3]):?([0-5]\\d)?)?)?)?(\\/)([\\+-]?\\d{4}(?!\\d{2}\\b))((-?)((0[1-9]|1[0-2])(\\3([12]\\d|0[1-9]|3[01]))?|W([0-4]\\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\\d|[12]\\d{2}|3([0-5]\\d|6[1-6])))([T\\s]((([01]\\d|2[0-3])((:?)[0-5]\\d)?|24\\:?00)([\\.,]\\d+(?!:))?)?(\\17[0-5]\\d([\\.,]\\d+)?)?([zZ]|([\\+-])([01]\\d|2[0-3]):?([0-5]\\d)?)?)?)?$"},"isPartOf":{"title":"Collection","description":"The collection of which the dataset is a subset","type":"string","minLength":1},"theme":{"title":"Category","description":"Main thematic category of the dataset.","type":"array","items":{"minLength":1,"minItems":1,"$schema":"http://json-schema.org/draft-04/schema#","title":"Category","description":"Main thematic category of the dataset.","type":"object","required":["title","identifier","created","modified"],"properties":{"title":{"title":"Title","type":"string"},"identifier":{"type":"string","title":"Identifier"},"created":{"type":"string","title":"Created","format":"date-time"},"modified":{"type":"string","title":"Modified","format":"date-time"},"icon":{"type":"string","title":"icon"}}},"uniqueItems":true}}}},"host":"","basePath":"/api/v1/","schemes":["https","http"]}