app/swagger.json at main · Image-Captioning-Team/app · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
{
  "swagger": "2.0",
  "info": {
    "version": "1.0.0",
    "title": "CSC 580 - Image Captioning"
  },
  "host": "image-capturing.andreasriepl.de",
  "basePath": "/api",
  "schemes": [
    "https",
    "http"
  ],
  "paths": {
    "/capture": {
      "post": {
        "tags": [
          "captioning"
        ],
        "summary": "Generate an image capture for a given picture",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "description": "Image to be captured",
            "required": true,
            "schema": {
              "$ref": "#/definitions/ImageRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The capture for the given image",
            "schema": {
              "$ref": "#/definitions/CaptureResponse"
            }
          },
          "405": {
            "description": "Invalid input"
          }
        }
      }
    }
  },
  "definitions": {
    "ImageRequest": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "image": {
          "type": "string",
          "description": "Image as base64 data url"
        }
      }
    },
    "CaptureResponse": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "attention_caption": {
          "type": "string",
          "description": "Caption of the attention model"
        },
        "lstm_caption": {
          "type": "string",
          "description": "Caption of the lstm model"
        }
      }
    }
  },
  "externalDocs": {
    "description": "Find out more about Swagger",
    "url": "http://swagger.io"
  }
}