esTARestAPI/swagger_tmp.json at master · Pedrodpj92/esTARestAPI · 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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
{
  "swagger" : "2.0",
  "info" : {
    "version" : "1.1",
    "title" : "EsTextAnalytics REST API Documentation"
  },
  "host" : "api.textanalytics.linkeddata.es",
  "basePath" : "/esTARestAPI/rest",
  "tags" : [ {
    "name" : "RDF Catalog Service",
    "description" : "Requesting catalog with available EsDBpedia datasets"
  }, {
    "name" : "RDF Service",
    "description" : "API Operations to work with available catalog EsDBpedia datasets"
  } ],
  "schemes" : [ "http" ],
  "paths" : {
    "/RDFCatalogService/rdfcatalog" : {
      "get" : {
        "tags" : [ "RDF Catalog Service" ],
        "summary" : "Get RDF Catalog",
        "description" : "Get RDF Catalog, returns list with available datasets",
        "operationId" : "getUsers",
        "produces" : [ "application/json" ],
        "parameters" : [ ],
        "responses" : {
          "200" : {
            "description" : "successful operation",
            "schema" : {
              "type" : "array",
              "items" : {
                "type" : "object"
              }
            }
          }
        }
      }
    },
    "/RDFService/rdf/downloadhttp/{id}/resume/{n_offset_bytes}" : {
      "get" : {
        "tags" : [ "RDF Service" ],
        "summary" : "download RDF via http",
        "description" : "download RDF via http, starting from a particular byte",
        "operationId" : "doGet",
        "parameters" : [ {
          "name" : "id",
          "in" : "path",
          "description" : "Id referenced to RDF requested previosly",
          "required" : true,
          "type" : "string"
        }, {
          "name" : "n_offset_bytes",
          "in" : "path",
          "description" : "offset to request RDF and its byte where should continue",
          "required" : true,
          "type" : "integer",
          "format" : "int64"
        } ],
        "responses" : {
          "default" : {
            "description" : "successful operation"
          }
        }
      }
    },
    "/RDFService/rdf/{id}" : {
      "get" : {
        "tags" : [ "RDF Service" ],
        "summary" : "Get RDF data by id",
        "description" : "Get RDF data by id, returns operation response in json format",
        "operationId" : "getRdf",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "id",
          "in" : "path",
          "description" : "Id referenced to RDF requested",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "200" : {
            "description" : "successful operation",
            "schema" : {
              "$ref" : "#/definitions/RDFDownload"
            }
          }
        }
      },
      "delete" : {
        "tags" : [ "RDF Service" ],
        "summary" : "Delete RDF data by id",
        "description" : "Delete RDF data by id, returns operation response in json format",
        "operationId" : "deleteRdf",
        "consumes" : [ "application/json" ],
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "id",
          "in" : "path",
          "description" : "Id referenced to RDF requested to be deleted",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "200" : {
            "description" : "successful operation",
            "schema" : {
              "$ref" : "#/definitions/RDFDownload"
            }
          }
        }
      }
    },
    "/RDFService/rdf" : {
      "put" : {
        "tags" : [ "RDF Service" ],
        "summary" : "Generate RDF",
        "description" : "Generate RDF following available catalog datasets, returns operation response in json format",
        "operationId" : "putRdf",
        "consumes" : [ "application/json" ],
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "in" : "body",
          "name" : "body",
          "description" : "String in json format requesting what rdf from catalog should be merged ",
          "required" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "successful operation",
            "schema" : {
              "$ref" : "#/definitions/RDFDownload"
            }
          }
        }
      }
    }
  },
  "definitions" : {
    "FTPCon" : {
      "type" : "object",
      "properties" : {
        "port" : {
          "type" : "integer",
          "format" : "int32"
        },
        "url" : {
          "type" : "string"
        },
        "user" : {
          "type" : "string"
        },
        "pass" : {
          "type" : "string"
        }
      }
    },
    "RDFDownload" : {
      "type" : "object",
      "properties" : {
        "status" : {
          "type" : "string",
          "enum" : [ "OK", "CREATED", "PROCESSING", "DELETED", "UNEXPECTED", "ERROR" ]
        },
        "connection" : {
          "$ref" : "#/definitions/FTPCon"
        },
        "message" : {
          "type" : "string"
        },
        "dataid" : {
          "type" : "string"
        }
      }
    }
  }
}