docs/offeredapis/api_hub/model.xsd

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!--
   3
   4         Copyright (c) 2018 Orange
   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 -->
  19 <xs:schema xmlns:xmime="http://www.w3.org/2005/05/xmlmime"
  20            xmlns="http://orange.com/ONAPNBI/api/hub/v4/model"
  21            xmlns:xs="http://www.w3.org/2001/XMLSchema"
  22            attributeFormDefault="unqualified"
  23            elementFormDefault="qualified"
  24            targetNamespace="http://orange.com/ONAPNBI/api/hub/v4/model">
  25    <xs:annotation id="signature">
  26       <xs:appinfo>API Designer</xs:appinfo>
  27       <xs:documentation>Model: hub
  28                     Version: 4.0.1
  29                     Owner: ONAPNBI
  30                     Generated on: 2019-03-12T16:45:33.51Z
  31                     Generated by: Orange API Designer v2, model-v1</xs:documentation>
  32    </xs:annotation>
  33    <xs:element name="ErrorDetail" type="ErrorDetail"/>
  34    <xs:complexType name="ErrorDetail">
  35       <xs:sequence minOccurs="1" maxOccurs="1">
  36          <xs:element name="code" type="xs:int" minOccurs="1"/>
  37          <xs:element name="message" type="xs:string" minOccurs="1"/>
  38          <xs:element name="description" type="xs:string" minOccurs="0"/>
  39          <xs:element name="infoURL" type="xs:string" minOccurs="0"/>
  40       </xs:sequence>
  41    </xs:complexType>
  42    <xs:element name="Error" type="Error"/>
  43    <xs:complexType name="Error">
  44       <xs:sequence minOccurs="1" maxOccurs="1">
  45          <xs:element name="code" type="xs:int" minOccurs="1"/>
  46          <xs:element name="message" type="xs:string" minOccurs="1"/>
  47          <xs:element name="description" type="xs:string" minOccurs="0"/>
  48          <xs:element name="infoURL" type="xs:string" minOccurs="0"/>
  49          <xs:element name="details"
  50                      type="ErrorDetail"
  51                      minOccurs="0"
  52                      maxOccurs="unbounded"/>
  53       </xs:sequence>
  54    </xs:complexType>
  55    <xs:element name="HubIn" type="HubIn">
  56       <xs:annotation>
  57          <xs:documentation source="public"/>
  58       </xs:annotation>
  59    </xs:element>
  60    <xs:complexType name="HubIn">
  61       <xs:annotation>
  62          <xs:documentation source="public"/>
  63       </xs:annotation>
  64       <xs:sequence minOccurs="1" maxOccurs="1">
  65          <xs:element name="query" type="xs:string" minOccurs="1">
  66             <xs:annotation>
  67                <xs:documentation source="public">The query must have an eventType= information.\nOptionally a ? could be added to reduce hub.\nquery”:”eventType = ServiceOrderStateChangeNotification”&amp;serviceOrder.state=COMPLETED</xs:documentation>
  68             </xs:annotation>
  69          </xs:element>
  70          <xs:element name="callback" type="xs:string" minOccurs="1">
  71             <xs:annotation>
  72                <xs:documentation source="public">URL where notification must be send</xs:documentation>
  73             </xs:annotation>
  74          </xs:element>
  75       </xs:sequence>
  76    </xs:complexType>
  77    <xs:element name="Hub" type="Hub">
  78       <xs:annotation>
  79          <xs:documentation source="public"/>
  80       </xs:annotation>
  81    </xs:element>
  82    <xs:complexType name="Hub">
  83       <xs:annotation>
  84          <xs:documentation source="public"/>
  85       </xs:annotation>
  86       <xs:sequence minOccurs="1" maxOccurs="1">
  87          <xs:element name="id" type="xs:string" minOccurs="1"/>
  88          <xs:element name="query" type="xs:string" minOccurs="1">
  89             <xs:annotation>
  90                <xs:documentation source="public">The query must have an eventType= information.\nOptionally a ? could be added to reduce hub.\nquery”:”eventType = ServiceOrderStateChangeNotification”&amp;serviceOrder.state=COMPLETED</xs:documentation>
  91             </xs:annotation>
  92          </xs:element>
  93          <xs:element name="callback" type="xs:string" minOccurs="1">
  94             <xs:annotation>
  95                <xs:documentation source="public">URL where notification must be send</xs:documentation>
  96             </xs:annotation>
  97          </xs:element>
  98       </xs:sequence>
  99    </xs:complexType>
 100 </xs:schema>