# variables in header
vnf_pm_job_id:
  description: |
    Identifier of this PM job.
  in: path
  required: true
  type: string

vnf_pm_job_report_id:
  description: |
    Identifier of this PM job report.
  in: path
  required: true
  type: string

vnf_pm_threshold_id:
  description: |
    Identifier of this PM threshold.
  in: path
  required: true
  type: string

# variables in body
authentication_auth_type:
  description: |
    Defines the types of Authentication/Authorization which
    the API consumer is willing to accept when receiving a
    notification.
    Permitted values:

    BASIC: In every HTTP request to the
    notification endpoint, use HTTP Basic
    authentication with the client credentials.

    OAUTH2_CLIENT_CREDENTIALS: In every HTTP request
    to the notification endpoint, use an OAuth 2.0 token,
    obtained using the client credentials grant type
    after authenticating using client identifier and
    client password towards the token endpoint.

    OAUTH2_CLIENT_CERT: In every HTTP request to
    the notification endpoint, use an OAuth 2.0 token,
    obtained using the client credentials grant type
    after mutually authenticating using client identifier
    and X.509 certificates towards the token endpoint.

    TLS_CERT is not supported.
  in: body
  required: true
  type: array
authentication_params_basic:
  description: |
    Parameters for authentication/authorization using BASIC.
    Shall be present if authType is "BASIC" and the
    contained information has not been provisioned out of
    band. Shall be absent otherwise.
  in: body
  required: false
  type: object
authentication_params_oauth2_client_cert:
  description: |
    Parameters for authentication/authorization using
    OAUTH2_CLIENT_CERT.
    Shall be present if authType is "OAUTH2_CLIENT_CERT" and the
    contained information has not been provisioned out of band.
    Shall be absent otherwise.
  in: body
  required: false
  type: object
authentication_params_oauth2_client_credentials:
  description: |
    Parameters for authentication/authorization using
    OAUTH2_CLIENT_CREDENTIALS.
    Shall be present if authType is
    "OAUTH2_CLIENT_CREDENTIALS" and the contained
    information has not been provisioned out of band.
    Shall be absent otherwise.
  in: body
  required: false
  type: object
criteria_collection_period:
  description: |
    Specifies the periodicity at which the API producer will collect
    performance information. The unit shall be seconds.
  in: body
  required: true
  type: integer
criteria_performance_metric:
  description: |
    This defines the types of performance metrics for the specified object
    instances. At least one of the two attributes (performance metric or
    group) shall be present.
  in: body
  required: false
  type: array
criteria_performance_metric_group:
  description: |
    Group of performance metrics. A metric group is a pre-defined list of
    metrics, known to the API producer that it can decompose to individual
    metrics. At least one of the two attributes (performance metric or group)
    shall be present.
  in: body
  required: false
  type: array
criteria_reporting_boundary:
  description: |
    Identifies a time boundary after which the reporting will stop. The
    boundary shall allow a single reporting as well as periodic reporting up
    to the boundary(format:date-time).
  in: body
  required: false
  type: string
criteria_reporting_period:
  description: |
    Specifies the periodicity at which the API producer will report to the API
    consumer. about performance information. The unit shall be seconds. The
    reportingPeriod should be equal to or a multiple of the collectionPeriod.
  in: body
  required: true
  type: integer
links_objects:
  description: |
    Links to resources representing the measured object instances for which
    performance information is collected. Shall be present if the measured
    object instance information is accessible as a resource.
  in: body
  required: false
  type: array
links_self:
  description: |
    URI of this resource.
  in: body
  required: true
  type: object
notification_id:
  description: |
    Identifier of this notification.
  in: body
  required: true
  type: string
notification_links:
  description: |
    Links to resources related to this notification.
  in: body
  required: true
  type: object
notification_object_instance:
  description: |
    Link to the resource representing the measured object instance to which
    the notified change applies. Shall be present if the measured object
    instance information is accessible as a resource.
  in: body
  required: false
  type: object
notification_object_instance_id:
  description: |
    Identifier of the measured object instance.
  in: body
  required: true
  type: string
notification_object_type:
  description: |
    Type of the measured object.
  in: body
  required: true
  type: string
notification_performance_information_available_notification_type:
  description: |
    Discriminator for the different notification types. Set to
    "PerformanceInformationAvailableNotification" for this notification type.
  in: body
  required: true
  type: string
notification_performance_information_available_performance_report:
  description: |
    Link from which the available performance information of data type
    "PerformanceReport" can be obtained.
  in: body
  required: true
  type: object
notification_performance_information_available_pmjob:
  description: |
    Link to the resource that represents the PM job for which performance
    information is available.
  in: body
  required: true
  type: object
notification_performance_information_available_pmjob_id:
  description: |
    Identifier of the PM job for which performance information is available.
  in: body
  required: true
  type: string
notification_performance_information_available_sub_object_instance_ids:
  description: |
    Identifiers of the sub-object instances of the measured object instance
    for which the measurements have been taken.
  in: body
  required: false
  type: array
notification_sub_object_instance_id:
  description: |
    Identifier of the sub-object of the measured object to which the
    measurement applies.
  in: body
  required: false
  type: string
notification_threshold_crossed_context:
  description: |
    Measurement context information related to the measured value.
  in: body
  required: false
  type: string
notification_threshold_crossed_crossing_direction:
  description: |
    An indication of whether the threshold was crossed in upward or
    downward direction.
  in: body
  required: true
  type: string
notification_threshold_crossed_notification_type:
  description: |
    Discriminator for the different notification types.
    Set to "ThresholdCrossedNotification" for this notification type.
  in: body
  required: true
  type: string
notification_threshold_crossed_performance_metric:
  description: |
    Performance metric associated with the threshold.
  in: body
  required: true
  type: string
notification_threshold_crossed_performance_value:
  description: |
    Value of the metric that resulted in threshold crossing.
  in: body
  required: true
  type: string
notification_threshold_crossed_threshold:
  description: |
    Link to the resource that represents the threshold that was crossed.
  in: body
  required: true
  type: object
notification_threshold_crossed_threshold_id:
  description: |
    Identifier of the threshold which has been crossed.
  in: body
  required: true
  type: string
notification_time_stamp:
  description: |
    Date and time of the generation of the notification.
  in: body
  required: true
  type: string
notification_type:
  description: |
    Discriminator for the different notification types.
  in: body
  required: true
  type: string
params_oauth2_client_cert_certificate_ref:
  description: |
    Fingerprint of the client certificate. The hash function
    shall use SHA256 or higher. Shall be present if it has not
    been provisioned out of band.
  in: body
  required: true
  type: object
params_oauth2_client_cert_client_id:
  description: |
    Client identifier to be used in the access token request
    of the OAuth 2.0 client credentials grant type. Shall be
    present if it has not been provisioned out of band.
  in: body
  required: true
  type: string
params_oauth2_client_cert_token_endpoint:
  description: |
    The token endpoint from which the access token can be
    obtained. Shall be present if it has not been provisioned
    out of band.
  in: body
  required: true
  type: string
params_oauth2_client_cert_type:
  description: |
    The type of fingerprint.
    Permitted values:

    x5t#S256: The SHA-256 thumbprint of the X.509 certificate
    as defined in section 4.1.8 of IETF RFC 7515.
  in: body
  required: true
  type: string
params_oauth2_client_cert_value:
  description: |
    The fingerprint value as defined by the type. Shall be
    present if it has not been provisioned out of band.
  in: body
  required: true
  type: string
params_oauth2_client_credentials_client_id:
  description: |
    Client identifier to be used in the access token request
    of the OAuth 2.0 client credentials grant type. Shall be
    present if it has not been provisioned out of band.
  in: body
  required: false
  type: string
params_oauth2_client_credentials_client_password:
  description: |
    Client password to be used in the access token request
    of the OAuth 2.0 client credentials grant type. Shall be
    present if it has not been provisioned out of band.
  in: body
  required: false
  type: string
params_oauth2_client_credentials_token_endpoint:
  description: |
    The token endpoint from which the access token can be
    obtained. Shall be present if it has not been provisioned
    out of band.
  in: body
  required: false
  type: string
paramsBasic_password:
  description: |
    Password to be used in HTTP Basic authentication.
    Shall be present if it has not been provisioned out of band.
  in: body
  required: false
  type: string
paramsBasic_userName:
  description: |
    Username to be used in HTTP Basic authentication.
    Shall be present if it has not been provisioned out of band.
  in: body
  required: false
  type: string
performance_values_context:
  description: |
    Measurement context information related to the measured value.
  in: body
  required: false
  type: key value pairs
performance_values_time_stamp:
  description: |
    Time stamp indicating when the data has been collected.
  in: body
  required: true
  type: string
performance_values_value:
  description: |
    Value of the metric collected.
  in: body
  required: true
  type: string
pm_job_links:
  description: |
    Links for this resource.
  in: body
  required: true
  type: array
pm_threshold_links:
  description: |
    Links for this resource.
  in: body
  required: true
  type: array
reports_expiry_time:
  description: |
    The time when the report will expire.
  in: body
  required: false
  type: string
reports_file_size:
  description: |
    The size of the report file in bytes, if known.
  in: body
  required: false
  type: integer
reports_href:
  description: |
    The URI where the report can be obtained.
  in: body
  required: true
  type: string
reports_ready_time:
  description: |
    The time when the report was made available.
  in: body
  required: true
  type: string
vnf_pm_job_create_callback_uri:
  description: |
    The URI of the endpoint to send the notification to.
    At least one of the "callbackUri" and "authentication"
    attributes shall be present in request body.
  in: body
  required: false
  type: string
vnf_pm_job_create_criteria:
  description: |
    Criteria of the collection of performance information.
  in: body
  required: true
  type: object
vnf_pm_job_create_metadata:
  description: |
    This attribute provides the access information of Prometheus Server.
  in: body
  required: false
  type: key value pairs
vnf_pm_job_create_object_instance_ids:
  description: |
    Identifiers of the measured object instances for which performance
    information is requested to be collected.
  in: body
  required: true
  type: array
vnf_pm_job_create_object_type:
  description: |
    Type of the measured object.
  in: body
  required: true
  type: string
vnf_pm_job_create_request_authentication:
  description: |
    Authentication parameters to configure the use of Authorization when
    sending notifications corresponding to this subscription.
    At least one of the "callbackUri" and "authentication"
    attributes shall be present in request body.
  in: body
  required: false
  type: object
vnf_pm_job_create_sub_object_instance_ids:
  description: |
    Identifiers of the measured object instances in case of a structured
    measured object.
  in: body
  required: false
  type: array
vnf_pm_job_report_entries:
  description: |
    List of performance information entries.
  in: body
  required: true
  type: array
vnf_pm_job_report_entries_object_instance_id:
  description: |
    Identifier of the measured object instance for which the performance metric
    is reported.
  in: body
  required: true
  type: string
vnf_pm_job_report_entries_performance_metric:
  description: |
    Name of the metric collected.
  in: body
  required: true
  type: string
vnf_pm_job_report_entries_performance_values:
  description: |
    List of performance values with associated timestamp.
  in: body
  required: true
  type: array
vnf_pm_job_report_entries_sub_object_instance_id:
  description: |
    Identifier of the sub-object instance of the measured object instance for
    which the performance metric is reported.
  in: body
  required: false
  type: string
vnf_pm_job_reports:
  description: |
    Information about available reports collected by this PM job.
  in: body
  required: false
  type: array
vnf_pm_job_response_callback_uri:
  description: |
    The URI of the endpoint to send the notification to.
  in: body
  required: false
  type: string
vnf_pm_job_response_id:
  description: |
    Identifier of this PM job.
  in: body
  required: true
  type: string
vnf_pm_threshold_create_callback_uri:
  description: |
    The URI of the endpoint to send the notification to.
  in: body
  required: true
  type: string
vnf_pm_threshold_create_metadata:
  description: |
    This attribute provides the access information of Prometheus Server.
  in: body
  required: true
  type: key value pairs
vnf_pm_threshold_create_request_authentication:
  description: |
    Authentication parameters to configure the use of Authorization when
    sending notifications corresponding to this subscription.
  in: body
  required: false
  type: object
vnf_pm_threshold_criteria:
  description: |
    Criteria of the collection of performance information.
  in: body
  required: true
  type: object
vnf_pm_threshold_criteria_performance_metric:
  description: |
    This defines the types of performance metrics associated with the
    threshold.
  in: body
  required: true
  type: string
vnf_pm_threshold_hysteresis:
  description: |
    The hysteresis of the threshold.
    Shall be represented as a non-negative floating point number.
  in: body
  required: true
  type: number
vnf_pm_threshold_id_body:
  description: |
    Identifier of this PM threshold.
  in: body
  required: true
  type: string
vnf_pm_threshold_links_object:
  description: |
    Links to resources representing the measured object instances for which
    performance information is collected. Shall be present if the measured
    object instance information is accessible as a resource.
  in: body
  required: false
  type: object
vnf_pm_threshold_object_instance_id:
  description: |
    Identifier of the measured object instance for which the performance metric
    is reported.
  in: body
  required: true
  type: string
vnf_pm_threshold_object_type:
  description: |
    Type of the measured object.
  in: body
  required: true
  type: string
vnf_pm_threshold_report_entries_performance_metric:
  description: |
    Name of the metric collected.
  in: body
  required: true
  type: string
vnf_pm_threshold_response_callback_uri:
  description: |
    The URI of the endpoint to send the notification to.
  in: body
  required: true
  type: string
vnf_pm_threshold_response_id:
  description: |
    Identifier of this PM threshold.
  in: body
  required: true
  type: string
vnf_pm_threshold_simple_threshold_details:
  description: |
    Details of a simple threshold. Shall be present if thresholdType="SIMPLE".
  in: body
  required: false
  type: object
vnf_pm_threshold_sub_object_instance_ids:
  description: |
    Identifiers of the measured object instances in case of a structured
    measured object.
  in: body
  required: false
  type: array
vnf_pm_threshold_type:
  description: |
    Type of threshold. This attribute determines which other attributes
    are present in the data structure.
    "SIMPLE: Single-valued static threshold" is permitted.
  in: body
  required: true
  type: string
vnf_pm_threshold_update_callback_uri:
  description: |
    The URI of the endpoint to send the notification to.
    At least one of the "callbackUri" and "authentication"
    attributes shall be present in request body.
  in: body
  required: false
  type: string
vnf_pm_threshold_update_request_authentication:
  description: |
    Authentication parameters to configure the use of Authorization when
    sending notifications corresponding to this subscription.
    At least one of the "callbackUri" and "authentication"
    attributes shall be present in request body.
  in: body
  required: false
  type: object
vnf_pm_threshold_update_resp_callback_uri:
  description: |
    The URI of the endpoint to send the notification to.
  in: body
  required: false
  type: string
vnf_pm_threshold_value:
  description: |
    The threshold value. Shall be represented as a floating point number.
  in: body
  required: true
  type: number