{"swagger": "2.0", "info": {"title": "GeoMat API", "description": "This is the API for the elearning project GeoMat", "contact": {"email": "christian@elearning.physik.uni-frankfurt.de"}, "version": "v1.0"}, "schemes": ["localhost"], "basePath": "/", "paths": {"/api/classification/(P{id}[0-9]+)": {"get": {"operationId": "classification_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Classification"}}}, "consumes": ["application/json"], "tags": ["classification"]}, "parameters": [{"name": "id", "in": "path", "description": "A unique integer value identifying this classification.", "required": true, "type": "integer"}]}, "/api/classification_list": {"get": {"operationId": "classification_list_list", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"type": "array", "items": {"$ref": "#/definitions/Classification"}}}}, "consumes": ["application/json"], "tags": ["classification_list"]}, "parameters": []}, "/api/crystalsystem/{id}/": {"get": {"operationId": "crystalsystem_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/CrystalSystem"}}}, "consumes": ["application/json"], "tags": ["crystalsystem"]}, "parameters": [{"name": "id", "in": "path", "description": "A unique integer value identifying this Crystal System.", "required": true, "type": "integer"}]}, "/api/crystalsystem_filter": {"get": {"operationId": "crystalsystem_filter_list", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"type": "array", "items": {"$ref": "#/definitions/CrystalSystem"}}}}, "consumes": ["application/json"], "tags": ["crystalsystem_filter"]}, "parameters": []}, "/api/crystalsystem_list": {"get": {"operationId": "crystalsystem_list_list", "description": "This is a test", "parameters": [], "responses": {"200": {"description": "", "schema": {"type": "array", "items": {"$ref": "#/definitions/CrystalSystem"}}}}, "consumes": ["application/json"], "tags": ["crystalsystem_list"]}, "parameters": []}, "/api/glossary": {"get": {"operationId": "glossary_list", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"type": "array", "items": {"$ref": "#/definitions/GlossaryEntry"}}}}, "consumes": ["application/json"], "tags": ["glossary"]}, "parameters": []}, "/api/handpiece/{id}/": {"get": {"operationId": "handpiece_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Handpiece"}}}, "consumes": ["application/json"], "tags": ["handpiece"]}, "parameters": [{"name": "id", "in": "path", "description": "A unique integer value identifying this Handpiece.", "required": true, "type": "integer"}]}, "/api/handpiece_filter": {"get": {"operationId": "handpiece_filter_list", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"type": "array", "items": {"$ref": "#/definitions/Handpiece"}}}}, "consumes": ["application/json"], "tags": ["handpiece_filter"]}, "parameters": []}, "/api/handpiece_list": {"get": {"operationId": "handpiece_list_list", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"type": "array", "items": {"$ref": "#/definitions/Handpiece"}}}}, "consumes": ["application/json"], "tags": ["handpiece_list"]}, "parameters": []}, "/api/mineraltype/{id}/": {"get": {"operationId": "mineraltype_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/MineralType"}}}, "consumes": ["application/json"], "tags": ["mineraltype"]}, "parameters": [{"name": "id", "in": "path", "description": "A unique integer value identifying this mineral type.", "required": true, "type": "integer"}]}, "/api/mineraltype_filter": {"get": {"operationId": "mineraltype_filter_list", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"type": "array", "items": {"$ref": "#/definitions/MineralType"}}}}, "consumes": ["application/json"], "tags": ["mineraltype_filter"]}, "parameters": []}, "/api/mineraltype_list": {"get": {"operationId": "mineraltype_list_list", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"type": "array", "items": {"$ref": "#/definitions/MineralType"}}}}, "consumes": ["application/json"], "tags": ["mineraltype_list"]}, "parameters": []}, "/api/photograph/{id}/": {"get": {"operationId": "photograph_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Photograph"}}}, "consumes": ["application/json"], "tags": ["photograph"]}, "parameters": [{"name": "id", "in": "path", "description": "A unique integer value identifying this Photograph.", "required": true, "type": "integer"}]}, "/api/photograph_filter": {"get": {"operationId": "photograph_filter_list", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"type": "array", "items": {"$ref": "#/definitions/Photograph"}}}}, "consumes": ["application/json"], "tags": ["photograph_filter"]}, "parameters": []}, "/api/photograph_list": {"get": {"operationId": "photograph_list_list", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"type": "array", "items": {"$ref": "#/definitions/Photograph"}}}}, "consumes": ["application/json"], "tags": ["photograph_list"]}, "parameters": []}, "/api/profiles": {"get": {"operationId": "profiles_list", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"type": "array", "items": {"$ref": "#/definitions/MineralProfiles"}}}}, "consumes": ["application/json"], "tags": ["profiles"]}, "parameters": []}, "/api/quizanswer/(P{id}[0-9]+)": {"get": {"operationId": "quizanswer_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/QuizAnswerFull"}}}, "consumes": ["application/json"], "tags": ["quizanswer"]}, "parameters": [{"name": "id", "in": "path", "description": "A unique integer value identifying this quiz answer.", "required": true, "type": "integer"}]}, "/api/quizanswer_list": {"get": {"operationId": "quizanswer_list_list", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"type": "array", "items": {"$ref": "#/definitions/QuizAnswerFull"}}}}, "consumes": ["application/json"], "tags": ["quizanswer_list"]}, "parameters": []}, "/api/quizquestion/(P{id}[0-9]+)": {"get": {"operationId": "quizquestion_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/QuizQuestionFull"}}}, "consumes": ["application/json"], "tags": ["quizquestion"]}, "parameters": [{"name": "id", "in": "path", "description": "A unique integer value identifying this quiz question.", "required": true, "type": "integer"}]}, "/api/quizquestion_list": {"get": {"operationId": "quizquestion_list_list", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"type": "array", "items": {"$ref": "#/definitions/QuizQuestionFull"}}}}, "consumes": ["application/json"], "tags": ["quizquestion_list"]}, "parameters": []}}, "definitions": {"Classification": {"required": ["mineral_type"], "type": "object", "properties": {"classification_name": {"title": "Classification", "type": "string", "maxLength": 100}, "mineral_type": {"title": "Mineral type", "type": "array", "items": {"type": "integer"}, "uniqueItems": true}}}, "NameClassification": {"title": "Classification", "type": "object", "properties": {"classification_name": {"title": "Classification", "type": "string", "maxLength": 100}}}, "Cleavage": {"type": "object", "properties": {"cleavage": {"title": "Cleavage", "type": "string", "readOnly": true}, "coordinates": {"title": "Coordinates", "type": "string", "maxLength": 100}}}, "MineralType": {"title": "Mineral type", "required": ["classification", "cleavage", "mohs_scale", "streak", "normal_color", "chemical_formula"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "classification": {"$ref": "#/definitions/NameClassification"}, "systematics": {"title": "Systematics", "type": "string", "readOnly": true}, "fracture": {"title": "Fracture", "type": "string", "readOnly": true}, "cleavage": {"title": "Cleavage", "type": "array", "items": {"$ref": "#/definitions/Cleavage"}}, "lustre": {"title": "Lustre", "type": "string", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "trivial_name": {"title": "Trivial name", "type": "string", "maxLength": 100}, "variety": {"title": "Variety", "type": "string", "maxLength": 100}, "minerals": {"title": "Minerals", "type": "string", "maxLength": 100}, "mohs_scale": {"title": "Mohs scale", "type": "string", "maxLength": 20}, "density": {"title": "Density", "type": "string", "maxLength": 20}, "streak": {"title": "Streak", "type": "string", "maxLength": 100}, "normal_color": {"title": "Normal color", "type": "string", "maxLength": 100}, "chemical_formula": {"title": "Chemical formula", "type": "string", "maxLength": 100}, "other": {"title": "Comment", "type": "string", "maxLength": 100}, "resource_mindat": {"title": "MinDat ID", "type": "string", "maxLength": 100}, "resource_mineralienatlas": {"title": "MineralienAtlas ID", "type": "string", "maxLength": 100}, "created_at": {"title": "Created at", "type": "string", "format": "date-time", "readOnly": true}, "last_modified": {"title": "Last modified", "type": "string", "format": "date-time", "readOnly": true}}}, "CrystalSystem": {"required": ["mineral_type"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "mineral_type": {"$ref": "#/definitions/MineralType"}, "crystal_system": {"title": "Crystal system", "type": "string", "enum": ["TC", "MC", "OR", "TT", "TR", "HG", "CB", "AM"]}, "temperature": {"title": "Temperature", "type": "integer", "maximum": 2147483647, "minimum": -2147483648}, "pressure": {"title": "Pressure", "type": "integer", "maximum": 2147483647, "minimum": -2147483648}}}, "GlossaryEntry": {"required": ["id"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "maxLength": 100}, "header": {"title": "Header", "type": "string", "maxLength": 200}, "description": {"title": "Description", "type": "string"}}}, "Handpiece": {"required": ["name", "mineral_type"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "name": {"title": "Name of handpiece", "type": "string", "maxLength": 100}, "mineral_type": {"title": "Mineral type", "type": "array", "items": {"$ref": "#/definitions/MineralType"}}, "finding_place": {"title": "Place of discovery", "type": "string", "maxLength": 200}, "current_location": {"title": "Current location", "type": "string", "maxLength": 200}, "old_inventory_number": {"title": "Old inventory number", "type": "string", "maxLength": 100}, "created_at": {"title": "Created at", "type": "string", "format": "date-time", "readOnly": true}, "last_modified": {"title": "Last modified", "type": "string", "format": "date-time", "readOnly": true}}}, "Photograph": {"required": ["image_file", "handpiece", "orientation", "shot_type", "online_status"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "image_file": {"title": "Image file", "type": "string", "readOnly": true, "format": "uri"}, "handpiece": {"$ref": "#/definitions/Handpiece"}, "orientation": {"title": "Orientation", "type": "string", "enum": ["T", "B", "S"]}, "shot_type": {"title": "Shot type", "type": "string", "enum": ["MI", "MA", "FE", "TL"]}, "online_status": {"title": "Online status", "type": "boolean"}, "created_at": {"title": "Created at", "type": "string", "format": "date-time", "readOnly": true}, "last_modified": {"title": "Last modified", "type": "string", "format": "date-time", "readOnly": true}}}, "MineralProfiles": {"required": ["classification", "cleavage", "mohs_scale", "streak", "normal_color", "chemical_formula"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "classification": {"$ref": "#/definitions/NameClassification"}, "systematics": {"title": "Systematics", "type": "string", "readOnly": true}, "fracture": {"title": "Fracture", "type": "string", "readOnly": true}, "cleavage": {"title": "Cleavage", "type": "array", "items": {"$ref": "#/definitions/Cleavage"}}, "lustre": {"title": "Lustre", "type": "string", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "image_file": {"title": "Image file", "type": "string", "readOnly": true}, "trivial_name": {"title": "Trivial name", "type": "string", "maxLength": 100}, "variety": {"title": "Variety", "type": "string", "maxLength": 100}, "minerals": {"title": "Minerals", "type": "string", "maxLength": 100}, "mohs_scale": {"title": "Mohs scale", "type": "string", "maxLength": 20}, "density": {"title": "Density", "type": "string", "maxLength": 20}, "streak": {"title": "Streak", "type": "string", "maxLength": 100}, "normal_color": {"title": "Normal color", "type": "string", "maxLength": 100}, "chemical_formula": {"title": "Chemical formula", "type": "string", "maxLength": 100}, "other": {"title": "Comment", "type": "string", "maxLength": 100}, "resource_mindat": {"title": "MinDat ID", "type": "string", "maxLength": 100}, "resource_mineralienatlas": {"title": "MineralienAtlas ID", "type": "string", "maxLength": 100}, "created_at": {"title": "Created at", "type": "string", "format": "date-time", "readOnly": true}, "last_modified": {"title": "Last modified", "type": "string", "format": "date-time", "readOnly": true}}}, "QuizQuestionLess": {"title": "Question", "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "qtext": {"title": "Question text", "type": "string", "maxLength": 500}, "qtype": {"title": "Qtype", "type": "string", "readOnly": true}, "tags": {"title": "Tags", "description": "If you want to add more than one tag, seperate them with commas.", "type": "array", "items": {"title": "Tags", "type": "string", "maxLength": 200}}, "difficulty": {"title": "Difficulty", "type": "string", "enum": [1, 2, 3, 4, 5]}}}, "QuizAnswerFull": {"required": ["question"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "question": {"$ref": "#/definitions/QuizQuestionLess"}, "atext": {"title": "Answer text", "type": "string", "maxLength": 500}, "correct": {"title": "Correct", "description": "Nothing yet.", "type": "boolean"}, "feedback_correct": {"title": "Feedback if answered correctly", "type": "string", "maxLength": 500}, "feedback_incorrect": {"title": "Feedback if answered incorrectly", "type": "string", "maxLength": 500}}}, "QuizAnswerLess": {"type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "atext": {"title": "Answer text", "type": "string", "maxLength": 500}, "correct": {"title": "Correct", "description": "Nothing yet.", "type": "boolean"}, "feedback_correct": {"title": "Feedback if answered correctly", "type": "string", "maxLength": 500}, "feedback_incorrect": {"title": "Feedback if answered incorrectly", "type": "string", "maxLength": 500}}}, "QuizQuestionFull": {"required": ["answers"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "qtype": {"title": "Qtype", "type": "string", "readOnly": true}, "answers": {"title": "Answers", "type": "array", "items": {"$ref": "#/definitions/QuizAnswerLess"}}, "qtext": {"title": "Question text", "type": "string", "maxLength": 500}, "tags": {"title": "Tags", "description": "If you want to add more than one tag, seperate them with commas.", "type": "array", "items": {"title": "Tags", "type": "string", "maxLength": 200}}, "difficulty": {"title": "Difficulty", "type": "string", "enum": [1, 2, 3, 4, 5]}}}}, "securityDefinitions": {"basic": {"type": "basic"}}}