swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "Kursplan API",
    "description": "Creates html and configuration for showing course syllabus information based on course code and semester",
    "version": "1.0.0"
  },
  "basePath": "/api/kursplan",
  "produces": ["application/json", "application/pdf"],
  "paths": {
    "/_checkAPIkey": {
      "get": {
        "operationId": "checkAPIkey",
        "summary": "GET a test endpoint that is protected by api key to validate that consumer has a proper api key",
        "description": "",
        "parameters": [],
        "tags": ["system"],
        "responses": {
          "200": {
            "description": "An empty response"
          },
          "default": {
            "description": "Unexpected error",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "security": [
          {
            "api_key": ["read"]
          }
        ]
      }
    },
    "/v1/syllabus/{courseCode}/{semester}/{language}": {
      "get": {
        "operationId": "getSyllabusByCourseCode",
        "summary": "Create a syllabus PDF for course code and semester in requested language",
        "description": "Retrieves data from Kopps and creates a syllabus PDF for course code and semester in requested language.",
        "parameters": [
          {
            "name": "courseCode",
            "in": "path",
            "description": "Course code that has the requested syllabus",
            "required": true,
            "type": "string"
          },
          {
            "name": "semester",
            "in": "path",
            "description": "Semester, five digits, with the year and semester number    (Fall: 1, Spring: 2, ex: 20102) for the requested syllabus ",
            "required": true,
            "type": "string"
          },
          {
            "name": "language",
            "in": "path",
            "description": "Language for the response, 'sv': Swedish, 'en': English, default is 'sv'",
            "required": false,
            "type": "string"
          },
          {
            "name": "documentName",
            "in": "query",
            "description": "Desired name for PDF document. File suffix pdf will be added.",
            "required": false,
            "type": "string"
          },
          {
            "name": "download",
            "in": "query",
            "description": "Should PDF document be downloaded? If download parameter is true, the response will have a 'Content-Disposition' header set to 'attachment', otherwise 'inline'.",
            "required": false,
            "type": "string"
          }
        ],
        "tags": ["v1"],
        "responses": {
          "200": {
            "description": "The requested PDF file",
            "schema": {
              "type": "file"
            }
          },
          "default": {
            "description": "Unexpected error",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "security": [
          {
            "api_key": ["read"]
          }
        ]
      }
    }
  },
  "securityDefinitions": {
    "api_key": {
      "type": "apiKey",
      "name": "api_key",
      "in": "header",
      "scopes": {
        "read": "Read access to data",
        "write": "Write access to data"
      }
    }
  },
  "definitions": {
    "Syllabus": {
      "properties": {
        "courseCode": {
          "type": "string",
          "description": "Unique identifier representing some specific data"
        },
        "courseTitle": {
          "type": "string",
          "description": "Description of the data"
        }
      }
    },
    "Data": {
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique identifier representing some specific data"
        },
        "name": {
          "type": "string",
          "description": "Description of the data"
        }
      }
    },
    "Error": {
      "properties": {
        "code": {
          "type": "integer",
          "format": "int32"
        },
        "message": {
          "type": "string"
        },
        "fields": {
          "type": "string"
        }
      }
    }
  }
}