From cf469f63cb490d90b55508efa331073a17297999 Mon Sep 17 00:00:00 2001
From: MatthieuGeerebaert <matthieu.geerebaert@orange.com>
Date: Tue, 12 Mar 2019 18:30:33 +0100
Subject: Update Swagger files

Change-Id: I02a375b4998fdf23bd7c4eb391011a8e37a1c8e2
Issue-ID: EXTAPI-211
Signed-off-by: MatthieuGeerebaert <matthieu.geerebaert@orange.com>
---
 docs/offeredapis/api_status/api.plantuml |  43 ++++++
 docs/offeredapis/api_status/model.xsd    | 114 +++++++++++++++
 docs/offeredapis/api_status/swagger.json | 230 +++++++++++++++++++++++++++++++
 docs/offeredapis/api_status/swagger.yaml | 145 +++++++++++++++++++
 4 files changed, 532 insertions(+)
 create mode 100644 docs/offeredapis/api_status/api.plantuml
 create mode 100644 docs/offeredapis/api_status/model.xsd
 create mode 100644 docs/offeredapis/api_status/swagger.json
 create mode 100644 docs/offeredapis/api_status/swagger.yaml

(limited to 'docs/offeredapis/api_status')

diff --git a/docs/offeredapis/api_status/api.plantuml b/docs/offeredapis/api_status/api.plantuml
new file mode 100644
index 0000000..6c5ed42
--- /dev/null
+++ b/docs/offeredapis/api_status/api.plantuml
@@ -0,0 +1,43 @@
+@startuml
+
+enum StatusValue {
+   ok
+   ko
+}
+enum ComponentsName {
+   sdc connectivity
+   so connectivity
+   aai connectivity
+   dmaap connectivity
+}
+enum ApplicationName {
+   nbi
+}
+
+class ErrorDetail {
+   code:int
+   message:string
+   description:string
+   infoURL:string
+}
+
+class Error {
+   code:int
+   message:string
+   description:string
+   infoURL:string
+}
+   Error --> "0-*" ErrorDetail : details
+
+class Component
+   Component --> "1-1" ComponentsName : name
+   Component --> "1-1" StatusValue : status
+
+class Status {
+   version:string
+}
+   Status --> "1-1" ApplicationName : name
+   Status --> "1-1" StatusValue : status
+   Status --> "0-*" Component : components
+
+@enduml
\ No newline at end of file
diff --git a/docs/offeredapis/api_status/model.xsd b/docs/offeredapis/api_status/model.xsd
new file mode 100644
index 0000000..9b1d7ee
--- /dev/null
+++ b/docs/offeredapis/api_status/model.xsd
@@ -0,0 +1,114 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns:xmime="http://www.w3.org/2005/05/xmlmime"
+           xmlns="http://orange.com/ONAPNBI/api/status/v4/model"
+           xmlns:xs="http://www.w3.org/2001/XMLSchema"
+           attributeFormDefault="unqualified"
+           elementFormDefault="qualified"
+           targetNamespace="http://orange.com/ONAPNBI/api/status/v4/model">
+   <xs:annotation id="signature">
+      <xs:appinfo>API Designer</xs:appinfo>
+      <xs:documentation>Model: status
+                    Version: 4.0.0_inProgress
+                    Owner: ONAPNBI
+                    Generated on: 2019-03-12T16:45:47.241Z
+                    Generated by: Orange API Designer v2, model-v1</xs:documentation>
+   </xs:annotation>
+   <xs:simpleType name="StatusValue">
+      <xs:restriction base="xs:string">
+         <xs:enumeration value="ok"/>
+         <xs:enumeration value="ko"/>
+      </xs:restriction>
+   </xs:simpleType>
+   <xs:simpleType name="ComponentsName">
+      <xs:restriction base="xs:string">
+         <xs:enumeration value="sdc connectivity"/>
+         <xs:enumeration value="so connectivity"/>
+         <xs:enumeration value="aai connectivity"/>
+         <xs:enumeration value="dmaap connectivity"/>
+      </xs:restriction>
+   </xs:simpleType>
+   <xs:simpleType name="ApplicationName">
+      <xs:restriction base="xs:string">
+         <xs:enumeration value="nbi"/>
+      </xs:restriction>
+   </xs:simpleType>
+   <xs:element name="ErrorDetail" type="ErrorDetail"/>
+   <xs:complexType name="ErrorDetail">
+      <xs:sequence minOccurs="1" maxOccurs="1">
+         <xs:element name="code" type="xs:int" minOccurs="1"/>
+         <xs:element name="message" type="xs:string" minOccurs="1"/>
+         <xs:element name="description" type="xs:string" minOccurs="0"/>
+         <xs:element name="infoURL" type="xs:string" minOccurs="0"/>
+      </xs:sequence>
+   </xs:complexType>
+   <xs:element name="Error" type="Error"/>
+   <xs:complexType name="Error">
+      <xs:sequence minOccurs="1" maxOccurs="1">
+         <xs:element name="code" type="xs:int" minOccurs="1"/>
+         <xs:element name="message" type="xs:string" minOccurs="1"/>
+         <xs:element name="description" type="xs:string" minOccurs="0"/>
+         <xs:element name="infoURL" type="xs:string" minOccurs="0"/>
+         <xs:element name="details"
+                     type="ErrorDetail"
+                     minOccurs="0"
+                     maxOccurs="unbounded"/>
+      </xs:sequence>
+   </xs:complexType>
+   <xs:element name="Component" type="Component">
+      <xs:annotation>
+         <xs:documentation source="public"/>
+      </xs:annotation>
+   </xs:element>
+   <xs:complexType name="Component">
+      <xs:annotation>
+         <xs:documentation source="public"/>
+      </xs:annotation>
+      <xs:sequence minOccurs="1" maxOccurs="1">
+         <xs:element name="name" type="ComponentsName" minOccurs="1">
+            <xs:annotation>
+               <xs:documentation source="public"/>
+            </xs:annotation>
+         </xs:element>
+         <xs:element name="status" type="StatusValue" minOccurs="1">
+            <xs:annotation>
+               <xs:documentation source="public"/>
+            </xs:annotation>
+         </xs:element>
+      </xs:sequence>
+   </xs:complexType>
+   <xs:element name="Status" type="Status">
+      <xs:annotation>
+         <xs:documentation source="public"/>
+      </xs:annotation>
+   </xs:element>
+   <xs:complexType name="Status">
+      <xs:annotation>
+         <xs:documentation source="public"/>
+      </xs:annotation>
+      <xs:sequence minOccurs="1" maxOccurs="1">
+         <xs:element name="name" type="ApplicationName" minOccurs="1">
+            <xs:annotation>
+               <xs:documentation source="public">application name</xs:documentation>
+            </xs:annotation>
+         </xs:element>
+         <xs:element name="status" type="StatusValue" minOccurs="1">
+            <xs:annotation>
+               <xs:documentation source="public"/>
+            </xs:annotation>
+         </xs:element>
+         <xs:element name="version" type="xs:string" minOccurs="1">
+            <xs:annotation>
+               <xs:documentation source="public"/>
+            </xs:annotation>
+         </xs:element>
+         <xs:element name="components"
+                     type="Component"
+                     minOccurs="1"
+                     maxOccurs="unbounded">
+            <xs:annotation>
+               <xs:documentation source="public"/>
+            </xs:annotation>
+         </xs:element>
+      </xs:sequence>
+   </xs:complexType>
+</xs:schema>
diff --git a/docs/offeredapis/api_status/swagger.json b/docs/offeredapis/api_status/swagger.json
new file mode 100644
index 0000000..9bb198f
--- /dev/null
+++ b/docs/offeredapis/api_status/swagger.json
@@ -0,0 +1,230 @@
+
+    {
+    "swagger": "2.0",
+    "info": {
+    "description": "Provides a healthcheck to verify that the NBI component is running fine as a standalone application or can also communicate with other onap modules.\n\n",
+    "version": "4.0.0_inProgress",
+    "title": "API Status",
+    "x-logo": {
+    "url": "/redoc/logo.png",
+    "backgroundColor": "#FFFFFF"
+    }
+    },
+    
+      "host": "localhost:8080",
+      "basePath":	"/nbi/api/v4",
+      "schemes": [
+      "http"
+      ],
+    "produces": [
+    "application/json;charset=utf-8"
+    ],
+    "tags": [
+    
+      {
+      "name": "Status",
+      "description": ""
+      }
+    ],
+    "paths": {
+      "/status": {
+    "get": {
+    "tags": [
+    "Status"
+    ],
+        "produces": [
+           "application/json;charset=utf-8"
+      ],
+    "operationId": "statusFind",
+    "summary": "retrieve application status",
+    "description": "* Default\n\n```\n{\n    \"name\": \"nbi\",\n    \"status\": \"ok\",\n    \"version\": \"v3\"\n}\n```\n\n* Optional\n\n```\n?fullStatus=true\n```\n\n```\n{\n    \"name\": \"nbi\",\n    \"status\": \"ok\",\n    \"version\": \"v3\",\n    \"components\": [\n        {\n            \"name\": \"sdc connectivity\",\n            \"status\": \"ko\"\n        },\n        {\n            \"name\": \"so connectivity\",\n            \"status\": \"ok\"\n        },\n        {\n            \"name\": \"aai connectivity\",\n            \"status\": \"ok\"\n        },\n        {\n            \"name\": \"dmaap connectivity\",\n            \"status\": \"ok\"\n        }\n    ]\n}\n```",
+    "deprecated": false,
+    
+      "parameters": [
+      
+    {
+    "name": "fullStatus",
+    "required": false,
+    "in": "query",
+    "description": "",
+    
+    "type": "boolean",
+    
+        "default": false
+    }
+      ],
+    "responses": {
+    "200": {
+    "description": "Ok",
+    "schema": {
+    "$ref": "#/definitions/Status"
+    }
+    
+    }
+    }
+    }
+      }
+    },
+    "definitions": {
+    
+    "StatusValue": {
+    "description": "",
+    
+      "type": "string",
+      "enum": [
+        "ok",
+        "ko"]
+    
+    },
+    "ComponentsName": {
+    "description": "",
+    
+      "type": "string",
+      "enum": [
+        "sdc connectivity",
+        "so connectivity",
+        "aai connectivity",
+        "dmaap connectivity"]
+    
+    },
+    "ApplicationName": {
+    "description": "",
+    
+      "type": "string",
+      "enum": [
+        "nbi"]
+    
+    },    
+
+    "ErrorDetail": {
+    "description": "",
+
+    
+    "required": [
+    
+      "code",
+      "message"
+    ],
+    "type": "object",
+    "properties": {
+    "code": {
+    "description": "",
+    "type": "integer",
+    "format": "int32"
+    },
+    "message": {
+    "description": "",
+    "type": "string"
+    },
+    "description": {
+    "description": "",
+    "type": "string"
+    },
+    "infoURL": {
+    "description": "",
+    "type": "string"
+    }
+    }
+    
+    },    
+
+    "Error": {
+    "description": "",
+
+    
+    "required": [
+    
+      "code",
+      "message"
+    ],
+    "type": "object",
+    "properties": {
+    "code": {
+    "description": "",
+    "type": "integer",
+    "format": "int32"
+    },
+    "message": {
+    "description": "",
+    "type": "string"
+    },
+    "description": {
+    "description": "",
+    "type": "string"
+    },
+    "infoURL": {
+    "description": "",
+    "type": "string"
+    },
+    "details": {
+    
+    "type": "array",
+    "items": {
+    "$ref": "#/definitions/ErrorDetail"
+    }
+    }
+    }
+    
+    },    
+
+    "Component": {
+    "description": "",
+
+    
+    "required": [
+    
+      "name",
+      "status"
+    ],
+    "type": "object",
+    "properties": {
+    "name": {
+    
+    "$ref": "#/definitions/ComponentsName"
+    },
+    "status": {
+    
+    "$ref": "#/definitions/StatusValue"
+    }
+    }
+    
+    },    
+
+    "Status": {
+    "description": "",
+
+    
+    "required": [
+    
+      "name",
+      "status",
+      "version",
+      "components"
+    ],
+    "type": "object",
+    "properties": {
+    "name": {
+    
+    "$ref": "#/definitions/ApplicationName"
+    },
+    "status": {
+    
+    "$ref": "#/definitions/StatusValue"
+    },
+    "version": {
+    "description": "",
+    "type": "string"
+    },
+    "components": {
+    
+    "type": "array",
+    "items": {
+    "$ref": "#/definitions/Component"
+    }
+    }
+    }
+    
+    }
+    }
+    }
+  
\ No newline at end of file
diff --git a/docs/offeredapis/api_status/swagger.yaml b/docs/offeredapis/api_status/swagger.yaml
new file mode 100644
index 0000000..88177de
--- /dev/null
+++ b/docs/offeredapis/api_status/swagger.yaml
@@ -0,0 +1,145 @@
+swagger: "2.0"
+info:
+  description: "Provides a healthcheck to verify that the NBI component is running\
+    \ fine as a standalone application or can also communicate with other onap modules.\n\
+    \n"
+  version: "4.0.0_inProgress"
+  title: "API Status"
+  x-logo:
+    url: "/redoc/logo.png"
+    backgroundColor: "#FFFFFF"
+host: "localhost:8080"
+basePath: "/nbi/api/v4"
+schemes:
+- "http"
+produces:
+- "application/json;charset=utf-8"
+tags:
+- name: "Status"
+  description: ""
+paths:
+  /status:
+    get:
+      tags:
+      - "Status"
+      produces:
+      - "application/json;charset=utf-8"
+      operationId: "statusFind"
+      summary: "retrieve application status"
+      description: "* Default\n\n```\n{\n    \"name\": \"nbi\",\n    \"status\": \"\
+        ok\",\n    \"version\": \"v3\"\n}\n```\n\n* Optional\n\n```\n?fullStatus=true\n\
+        ```\n\n```\n{\n    \"name\": \"nbi\",\n    \"status\": \"ok\",\n    \"version\"\
+        : \"v3\",\n    \"components\": [\n        {\n            \"name\": \"sdc connectivity\"\
+        ,\n            \"status\": \"ko\"\n        },\n        {\n            \"name\"\
+        : \"so connectivity\",\n            \"status\": \"ok\"\n        },\n     \
+        \   {\n            \"name\": \"aai connectivity\",\n            \"status\"\
+        : \"ok\"\n        },\n        {\n            \"name\": \"dmaap connectivity\"\
+        ,\n            \"status\": \"ok\"\n        }\n    ]\n}\n```"
+      deprecated: false
+      parameters:
+      - name: "fullStatus"
+        required: false
+        in: "query"
+        description: ""
+        type: "boolean"
+        default: false
+      responses:
+        200:
+          description: "Ok"
+          schema:
+            $ref: "#/definitions/Status"
+definitions:
+  StatusValue:
+    description: ""
+    type: "string"
+    enum:
+    - "ok"
+    - "ko"
+  ComponentsName:
+    description: ""
+    type: "string"
+    enum:
+    - "sdc connectivity"
+    - "so connectivity"
+    - "aai connectivity"
+    - "dmaap connectivity"
+  ApplicationName:
+    description: ""
+    type: "string"
+    enum:
+    - "nbi"
+  ErrorDetail:
+    description: ""
+    required:
+    - "code"
+    - "message"
+    type: "object"
+    properties:
+      code:
+        description: ""
+        type: "integer"
+        format: "int32"
+      message:
+        description: ""
+        type: "string"
+      description:
+        description: ""
+        type: "string"
+      infoURL:
+        description: ""
+        type: "string"
+  Error:
+    description: ""
+    required:
+    - "code"
+    - "message"
+    type: "object"
+    properties:
+      code:
+        description: ""
+        type: "integer"
+        format: "int32"
+      message:
+        description: ""
+        type: "string"
+      description:
+        description: ""
+        type: "string"
+      infoURL:
+        description: ""
+        type: "string"
+      details:
+        type: "array"
+        items:
+          $ref: "#/definitions/ErrorDetail"
+  Component:
+    description: ""
+    required:
+    - "name"
+    - "status"
+    type: "object"
+    properties:
+      name:
+        $ref: "#/definitions/ComponentsName"
+      status:
+        $ref: "#/definitions/StatusValue"
+  Status:
+    description: ""
+    required:
+    - "name"
+    - "status"
+    - "version"
+    - "components"
+    type: "object"
+    properties:
+      name:
+        $ref: "#/definitions/ApplicationName"
+      status:
+        $ref: "#/definitions/StatusValue"
+      version:
+        description: ""
+        type: "string"
+      components:
+        type: "array"
+        items:
+          $ref: "#/definitions/Component"
-- 
cgit 1.2.3-korg