| elinuxhenrik | e30dbe3 | 2022-02-28 16:10:48 +0100 | [diff] [blame^] | 1 | definitions: |
| 2 | "": |
| 3 | properties: |
| 4 | registeredStatus: |
| 5 | description: The registration status of the producer in Information Coordinator |
| 6 | Service. Either `registered` or `not registered` |
| 7 | example: registered |
| 8 | type: string |
| 9 | type: object |
| 10 | BufferTimeout: |
| 11 | properties: |
| 12 | maxSize: |
| 13 | type: integer |
| 14 | maxTimeMiliseconds: |
| 15 | type: integer |
| 16 | type: object |
| 17 | ErrorInfo: |
| 18 | properties: |
| 19 | detail: |
| 20 | description: A human-readable explanation specific to this occurrence of the |
| 21 | problem. |
| 22 | example: Info job type not found |
| 23 | type: string |
| 24 | instance: |
| 25 | description: A URI reference that identifies the specific occurrence of the |
| 26 | problem. |
| 27 | type: string |
| 28 | status: |
| 29 | description: The HTTP status code generated by the origin server for this |
| 30 | occurrence of the problem. |
| 31 | example: 400 |
| 32 | type: integer |
| 33 | title: |
| 34 | description: A short, human-readable summary of the problem type. |
| 35 | type: string |
| 36 | type: |
| 37 | description: A URI reference that identifies the problem type. |
| 38 | type: string |
| 39 | type: object |
| 40 | JobInfo: |
| 41 | properties: |
| 42 | info_job_data: |
| 43 | $ref: '#/definitions/Parameters' |
| 44 | info_job_identity: |
| 45 | type: string |
| 46 | info_type_identity: |
| 47 | type: string |
| 48 | last_updated: |
| 49 | type: string |
| 50 | owner: |
| 51 | type: string |
| 52 | target_uri: |
| 53 | type: string |
| 54 | type: object |
| 55 | Parameters: |
| 56 | properties: |
| 57 | bufferTimeout: |
| 58 | $ref: '#/definitions/BufferTimeout' |
| 59 | type: object |
| 60 | info: |
| 61 | contact: {} |
| 62 | license: |
| 63 | name: Apache 2.0 |
| 64 | url: http://www.apache.org/licenses/LICENSE-2.0.html |
| 65 | title: DMaaP Mediator Producer |
| 66 | version: 1.1.0 |
| 67 | paths: |
| 68 | /admin/log: |
| 69 | put: |
| 70 | description: Set the log level of the producer. |
| 71 | parameters: |
| 72 | - description: string enums |
| 73 | enum: |
| 74 | - Error |
| 75 | - Warn |
| 76 | - Info |
| 77 | - Debug |
| 78 | in: query |
| 79 | name: level |
| 80 | type: string |
| 81 | responses: |
| 82 | "200": |
| 83 | description: "" |
| 84 | "400": |
| 85 | description: Problem as defined in https://tools.ietf.org/html/rfc7807 |
| 86 | headers: |
| 87 | Content-Type: |
| 88 | description: application/problem+json |
| 89 | type: string |
| 90 | schema: |
| 91 | $ref: '#/definitions/ErrorInfo' |
| 92 | summary: Set log level |
| 93 | tags: |
| 94 | - Admin |
| 95 | /health_check: |
| 96 | get: |
| 97 | description: Get the status of the producer. Will show if the producer has registered |
| 98 | in ICS. |
| 99 | produces: |
| 100 | - application/json |
| 101 | responses: |
| 102 | "200": |
| 103 | description: OK |
| 104 | schema: |
| 105 | $ref: '#/definitions/' |
| 106 | summary: Get status |
| 107 | tags: |
| 108 | - Data producer (callbacks) |
| 109 | /info_job: |
| 110 | post: |
| 111 | consumes: |
| 112 | - application/json |
| 113 | description: Callback for ICS to add an info job |
| 114 | parameters: |
| 115 | - description: Info job data |
| 116 | in: body |
| 117 | name: user |
| 118 | required: true |
| 119 | schema: |
| 120 | $ref: '#/definitions/JobInfo' |
| 121 | responses: |
| 122 | "200": |
| 123 | description: "" |
| 124 | "400": |
| 125 | description: Problem as defined in https://tools.ietf.org/html/rfc7807 |
| 126 | headers: |
| 127 | Content-Type: |
| 128 | description: application/problem+json |
| 129 | type: string |
| 130 | schema: |
| 131 | $ref: '#/definitions/ErrorInfo' |
| 132 | summary: Add info job |
| 133 | tags: |
| 134 | - Data producer (callbacks) |
| 135 | /info_job/{infoJobId}: |
| 136 | delete: |
| 137 | description: Callback for ICS to delete an info job |
| 138 | parameters: |
| 139 | - description: Info job ID |
| 140 | in: path |
| 141 | name: infoJobId |
| 142 | required: true |
| 143 | type: string |
| 144 | responses: |
| 145 | "200": |
| 146 | description: "" |
| 147 | summary: Delete info job |
| 148 | tags: |
| 149 | - Data producer (callbacks) |
| 150 | /swagger: |
| 151 | get: |
| 152 | description: Get the Swagger API documentation for the producer. |
| 153 | responses: |
| 154 | "200": |
| 155 | description: "" |
| 156 | summary: Get Swagger Documentation |
| 157 | tags: |
| 158 | - Admin |
| 159 | swagger: "2.0" |