schemas/README.md

   1 #==================================================================================
   2 #        Copyright (c) 2018-2019 AT&T Intellectual Property.
   3 #
   4 #   Licensed under the Apache License, Version 2.0 (the "License");
   5 #   you may not use this file except in compliance with the License.
   6 #   You may obtain a copy of the License at
   7 #
   8 #       http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 #   Unless required by applicable law or agreed to in writing, software
  11 #   distributed under the License is distributed on an "AS IS" BASIS,
  12 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 #   See the License for the specific language governing permissions and
  14 #   limitations under the License.
  15 #==================================================================================
  16 This directory contains the various JSON payloads received/sent by the xAPP and the associated schemas.
  17
  18 1. Policy messages are set (and requested) via RMR. The A1 mediator which sends these requests verifies that the messages conform to schema specified by the xAPP developer (the AC xAPP also validates this).  The schema for the policies is provided by the xAPP developer
  19         - The AC xAPP policy schema file is adm-ctrl-xapp-policy-schema.json
  20
  21 2. Similarly, metrics posted to the VES collector must conform to the global schema specified by the VES collector.
  22         - the ves schema file is ves_schema.json
  23
  24 3. The samples.json file contains templates (example payloads)  of various JSON payloads that the AC xAPP receives (e.g message_receives_example) or sends (message_sends_example, metrics).  The samples.json file is just a convenient place to host all the example payloads. It is loaded at run time by the admission_policy.cc wrapper around the protector plugin. The wrapper extracts the value (which is JSON paAyload) corresponding to the relevant keys
  25 nd uses them as base templates for appropriate actions.
  26
  27         * When the AC xAPP receives a policy, it uses the message_receives_example example payloadexample payload to extract the "enforce", "window_size" etc. keys from the payload and update protector plugin values.
  28         * When the AC xAPP wants to send a response to policy set, it updates the "status" and "message" keys in the message_sends_example to inform SUCCESS or FAILURE.
  29         * When the AC xAPP wants to send metrics to the VES collector, it updates the following keys  in the payload at the "metrics" key
  30                 - all key values under "additionalFields" based on number of SgNB Addition requests accepted/rejected
  31                 - "measurementInterval"  under "measurementFields" based on the configured measurement interval (see README.md under init)