cps-ncmp-rest/docs/openapi/openapi.yml

   1 #  ============LICENSE_START=======================================================
   2 #  Copyright (C) 2021-2023 Nordix Foundation
   3 #  Modifications Copyright (C) 2021 Pantheon.tech
   4 #  Modifications Copyright (C) 2021 Bell Canada
   5 #  ================================================================================
   6 #  Licensed under the Apache License, Version 2.0 (the "License");
   7 #  you may not use this file except in compliance with the License.
   8 #  You may obtain a copy of the License at
   9 #
  10 #        http://www.apache.org/licenses/LICENSE-2.0
  11 #
  12 #  Unless required by applicable law or agreed to in writing, software
  13 #  distributed under the License is distributed on an "AS IS" BASIS,
  14 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15 #  See the License for the specific language governing permissions and
  16 #  limitations under the License.
  17 #
  18 #  SPDX-License-Identifier: Apache-2.0
  19 #  ============LICENSE_END=========================================================
  20
  21 openapi: 3.0.1
  22 info:
  23   title: NCMP to CPS Proxy API
  24   description: NCMP to CPS Proxy API
  25   version: "1.0"
  26 servers:
  27   - url: /ncmp
  28 components:
  29   securitySchemes:
  30     basicAuth:
  31       type: http
  32       scheme: basic
  33 paths:
  34   /v1/ch/{cm-handle}/data/ds/{datastore-name}:
  35     $ref: 'ncmp.yml#/resourceDataForCmHandle'
  36
  37   /v1/data:
  38     $ref: 'ncmp.yml#/dataOperationForCmHandle'
  39
  40   /v1/ch/{cm-handle}/data/ds/{datastore-name}/query:
  41     $ref: 'ncmp.yml#/queryResourceDataForCmHandle'
  42
  43   /v1/ch/{cm-handle}/modules:
  44     $ref: 'ncmp.yml#/fetchModuleReferencesByCmHandle'
  45
  46   /v1/ch/{cm-handle}/modules/definitions:
  47     $ref: 'ncmp.yml#/fetchModuleDefinitionsByCmHandle'
  48
  49   /v1/ch/searches:
  50     $ref: 'ncmp.yml#/searchCmHandles'
  51
  52   /v1/ch/{cm-handle}:
  53     $ref: 'ncmp.yml#/retrieveCmHandleDetailsById'
  54
  55   /v1/ch/{cm-handle}/properties:
  56     $ref: 'ncmp.yml#/getCmHandlePropertiesById'
  57
  58   /v1/ch/id-searches:
  59     $ref: 'ncmp.yml#/searchCmHandleIds'
  60
  61   /v1/ch/{cm-handle}/state:
  62     $ref: 'ncmp.yml#/getCmHandleStateById'
  63
  64   /v1/ch/{cm-handle}/data-sync:
  65     $ref: 'ncmp.yml#/setDataSyncEnabledFlag'
  66 security:
  67   - basicAuth: []