json explore.data.gov domains api swagger defintion

Posted 2021-05-19

{
    "apiVersion": "1.0",
    "swaggerVersion": "1.2",
    "basePath": "https://explore.data.gov/resource",
    "resourcePath": "",
    "produces": [
        "application/json"
    ],
    "apis": [
        {
            "path": "/federal-executive-agency-internet-domains.json",
            "operations": [
                {
                    "method": "GET",
                    "summary": "Pull internet domains",
                    "notes": "Returns a list of executive agency internet domain.",
                    "nickname": "getAnalysis",
                    "type": "domain",
                    "parameters": [
			            {
			              "id": "domain_name",
			              "name": "domain_name",
			              "description": "Retrieve all records with domain_name equal to example.gov.",
			              "required": false,
			              "allowMultiple": false,
			              "dataType": "string",
			              "paramType": "query"
			            },
			            {
			              "id": "domain_name_address",
			              "name": "domain_name_address",
			              "description": "Retrieve all records with domain_name_address equal to https://www.example.gov.",
			              "required": false,
			              "allowMultiple": false,
			              "dataType": "string",
			              "paramType": "query"
			            },                    
                        {
                            "name": "federal_agency",
                            "description": "Retrieve all records with federal_agency equal to US Interagency Council on Homelessness.",
                            "required": false,
                            "allowMultiple": false,
                            "dataType": "string",
                            "paramType": "query"
                        },                    
                        {
                            "name": "redirecting",
                            "description": "Retrieve all records with redirecting equal to 302.",
                            "required": false,
                            "allowMultiple": false,
                            "dataType": "string",
                            "paramType": "query"
                        },                    
                        {
                            "name": "redirect_destination",
                            "description": "Retrieve all records with redirect_destination equal to www.example.gov.",
                            "required": false,
                            "allowMultiple": false,
                            "dataType": "string",
                            "paramType": "query"
                        }
                    ],
                    "produces": [
                        "application/json"
                    ],
                    "responseMessages": [
                        {
                            "code": 404,
                            "message": "There are no internet domains."
                        }
                    ]
                }
            ]
        }
    ],
    "models": {
        "domain": {
            "id": "domain",
            "properties": {
                "domain_name_address": {
                    "type": "string"
                },
                "domain_name": {
                    "type": "string"
                },
                "redirecting": {
                    "type": "string"
                },
                "federal_agency": {
                    "type": "string"
                }
            }
        }
    }
}