| PatrikBuhr | d1d0854 | 2020-09-11 16:50:37 +0200 | [diff] [blame] | 1 | swagger: '2.0' |
| 2 | info: |
| 3 | description: This page lists all the rest apis for the service. |
| 4 | version: '1.0' |
| 5 | title: Enrichment Data service |
| 6 | host: 'localhost:8081' |
| 7 | basePath: / |
| 8 | tags: |
| 9 | - name: A1-E Enrichment Data Consumer API |
| 10 | description: Consumer Controller |
| 11 | paths: |
| 12 | /A1-EI/v1/eitypes: |
| 13 | get: |
| 14 | tags: |
| 15 | - A1-E Enrichment Data Consumer API |
| 16 | summary: Query EI type identifiers |
| 17 | description: DETAILS TBD |
| 18 | operationId: getEiTypeIdentifiersUsingGET |
| 19 | produces: |
| 20 | - application/json |
| 21 | responses: |
| 22 | '200': |
| 23 | description: EI type identifiers |
| 24 | schema: |
| 25 | type: array |
| 26 | items: |
| 27 | type: string |
| 28 | '401': |
| 29 | description: Unauthorized |
| 30 | '403': |
| 31 | description: Forbidden |
| 32 | '404': |
| 33 | description: Not Found |
| 34 | deprecated: false |
| 35 | '/A1-EI/v1/eitypes/{eiTypeId}': |
| 36 | get: |
| 37 | tags: |
| 38 | - A1-E Enrichment Data Consumer API |
| 39 | summary: Definitions for an individual EI Type |
| 40 | description: Query EI type |
| 41 | operationId: getEiTypeUsingGET |
| 42 | produces: |
| 43 | - application/json |
| 44 | parameters: |
| 45 | - name: eiTypeId |
| 46 | in: path |
| 47 | description: eiTypeId |
| 48 | required: true |
| 49 | type: string |
| 50 | responses: |
| 51 | '200': |
| 52 | description: EI type |
| 53 | schema: |
| 54 | $ref: '#/definitions/ei_type_info' |
| 55 | '401': |
| 56 | description: Unauthorized |
| 57 | '403': |
| 58 | description: Forbidden |
| 59 | '404': |
| 60 | description: Enrichment Information type is not found |
| 61 | schema: |
| 62 | $ref: '#/definitions/error_information' |
| 63 | deprecated: false |
| 64 | '/A1-EI/v1/eitypes/{eiTypeId}/eijobs': |
| 65 | get: |
| 66 | tags: |
| 67 | - A1-E Enrichment Data Consumer API |
| 68 | summary: Query EI job identifiers |
| 69 | description: Returns the identifiers for an EI Type |
| 70 | operationId: getEiJobIdsUsingGET |
| 71 | produces: |
| 72 | - application/json |
| 73 | parameters: |
| 74 | - name: eiTypeId |
| 75 | in: path |
| 76 | description: eiTypeId |
| 77 | required: true |
| 78 | type: string |
| 79 | - in: body |
| 80 | name: owner |
| 81 | description: identifies the owner of the job |
| 82 | required: false |
| 83 | schema: |
| 84 | type: string |
| 85 | responses: |
| 86 | '200': |
| 87 | description: EI type |
| 88 | schema: |
| 89 | type: array |
| 90 | items: |
| 91 | type: string |
| 92 | '401': |
| 93 | description: Unauthorized |
| 94 | '403': |
| 95 | description: Forbidden |
| 96 | '404': |
| 97 | description: Enrichment Information type is not found |
| 98 | schema: |
| 99 | $ref: '#/definitions/error_information' |
| 100 | deprecated: false |
| 101 | '/A1-EI/v1/eitypes/{eiTypeId}/eijobs/{eiJobId}': |
| 102 | get: |
| 103 | tags: |
| 104 | - A1-E Enrichment Data Consumer API |
| 105 | summary: Individual EI Job |
| 106 | operationId: getIndividualEiJobUsingGET |
| 107 | produces: |
| 108 | - application/json |
| 109 | parameters: |
| 110 | - name: eiJobId |
| 111 | in: path |
| 112 | description: eiJobId |
| 113 | required: true |
| 114 | type: string |
| 115 | - name: eiTypeId |
| 116 | in: path |
| 117 | description: eiTypeId |
| 118 | required: true |
| 119 | type: string |
| 120 | responses: |
| 121 | '200': |
| 122 | description: EI Job |
| 123 | schema: |
| 124 | $ref: '#/definitions/ei_job_info' |
| 125 | '401': |
| 126 | description: Unauthorized |
| 127 | '403': |
| 128 | description: Forbidden |
| 129 | '404': |
| 130 | description: Enrichment Information type or job is not found |
| 131 | schema: |
| 132 | $ref: '#/definitions/error_information' |
| 133 | deprecated: false |
| 134 | put: |
| 135 | tags: |
| 136 | - A1-E Enrichment Data Consumer API |
| 137 | summary: Individual EI Job |
| 138 | description: Create or update an EI Job |
| 139 | operationId: putIndividualEiJobUsingPUT |
| 140 | consumes: |
| 141 | - application/json |
| 142 | produces: |
| 143 | - application/json |
| 144 | parameters: |
| 145 | - name: eiJobId |
| 146 | in: path |
| 147 | description: eiJobId |
| 148 | required: true |
| 149 | type: string |
| 150 | - in: body |
| 151 | name: eiJobInfo |
| 152 | description: eiJobInfo |
| 153 | required: true |
| 154 | schema: |
| 155 | $ref: '#/definitions/ei_job_info' |
| 156 | - name: eiTypeId |
| 157 | in: path |
| 158 | description: eiTypeId |
| 159 | required: true |
| 160 | type: string |
| 161 | responses: |
| 162 | '200': |
| 163 | description: Job updated |
| 164 | schema: |
| 165 | type: object |
| 166 | '201': |
| 167 | description: Job created |
| 168 | schema: |
| 169 | type: object |
| 170 | '401': |
| 171 | description: Unauthorized |
| 172 | '403': |
| 173 | description: Forbidden |
| 174 | '404': |
| 175 | description: Enrichment Information type is not found |
| 176 | schema: |
| 177 | $ref: '#/definitions/error_information' |
| 178 | deprecated: false |
| 179 | delete: |
| 180 | tags: |
| 181 | - A1-E Enrichment Data Consumer API |
| 182 | summary: Individual EI Job |
| 183 | description: Delete an EI job |
| 184 | operationId: deleteIndividualEiJobUsingDELETE |
| 185 | produces: |
| 186 | - application/json |
| 187 | parameters: |
| 188 | - name: eiJobId |
| 189 | in: path |
| 190 | description: eiJobId |
| 191 | required: true |
| 192 | type: string |
| 193 | - name: eiTypeId |
| 194 | in: path |
| 195 | description: eiTypeId |
| 196 | required: true |
| 197 | type: string |
| 198 | responses: |
| 199 | '200': |
| 200 | description: Not used |
| 201 | schema: |
| 202 | type: object |
| 203 | '204': |
| 204 | description: Job deleted |
| 205 | schema: |
| 206 | type: object |
| 207 | '401': |
| 208 | description: Unauthorized |
| 209 | '403': |
| 210 | description: Forbidden |
| 211 | '404': |
| 212 | description: Enrichment Information type or job is not found |
| 213 | schema: |
| 214 | $ref: '#/definitions/error_information' |
| 215 | deprecated: false |
| 216 | '/A1-EI/v1/eitypes/{eiTypeId}/eijobs/{eiJobId}/status': |
| 217 | get: |
| 218 | tags: |
| 219 | - A1-E Enrichment Data Consumer API |
| 220 | summary: EI Job status |
| 221 | operationId: getEiJobStatusUsingGET |
| 222 | produces: |
| 223 | - application/json |
| 224 | parameters: |
| 225 | - name: eiJobId |
| 226 | in: path |
| 227 | description: eiJobId |
| 228 | required: true |
| 229 | type: string |
| 230 | - name: eiTypeId |
| 231 | in: path |
| 232 | description: eiTypeId |
| 233 | required: true |
| 234 | type: string |
| 235 | responses: |
| 236 | '200': |
| 237 | description: EI Job status |
| 238 | schema: |
| 239 | $ref: '#/definitions/ei_job_status' |
| 240 | '401': |
| 241 | description: Unauthorized |
| 242 | '403': |
| 243 | description: Forbidden |
| 244 | '404': |
| 245 | description: Enrichment Information type or job is not found |
| 246 | schema: |
| 247 | $ref: '#/definitions/error_information' |
| 248 | deprecated: false |
| 249 | definitions: |
| 250 | ei_job_info: |
| 251 | type: object |
| 252 | properties: |
| 253 | job_data: |
| 254 | type: object |
| 255 | description: EI Type specific job data |
| 256 | owner: |
| 257 | type: string |
| 258 | description: Identity of the owner of the job |
| 259 | result_target: |
| 260 | type: string |
| 261 | description: the deliver information for the EI. This is typically a URL. |
| 262 | title: ei_job_info |
| 263 | description: Information for a Enrichment Information Job |
| 264 | ei_job_status: |
| 265 | type: object |
| 266 | properties: |
| 267 | operational_state: |
| 268 | type: string |
| 269 | description: |- |
| 270 | Operational state, values: |
| 271 | ENABLED: TBD |
| 272 | DISABLED: TBD. |
| 273 | enum: |
| 274 | - ENABLED |
| 275 | - DISABLED |
| 276 | title: ei_job_status |
| 277 | description: Status for an EI Job |
| 278 | ei_type_info: |
| 279 | type: object |
| 280 | properties: |
| 281 | job_data_schema: |
| 282 | type: object |
| 283 | description: Json schema for the job data |
| 284 | title: ei_type_info |
| 285 | description: Information for an EI type |
| 286 | error_information: |
| 287 | type: object |
| 288 | properties: |
| 289 | detail: |
| 290 | type: string |
| 291 | example: EI job type not found |
| 292 | description: ' A human-readable explanation specific to this occurrence of the problem.' |
| 293 | status: |
| 294 | type: integer |
| 295 | format: int32 |
| 296 | example: 503 |
| 297 | description: 'The HTTP status code generated by the origin server for this occurrence of the problem. ' |
| 298 | title: error_information |
| 299 | description: 'Problem as defined in https://tools.ietf.org/html/rfc7807' |
| 300 | |