docs/sections/apis/pmsh_swagger.yml

# ============LICENSE_START=======================================================
#  Copyright (C) 2020 Nordix Foundation.
# ================================================================================
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0
# ============LICENSE_END=========================================================

swagger: "2.0"
info:
  title: PM Subscription Handler Service
  version: "1.1.1"
  description: PM subscription handler enables control of performance management jobs on network functions in ONAP
produces:
  - "application/json"
basePath: "/"
schemes:
  - https
# Paths supported by the server application
paths:
  /subscriptions:
    get:
      description: >-
        Get all defined Subscriptions and their related Network Functions from ONAP.
      operationId: mod.api.controller.get_all_sub_to_nf_relations
      responses:
        200:
          description: OK; Array of subscriptions are returned as an object
          schema:
            type: array
            items:
              type: object
              properties:
                subscription_name:
                  type: string
                  description: Name of the Subscription
                subscription_status:
                  type: string
                  description: Status of the Subscription
                network_functions:
                  type: array
                  items:
                    type: object
                    properties:
                      nf_name:
                        type: string
                        description: Name of the Network Function
                      nf_sub_status:
                        type: string
                        description: Status of the Subscription on the Network Function
                      model_invariant_id:
                        type: string
                        description: The NF model-invariant-id defined in A&AI
                      model_version_id:
                        type: string
                        description: The NF model-version-id defined in A&AI
                      sdnc_model_name:
                        type: string
                        description: The sdnc_model_name (blueprint name) defined in A&AI
                      sdnc_model_version:
                        type: string
                        description: The sdnc_model_version (blueprint version) defined in A&AI
        401:
          description: Unauthorized
        403:
          description: Forbidden
        404:
          description: there are no subscriptions defined

  /healthcheck:
    get:
      operationId: mod.api.controller.status
      tags:
        - "HealthCheck"
      description: >-
        This is the health check endpoint. If this returns a 200, the server is alive.
      responses:
        200:
          description: Successful response
          schema:
            type: object
            properties:
              status:
                type: string
                description: Overall health of PMSH
                enum: [healthy, unhealthy]
        503:
          description: the pmsh service is unavailable