@itentialopensource/adapter-nokia_nsp_device_administrator 0.1.4 → 0.2.0

package/report/adapter-openapi.yaml

@@ -0,0 +1,870 @@
+openapi: 3.0.0
+info:
+  title: 'Device Administrator API Reference '
+  description: '[A brief sandbox description of the NSP Application and its REST interfaces]<br /><br />For access authorization and authentication for sandbox, see <a href="auth.html">REST API Authentication</a>.<br />'
+  contact: {}
+  version: '1.0'
+servers:
+- url: https://145.40.97.58:8548/mdm-necontrol-rest-api-app/api
+  variables: {}
+paths:
+  /neControl/discover/alarmDictionaryChecker/{alarmDictName}:
+    post:
+      tags:
+      - ne-control-discovery
+      summary: alarmDictionaryCheckerUsingPOST
+      description: alarmDictionaryChecker
+      operationId: alarmDictionaryCheckerUsingPOST
+      parameters:
+      - name: alarmDictName
+        in: path
+        description: alarmDictName
+        required: true
+        style: simple
+        schema:
+          type: string
+      requestBody:
+        description: aInAlarmDictionaryCheckerInfo
+        content:
+          application/json:
+            schema:
+              type: string
+              description: aInAlarmDictionaryCheckerInfo
+        required: true
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            '*/*':
+              schema: {}
+      deprecated: false
+      security:
+      - RESTToken:
+        - global
+  /neControl/discover/discoverNes:
+    post:
+      tags:
+      - ne-control-discovery
+      summary: discoverNesUsingPOST
+      description: discoverNes
+      operationId: discoverNesUsingPOST
+      parameters: []
+      requestBody:
+        description: discRuleJson
+        content:
+          application/json:
+            schema:
+              type: object
+              description: discRuleJson
+        required: true
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ResponseDatastring'
+      deprecated: false
+      security:
+      - RESTToken:
+        - global
+  /neControl/discover/listNes:
+    get:
+      tags:
+      - ne-control-discovery
+      summary: listDiscoveredNesUsingGET
+      description: listDiscoveredNes
+      operationId: listDiscoveredNesUsingGET
+      parameters: []
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            '*/*':
+              schema: {}
+      deprecated: false
+      security:
+      - RESTToken:
+        - global
+  /neControl/discover/{fdn}/fullresync/:
+    put:
+      tags:
+      - ne-control-discovery
+      summary: fullNeResyncUsingPUT
+      description: fullNeResync
+      operationId: fullNeResyncUsingPUT
+      parameters:
+      - name: fdn
+        in: path
+        description: fdn
+        required: true
+        style: simple
+        schema:
+          type: string
+      - name: Content-Type
+        in: header
+        description: ''
+        required: true
+        style: simple
+        schema:
+          $ref: '#/components/schemas/Content-Type'
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ResponseDatastring'
+      deprecated: false
+      security:
+      - RESTToken:
+        - global
+  /neControl/discover/{fdn}/nes/:
+    post:
+      tags:
+      - ne-control-discovery
+      summary: discoverNesUsingPOST_1
+      description: discoverNes
+      operationId: discoverNesUsingPOST_1
+      parameters:
+      - name: fdn
+        in: path
+        description: fdn
+        required: true
+        style: simple
+        schema:
+          type: string
+      - name: Content-Type
+        in: header
+        description: ''
+        required: true
+        style: simple
+        schema:
+          $ref: '#/components/schemas/Content-Type'
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ResponseDataJsonNode'
+      deprecated: false
+      security:
+      - RESTToken:
+        - global
+  /neControl/discover/{fdn}/unmanage/:
+    put:
+      tags:
+      - ne-control-discovery
+      summary: unmanageNesUsingPUT
+      description: unmanageNes
+      operationId: unmanageNesUsingPUT
+      parameters:
+      - name: fdn
+        in: path
+        description: fdn
+        required: true
+        style: simple
+        schema:
+          type: string
+      - name: Content-Type
+        in: header
+        description: ''
+        required: true
+        style: simple
+        schema:
+          $ref: '#/components/schemas/Content-Type'
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ResponseDatastring'
+      deprecated: false
+      security:
+      - RESTToken:
+        - global
+  /neControl/discoveryrule:
+    post:
+      tags:
+      - ne-control-discovery-rule
+      summary: createUsingPOST
+      description: create
+      operationId: createUsingPOST
+      parameters: []
+      requestBody:
+        description: aInJson
+        content:
+          application/json:
+            schema:
+              type: object
+              description: aInJson
+        required: true
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ResponseDataJsonNode'
+      deprecated: false
+      security:
+      - RESTToken:
+        - global
+  /neControl/discoveryrule/addAll/{fdn}/:
+    put:
+      tags:
+      - ne-control-discovery-rule
+      summary: addAllUsingPUT
+      description: addAll
+      operationId: addAllUsingPUT
+      parameters:
+      - name: fdn
+        in: path
+        description: fdn
+        required: true
+        style: simple
+        schema:
+          type: string
+      requestBody:
+        description: aInJson
+        content:
+          application/json:
+            schema:
+              type: object
+              description: aInJson
+        required: true
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ResponseDataJsonNode'
+      deprecated: false
+      security:
+      - RESTToken:
+        - global
+  /neControl/discoveryrule/allDiscoveredNes:
+    get:
+      tags:
+      - ne-control-discovery-rule
+      summary: getAllDiscoveredNesUsingGET
+      description: getAllDiscoveredNes
+      operationId: getAllDiscoveredNesUsingGET
+      parameters: []
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            '*/*':
+              schema: {}
+      deprecated: false
+      security:
+      - RESTToken:
+        - global
+  /neControl/discoveryrule/detail/:
+    get:
+      tags:
+      - ne-control-discovery-rule
+      summary: findNeDiscoveryRuleByFDNUsingGET
+      description: findNeDiscoveryRuleByFDN
+      operationId: findNeDiscoveryRuleByFDNUsingGET
+      parameters:
+      - name: fdn
+        in: query
+        description: fdn
+        required: true
+        style: form
+        explode: true
+        schema:
+          type: string
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            '*/*':
+              schema: {}
+      deprecated: false
+      security:
+      - RESTToken:
+        - global
+  /neControl/discoveryrule/removeAll/{fdn}/:
+    put:
+      tags:
+      - ne-control-discovery-rule
+      summary: removeAllUsingPUT
+      description: removeAll
+      operationId: removeAllUsingPUT
+      parameters:
+      - name: fdn
+        in: path
+        description: fdn
+        required: true
+        style: simple
+        schema:
+          type: string
+      requestBody:
+        description: aInJson
+        content:
+          application/json:
+            schema:
+              type: object
+              description: aInJson
+        required: true
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ResponseDataJsonNode'
+      deprecated: false
+      security:
+      - RESTToken:
+        - global
+  /neControl/discoveryrule/{fdn}:
+    put:
+      tags:
+      - ne-control-discovery-rule
+      summary: updateUsingPUT
+      description: update
+      operationId: updateUsingPUT
+      parameters:
+      - name: fdn
+        in: path
+        description: fdn
+        required: true
+        style: simple
+        schema:
+          type: string
+      requestBody:
+        description: aInJson
+        content:
+          application/json:
+            schema:
+              type: object
+              description: aInJson
+        required: true
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ResponseDataJsonNode'
+      deprecated: false
+      security:
+      - RESTToken:
+        - global
+    delete:
+      tags:
+      - ne-control-discovery-rule
+      summary: deleteUsingDELETE
+      description: delete
+      operationId: deleteUsingDELETE
+      parameters:
+      - name: fdn
+        in: path
+        description: fdn
+        required: true
+        style: simple
+        schema:
+          type: string
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ResponseDataJsonNode'
+      deprecated: false
+      security:
+      - RESTToken:
+        - global
+  /neControl/discoveryrule/{fdn}/{requestType}/:
+    get:
+      tags:
+      - ne-control-discovery-rule
+      summary: getDataUsingGET
+      description: getData
+      operationId: getDataUsingGET
+      parameters:
+      - name: fdn
+        in: path
+        description: fdn
+        required: true
+        style: simple
+        schema:
+          type: string
+      - name: requestType
+        in: path
+        description: requestType
+        required: true
+        style: simple
+        schema:
+          type: string
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            '*/*':
+              schema: {}
+      deprecated: false
+      security:
+      - RESTToken:
+        - global
+  /nemediationpolicy:
+    post:
+      tags:
+      - ne-mediation-policy
+      summary: addPolicyUsingPOST
+      description: addPolicy
+      operationId: addPolicyUsingPOST
+      parameters: []
+      requestBody:
+        description: nePolicyJson
+        content:
+          application/json:
+            schema:
+              type: object
+              description: nePolicyJson
+        required: true
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ResponseDataJsonNode'
+      deprecated: false
+      security:
+      - RESTToken:
+        - global
+  /nemediationpolicy/{fdn}:
+    put:
+      tags:
+      - ne-mediation-policy
+      summary: updatePolicyUsingPUT
+      description: updatePolicy
+      operationId: updatePolicyUsingPUT
+      parameters:
+      - name: fdn
+        in: path
+        description: fdn
+        required: true
+        style: simple
+        schema:
+          type: string
+      requestBody:
+        description: nePolicyJson
+        content:
+          application/json:
+            schema:
+              type: object
+              description: nePolicyJson
+        required: true
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ResponseDataJsonNode'
+      deprecated: false
+      security:
+      - RESTToken:
+        - global
+    delete:
+      tags:
+      - ne-mediation-policy
+      summary: deletePolicyUsingDELETE
+      description: deletePolicy
+      operationId: deletePolicyUsingDELETE
+      parameters:
+      - name: fdn
+        in: path
+        description: fdn
+        required: true
+        style: simple
+        schema:
+          type: string
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ResponseDataJsonNode'
+      deprecated: false
+      security:
+      - RESTToken:
+        - global
+  /nemediationpolicy/{fdn}/detail/:
+    get:
+      tags:
+      - ne-mediation-policy
+      summary: getNesUsingGET
+      description: getNes
+      operationId: getNesUsingGET
+      parameters:
+      - name: fdn
+        in: path
+        description: fdn
+        required: true
+        style: simple
+        schema:
+          type: string
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            '*/*':
+              schema: {}
+      deprecated: false
+      security:
+      - RESTToken:
+        - global
+  /nemediationpolicy/{fdn}/getNes/{accessType}/:
+    get:
+      tags:
+      - ne-mediation-policy
+      summary: getNesUsingGET_1
+      description: getNes
+      operationId: getNesUsingGET_1
+      parameters:
+      - name: accessType
+        in: path
+        description: accessType
+        required: true
+        style: simple
+        schema:
+          type: string
+      - name: fdn
+        in: path
+        description: fdn
+        required: true
+        style: simple
+        schema:
+          type: string
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            '*/*':
+              schema: {}
+      deprecated: false
+      security:
+      - RESTToken:
+        - global
+  /nemediationpolicy/{neid}/policies:
+    get:
+      tags:
+      - ne-mediation-policy
+      summary: getPoliciesForReadOnlyNeUsingGET
+      description: getPoliciesForReadOnlyNe
+      operationId: getPoliciesForReadOnlyNeUsingGET
+      parameters:
+      - name: neid
+        in: path
+        description: neid
+        required: true
+        style: simple
+        schema:
+          type: string
+      - name: type
+        in: query
+        description: type
+        style: form
+        explode: true
+        schema:
+          type: string
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            '*/*':
+              schema: {}
+      deprecated: false
+      security:
+      - RESTToken:
+        - global
+  /neprotocol:
+    post:
+      tags:
+      - ne-protocol
+      summary: addNeProtocolUsingPOST
+      description: addNeProtocol
+      operationId: addNeProtocolUsingPOST
+      parameters: []
+      requestBody:
+        description: neUserJson
+        content:
+          application/json:
+            schema:
+              type: object
+              description: neUserJson
+        required: true
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ResponseDataJsonNode'
+      deprecated: false
+      security:
+      - RESTToken:
+        - global
+    put:
+      tags:
+      - ne-protocol
+      summary: updateProtocolUsingPUT
+      description: updateProtocol
+      operationId: updateProtocolUsingPUT
+      parameters: []
+      requestBody:
+        description: neProtocolJson
+        content:
+          application/json:
+            schema:
+              type: object
+              description: neProtocolJson
+        required: true
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ResponseDataJsonNode'
+      deprecated: false
+      security:
+      - RESTToken:
+        - global
+  /neprotocol/{fdn}/:
+    delete:
+      tags:
+      - ne-protocol
+      summary: deletePolicyUsingDELETE_1
+      description: deletePolicy
+      operationId: deletePolicyUsingDELETE_1
+      parameters:
+      - name: fdn
+        in: path
+        description: fdn
+        required: true
+        style: simple
+        schema:
+          type: string
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ResponseDataJsonNode'
+      deprecated: false
+      security:
+      - RESTToken:
+        - global
+  /neuser:
+    post:
+      tags:
+      - ne-user
+      summary: addNeUserUsingPOST
+      description: Add NE User
+      operationId: addNeUserUsingPOST
+      parameters: []
+      requestBody:
+        description: neUserJson
+        content:
+          application/json:
+            schema:
+              type: object
+              description: neUserJson
+        required: true
+      responses:
+        '200':
+          description: Ne User created successfully
+          headers: {}
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ResponseDataJsonNode'
+      deprecated: false
+      security:
+      - RESTToken:
+        - global
+    put:
+      tags:
+      - ne-user
+      summary: updateNeUserUsingPUT
+      description: Update NE User
+      operationId: updateNeUserUsingPUT
+      parameters: []
+      requestBody:
+        description: neUserJson
+        content:
+          application/json:
+            schema:
+              type: object
+              description: neUserJson
+        required: true
+      responses:
+        '200':
+          description: Ne User Updated successfully
+          headers: {}
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ResponseDataJsonNode'
+      deprecated: false
+      security:
+      - RESTToken:
+        - global
+  /neuser/{fdn}/:
+    delete:
+      tags:
+      - ne-user
+      summary: deletePolicyUsingDELETE_2
+      description: Delete NE User
+      operationId: deletePolicyUsingDELETE_2
+      parameters:
+      - name: fdn
+        in: path
+        description: fdn
+        required: true
+        style: simple
+        schema:
+          type: string
+      responses:
+        '200':
+          description: Ne User Deleted successfully
+          headers: {}
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ResponseDataJsonNode'
+      deprecated: false
+      security:
+      - RESTToken:
+        - global
+components:
+  schemas:
+    ResponseDataJsonNode:
+      title: ResponseDataJsonNode
+      type: object
+      properties:
+        response:
+          $ref: '#/components/schemas/ResponseJsonNode'
+    ResponseDatastring:
+      title: ResponseDatastring
+      type: object
+      properties:
+        response:
+          $ref: '#/components/schemas/Responsestring'
+    ResponseJsonNode:
+      title: ResponseJsonNode
+      type: object
+      properties:
+        data:
+          type: object
+        endRow:
+          type: integer
+          format: int64
+        errors:
+          type: array
+          items:
+            type: object
+          description: ''
+        nextPage:
+          type: string
+          description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
+        previousPage:
+          type: string
+          description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
+        startRow:
+          type: integer
+          format: int64
+        status:
+          type: integer
+          format: int32
+        totalRows:
+          type: integer
+          format: int64
+    Responsestring:
+      title: Responsestring
+      type: object
+      properties:
+        data:
+          type: string
+        endRow:
+          type: integer
+          format: int64
+        errors:
+          type: array
+          items:
+            type: object
+          description: ''
+        nextPage:
+          type: string
+          description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
+        previousPage:
+          type: string
+          description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
+        startRow:
+          type: integer
+          format: int64
+        status:
+          type: integer
+          format: int32
+        totalRows:
+          type: integer
+          format: int64
+    Content-Type:
+      title: Content-Type
+      enum:
+      - application/json
+      type: string
+  securitySchemes:
+    RESTToken:
+      type: apiKey
+      name: Authorization
+      in: header
+security: []
+tags:
+- name: ne-control-discovery
+  description: Ne Control Discovery Rest Controller
+- name: ne-control-discovery-rule
+  description: Ne Discovery Rule Controller
+- name: ne-mediation-policy
+  description: Mediation Policy Controller
+- name: ne-protocol
+  description: 'Rest interface to access Mediation NE Protocol '
+- name: ne-user
+  description: Rest interface to access Mediation policy NeUser