core/sliapi/model/swagger/src/main/yaml/sliapi.yaml

   1 ---
   2 swagger: "2.0"
   3 info:
   4   description: "Defines API to service logic interpreter,This module contains a collection\
   5     \ of generally useful derived\nYANG data types.\n\nCopyright (c) 2013 IETF Trust\
   6     \ and the persons identified as\nauthors of the code.  All rights reserved.\n\n\
   7     Redistribution and use in source and binary forms, with or\nwithout modification,\
   8     \ is permitted pursuant to, and subject\nto the license terms contained in, the\
   9     \ Simplified BSD License\nset forth in Section 4.c of the IETF Trust's Legal Provisions\n\
  10     Relating to IETF Documents\n(http://trustee.ietf.org/license-info).\n\nThis version\
  11     \ of this YANG module is part of RFC 6991; see\nthe RFC itself for full legal\
  12     \ notices.,This module contains a collection of generally useful derived\nYANG\
  13     \ data types for Internet addresses and related things.\n\nCopyright (c) 2013\
  14     \ IETF Trust and the persons identified as\nauthors of the code.  All rights reserved.\n\
  15     \nRedistribution and use in source and binary forms, with or\nwithout modification,\
  16     \ is permitted pursuant to, and subject\nto the license terms contained in, the\
  17     \ Simplified BSD License\nset forth in Section 4.c of the IETF Trust's Legal Provisions\n\
  18     Relating to IETF Documents\n(http://trustee.ietf.org/license-info).\n\nThis version\
  19     \ of this YANG module is part of RFC 6991; see\nthe RFC itself for full legal\
  20     \ notices."
  21   version: "1.2.0-SNAPSHOT"
  22   title: "SLI-API,ietf-yang-types,ietf-inet-types API"
  23 consumes:
  24 - "application/json"
  25 - "application/xml"
  26 produces:
  27 - "application/json"
  28 - "application/xml"
  29 paths:
  30   /config/SLI-API:test-results/:
  31     get:
  32       tags:
  33       - "SLI-API"
  34       description: "returns sli.api.TestResults"
  35       parameters: []
  36       responses:
  37         400:
  38           description: "Internal error"
  39         200:
  40           description: "sli.api.TestResults"
  41           schema:
  42             originalRef: "#/definitions/sli.api.TestResults"
  43             $ref: "#/definitions/sli.api.TestResults"
  44           responseSchema:
  45             originalRef: "#/definitions/sli.api.TestResults"
  46             $ref: "#/definitions/sli.api.TestResults"
  47     post:
  48       tags:
  49       - "SLI-API"
  50       description: "creates sli.api.TestResults"
  51       parameters:
  52       - in: "body"
  53         name: "sli.api.TestResults.body-param"
  54         description: "sli.api.TestResults to be added to list"
  55         required: false
  56         schema:
  57           originalRef: "#/definitions/sli.api.TestResults"
  58           $ref: "#/definitions/sli.api.TestResults"
  59       responses:
  60         400:
  61           description: "Internal error"
  62         201:
  63           description: "Object created"
  64         409:
  65           description: "Object already exists"
  66     put:
  67       tags:
  68       - "SLI-API"
  69       description: "creates or updates sli.api.TestResults"
  70       parameters:
  71       - in: "body"
  72         name: "sli.api.TestResults.body-param"
  73         description: "sli.api.TestResults to be added or updated"
  74         required: false
  75         schema:
  76           originalRef: "#/definitions/sli.api.TestResults"
  77           $ref: "#/definitions/sli.api.TestResults"
  78       responses:
  79         400:
  80           description: "Internal error"
  81         201:
  82           description: "Object created"
  83         204:
  84           description: "Object modified"
  85     delete:
  86       tags:
  87       - "SLI-API"
  88       description: "removes sli.api.TestResults"
  89       parameters: []
  90       responses:
  91         400:
  92           description: "Internal error"
  93         204:
  94           description: "Object deleted"
  95   /config/SLI-API:test-results/SLI-API:test-result/:
  96     post:
  97       description: "creates sli.api.testresults.TestResult"
  98       parameters:
  99       - in: "body"
 100         name: "sli.api.testresults.TestResult.body-param"
 101         description: "sli.api.testresults.TestResult to be added to list"
 102         required: false
 103         schema:
 104           originalRef: "#/definitions/sli.api.testresults.TestResult"
 105           $ref: "#/definitions/sli.api.testresults.TestResult"
 106       responses:
 107         400:
 108           description: "Internal error"
 109         201:
 110           description: "Object created"
 111         409:
 112           description: "Object already exists"
 113   /config/SLI-API:test-results/SLI-API:test-result/{test-identifier}/:
 114     get:
 115       tags:
 116       - "SLI-API"
 117       description: "returns sli.api.testresults.TestResult"
 118       parameters:
 119       - name: "test-identifier"
 120         in: "path"
 121         description: "Id of test-result"
 122         required: true
 123         type: "string"
 124       responses:
 125         400:
 126           description: "Internal error"
 127         200:
 128           description: "sli.api.testresults.TestResult"
 129           schema:
 130             originalRef: "#/definitions/sli.api.testresults.TestResult"
 131             $ref: "#/definitions/sli.api.testresults.TestResult"
 132           responseSchema:
 133             originalRef: "#/definitions/sli.api.testresults.TestResult"
 134             $ref: "#/definitions/sli.api.testresults.TestResult"
 135     post:
 136       tags:
 137       - "SLI-API"
 138       description: "creates sli.api.testresults.TestResult"
 139       parameters:
 140       - name: "test-identifier"
 141         in: "path"
 142         description: "Id of test-result"
 143         required: true
 144         type: "string"
 145       - in: "body"
 146         name: "sli.api.testresults.TestResult.body-param"
 147         description: "sli.api.testresults.TestResult to be added to list"
 148         required: false
 149         schema:
 150           originalRef: "#/definitions/sli.api.testresults.TestResult"
 151           $ref: "#/definitions/sli.api.testresults.TestResult"
 152       responses:
 153         400:
 154           description: "Internal error"
 155         201:
 156           description: "Object created"
 157         409:
 158           description: "Object already exists"
 159     put:
 160       tags:
 161       - "SLI-API"
 162       description: "creates or updates sli.api.testresults.TestResult"
 163       parameters:
 164       - name: "test-identifier"
 165         in: "path"
 166         description: "Id of test-result"
 167         required: true
 168         type: "string"
 169       - in: "body"
 170         name: "sli.api.testresults.TestResult.body-param"
 171         description: "sli.api.testresults.TestResult to be added or updated"
 172         required: false
 173         schema:
 174           originalRef: "#/definitions/sli.api.testresults.TestResult"
 175           $ref: "#/definitions/sli.api.testresults.TestResult"
 176       responses:
 177         400:
 178           description: "Internal error"
 179         201:
 180           description: "Object created"
 181         204:
 182           description: "Object modified"
 183     delete:
 184       tags:
 185       - "SLI-API"
 186       description: "removes sli.api.testresults.TestResult"
 187       parameters:
 188       - name: "test-identifier"
 189         in: "path"
 190         description: "Id of test-result"
 191         required: true
 192         type: "string"
 193       responses:
 194         400:
 195           description: "Internal error"
 196         204:
 197           description: "Object deleted"
 198   /operational/SLI-API:test-results/:
 199     get:
 200       tags:
 201       - "SLI-API"
 202       description: "returns sli.api.TestResults"
 203       parameters: []
 204       responses:
 205         400:
 206           description: "Internal error"
 207         200:
 208           description: "sli.api.TestResults"
 209           schema:
 210             originalRef: "#/definitions/sli.api.TestResults"
 211             $ref: "#/definitions/sli.api.TestResults"
 212           responseSchema:
 213             originalRef: "#/definitions/sli.api.TestResults"
 214             $ref: "#/definitions/sli.api.TestResults"
 215   /operational/SLI-API:test-results/SLI-API:test-result/{test-identifier}/:
 216     get:
 217       tags:
 218       - "SLI-API"
 219       description: "returns sli.api.testresults.TestResult"
 220       parameters:
 221       - name: "test-identifier"
 222         in: "path"
 223         description: "Id of test-result"
 224         required: true
 225         type: "string"
 226       responses:
 227         400:
 228           description: "Internal error"
 229         200:
 230           description: "sli.api.testresults.TestResult"
 231           schema:
 232             originalRef: "#/definitions/sli.api.testresults.TestResult"
 233             $ref: "#/definitions/sli.api.testresults.TestResult"
 234           responseSchema:
 235             originalRef: "#/definitions/sli.api.testresults.TestResult"
 236             $ref: "#/definitions/sli.api.testresults.TestResult"
 237   /operations/SLI-API:execute-graph/:
 238     post:
 239       tags:
 240       - "SLI-API"
 241       parameters:
 242       - in: "body"
 243         name: "sli.api.executegraph.Input.body-param"
 244         required: false
 245         schema:
 246           properties:
 247             input:
 248               originalRef: "#/definitions/sli.api.executegraph.Input"
 249               $ref: "#/definitions/sli.api.executegraph.Input"
 250       responses:
 251         400:
 252           description: "Internal error"
 253         200:
 254           description: "Correct response"
 255           schema:
 256             originalRef: "#/definitions/sli.api.ExecuteGraph"
 257             $ref: "#/definitions/sli.api.ExecuteGraph"
 258           responseSchema:
 259             originalRef: "#/definitions/sli.api.ExecuteGraph"
 260             $ref: "#/definitions/sli.api.ExecuteGraph"
 261         201:
 262           description: "No response"
 263   /operations/SLI-API:healthcheck/:
 264     post:
 265       tags:
 266       - "SLI-API"
 267       parameters: []
 268       responses:
 269         400:
 270           description: "Internal error"
 271         200:
 272           description: "Correct response"
 273           schema:
 274             originalRef: "#/definitions/sli.api.Healthcheck"
 275             $ref: "#/definitions/sli.api.Healthcheck"
 276           responseSchema:
 277             originalRef: "#/definitions/sli.api.Healthcheck"
 278             $ref: "#/definitions/sli.api.Healthcheck"
 279         201:
 280           description: "No response"
 281   /operations/SLI-API:vlbcheck/:
 282     post:
 283       tags:
 284       - "SLI-API"
 285       parameters: []
 286       responses:
 287         400:
 288           description: "Internal error"
 289         200:
 290           description: "Correct response"
 291           schema:
 292             originalRef: "#/definitions/sli.api.Vlbcheck"
 293             $ref: "#/definitions/sli.api.Vlbcheck"
 294           responseSchema:
 295             originalRef: "#/definitions/sli.api.Vlbcheck"
 296             $ref: "#/definitions/sli.api.Vlbcheck"
 297         201:
 298           description: "No response"
 299 definitions:
 300   sli.api.ExecuteGraph:
 301     type: "object"
 302     properties:
 303       output:
 304         originalRef: "#/definitions/sli.api.ResponseFields"
 305         $ref: "#/definitions/sli.api.ResponseFields"
 306   sli.api.Healthcheck:
 307     type: "object"
 308     properties:
 309       output:
 310         originalRef: "#/definitions/sli.api.ResponseFields"
 311         $ref: "#/definitions/sli.api.ResponseFields"
 312   sli.api.ModeEnumeration:
 313     type: "string"
 314     enum:
 315     - "sync"
 316     - "async"
 317   sli.api.ParameterSetting:
 318     type: "object"
 319     properties:
 320       string-value:
 321         type: "string"
 322       boolean-value:
 323         type: "boolean"
 324       parameter-name:
 325         type: "string"
 326         description: "Parameter name"
 327       int-value:
 328         type: "integer"
 329         format: "int32"
 330   sli.api.ResponseFields:
 331     type: "object"
 332     properties:
 333       response-code:
 334         type: "string"
 335       response-message:
 336         type: "string"
 337       context-memory-json:
 338         type: "string"
 339       ack-final-indicator:
 340         type: "string"
 341   sli.api.TestResults:
 342     type: "object"
 343     properties:
 344       test-result:
 345         type: "array"
 346         items:
 347           originalRef: "#/definitions/sli.api.testresults.TestResult"
 348           $ref: "#/definitions/sli.api.testresults.TestResult"
 349   sli.api.Vlbcheck:
 350     type: "object"
 351     properties:
 352       output:
 353         originalRef: "#/definitions/sli.api.ResponseFields"
 354         $ref: "#/definitions/sli.api.ResponseFields"
 355   sli.api.executegraph.Input:
 356     type: "object"
 357     properties:
 358       mode:
 359         originalRef: "#/definitions/sli.api.ModeEnumeration"
 360         $ref: "#/definitions/sli.api.ModeEnumeration"
 361       module-name:
 362         type: "string"
 363       sli-parameter:
 364         type: "array"
 365         items:
 366           originalRef: "#/definitions/sli.api.ParameterSetting"
 367           $ref: "#/definitions/sli.api.ParameterSetting"
 368       rpc-name:
 369         type: "string"
 370   sli.api.testresults.TestResult:
 371     type: "object"
 372     properties:
 373       results:
 374         type: "array"
 375         items:
 376           type: "string"
 377       test-identifier:
 378         type: "string"