[NCMP] Add Basic Auth to OpenAPI Definitions
[cps.git] / cps-ncmp-rest / docs / openapi / openapi-inventory.yml
1 #  ============LICENSE_START=======================================================
2 #  Copyright (C) 2021 Bell Canada
3 #  Modifications Copyright (C) 2022 Nordix Foundation
4 #  ================================================================================
5 #  Licensed under the Apache License, Version 2.0 (the "License");
6 #  you may not use this file except in compliance with the License.
7 #  You may obtain a copy of the License at
8 #
9 #        http://www.apache.org/licenses/LICENSE-2.0
10 #
11 #  Unless required by applicable law or agreed to in writing, software
12 #  distributed under the License is distributed on an "AS IS" BASIS,
13 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 #  See the License for the specific language governing permissions and
15 #  limitations under the License.
16 #
17 #  SPDX-License-Identifier: Apache-2.0
18 #  ============LICENSE_END=========================================================
19
20 openapi: 3.0.1
21 info:
22   title: NCMP Inventory API
23   description: NCMP Inventory API
24   version: "1.0"
25 servers:
26   - url: /ncmpInventory
27 components:
28   securitySchemes:
29     basicAuth:
30       type: http
31       scheme: basic
32 paths:
33   /v1/ch:
34     $ref: 'ncmp-inventory.yml#/updateDmiRegistration'
35
36   /v1/ch/cmHandles:
37     $ref: 'ncmp-inventory.yml#/getAllCmHandleIdsForRegisteredDmi'
38 security:
39   - basicAuth: []