botifySDK.swagger.json

{
  "swagger": "2.0",
  "info": {
    "version": "1.0.0",
    "title": "Botify Analytics",
    "description": "Botify Analytics POC",
    "contact": {
      "name": "Botify Team",
      "url": "https://botify.com",
      "email": "tech@botify.com"
    },
    "license": {
      "name": "MIT"
    }
  },
  "host": "api.botify.com",
  "schemes": [
    "https"
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "paths": {
    "/analyses/{userId}/{projectId}/{analysisId}/": {
      "get": {
        "operationId": "get",
        "tags": [
          "analysis"
        ],
        "summary": "Get a specific analysis",
        "parameters": [
          {
            "name": "userId",
            "in": "path",
            "type": "string",
            "description": "User Id",
            "required": true
          },
          {
            "name": "projectId",
            "in": "path",
            "type": "string",
            "description": "Project Id",
            "required": true
          },
          {
            "name": "analysisId",
            "in": "path",
            "type": "string",
            "description": "Analysis Id",
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "A analysis",
            "schema": {
              "$ref": "#/definitions/Analysis"
            }
          },
          "404": {
            "description": "Analysis doesn't exist"
          }
        },
        "security": [
          {
            "DjangoRestToken": []
          }
        ]
      }
    }
  },
  "definitions": {
    "Analysis": {
      "type": "object",
      "required": [
        "id"
      ],
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64"
        },
        "name": {
          "type": "string"
        },
        "url": {
          "type": "string"
        },
        "failures": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    }
  },
  "securityDefinitions": {
    "DjangoRestToken": {
      "type": "apiKey",
      "name": "Authorization",
      "in": "header"
    }
  }
}

rest_swagger_file.json

{
   "info": {
      "contact": "apiteam@wordnik.com",
      "description": "This is a sample server Petstore server. You can find out more about Swagger at <a href=\"http://swagger.wordnik.com\">http://swagger.wordnik.com<\/a> or on irc.freenode.net, #swagger. For this sample, you can use the api key \"special-key\" to test the authorization filters",
      "title": "Swagger Sample App"
   },
   "basePath": "http://api.botify.fr:8000/docs/api-docs",
   "swaggerVersion": "1.2",
   "apiVersion": "1",
   "apis": [
      {
         "path": "/analyses"
      },
      {
         "path": "/contacts"
      },
      {
         "path": "/crawls"
      },
      {
         "path": "/orders"
      },
      {
         "path": "/projects"
      },
      {
         "path": "/sites"
      },
      {
         "path": "/subscriptions"
      },
      {
         "path": "/test-extract-rule"
      },
      {
         "path": "/tokens"
      },
      {
         "path": "/update-settings"
      },
      {
         "path": "/urls"
      },
      {
         "path": "/users"
      },
      {
         "path": "/{version})"
      }
   ]
}