rename docs sub-directory

docs/08-interfaces/OMC-NSSF restful api.md

@@ -0,0 +1,108 @@
+---
+
+
+---
+# 核心网 HTTP RESTful API 服务接口/UE Management/NSSF Available AMF and Subscription
+
+## GET Available AMFs List from NSSF
+
+GET /api/rest/ueManagement/v1/elementType/nssf/objectType/availableAMFs
+
+获取NSSF当前所有可用的AMF列表接口
+
+### Params
+
+| Name            | Location | Type   | Required | Description                        |
+| --------------- | -------- | ------ | -------- | ---------------------------------- |
+| neId            | query    | string | yes      | 网管发往网元的不用带NE ID          |
+| Referer         | header   | string | yes      | Use the specified declared Referer |
+| User-Agent      | header   | string | yes      | User agent                         |
+| Accept-Language | header   | string | yes      | zh_CN;q=0.9 en_US;q=0.9            |
+
+> Response Examples
+
+> 成功
+
+```json
+{
+  "data": [
+    {
+      "nfId": "001",
+      "amfSetId": "001"
+    },
+    {
+      "nfId": "002",
+      "amfSetId": "[001,002]"
+    }
+  ]
+}
+```
+
+### Responses
+
+| HTTP Status Code | Meaning                                              | Description | Data schema |
+| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
+| 200              | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功        | Inline      |
+
+### Responses Data Schema
+
+HTTP Status Code **200**
+
+| Name          | Type     | Required | Restrictions | Title        | description |
+| ------------- | -------- | -------- | ------------ | ------------ | ----------- |
+| » data       | [object] | true     | none         | 返回的数据集 | 数据数组    |
+| »» nfId     | string   | true     | none         | NF ID        | 网元ID      |
+| »» amfSetId | string   | true     | none         | AMF Set ID   | none        |
+
+## GET Subscriptions from NSSF
+
+GET /api/rest/ueManagement/v1/elementType/nssf/objectType/subscriptions
+
+获取NSSF在线订阅数
+
+### Params
+
+| Name            | Location | Type   | Required | Description                        |
+| --------------- | -------- | ------ | -------- | ---------------------------------- |
+| neId            | query    | string | yes      | 网管发往网元的不用带NE ID          |
+| Referer         | header   | string | yes      | Use the specified declared Referer |
+| User-Agent      | header   | string | yes      | User agent                         |
+| Accept-Language | header   | string | yes      | zh_CN;q=0.9 en_US;q=0.9            |
+
+> Response Examples
+
+> 成功
+
+```json
+{
+  "data": [
+    {
+      "subscriptionId": "1",
+      "nfNssaiAvailabilityUri": "http://192.168.2.166/test",
+      "event": "test event 1"
+    },
+    {
+      "subscriptionId": "2",
+      "nfNssaiAvailabilityUri": "http://192.168.2.166/test",
+      "event": "test event 2"
+    }
+  ]
+}
+```
+
+### Responses
+
+| HTTP Status Code | Meaning                                              | Description | Data schema |
+| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
+| 200              | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功        | Inline      |
+
+### Responses Data Schema
+
+HTTP Status Code **200**
+
+| Name                        | Type     | Required | Restrictions | Title                     | description |
+| --------------------------- | -------- | -------- | ------------ | ------------------------- | ----------- |
+| » data                     | [object] | true     | none         |                           | none        |
+| »» subscriptionId         | string   | true     | none         | Subscription ID           | 订阅ID      |
+| »» nfNssaiAvailabilityUri | string   | true     | none         | NF NSSAI Availability Uri | none        |
+| »» event                  | string   | true     | none         | Event                     | none        |

docs/08-interfaces/OMC.openapi.json

@@ -0,0 +1 @@
+{"openapi":"3.0.1","info":{"title":"OMC","description":"OMC HTTP Restful API Interfaces","version":"1.0.0"},"tags":[{"name":"需登录"},{"name":"公开访问"}],"paths":{"/system/post/list":{"get":{"summary":"岗位列表","deprecated":false,"description":"","tags":["需登录"],"parameters":[{"name":"postCode","in":"query","description":"岗位编码","required":false,"example":"{% mock 'word' %}","schema":{"type":"string"}},{"name":"postName","in":"query","description":"岗位名称","required":false,"example":"{% mock 'ctitle' %}","schema":{"type":"string"}},{"name":"status","in":"query","description":"状态（0正常 1停用）","required":false,"example":"{% mock 'pick' , [0,1] %}","schema":{"type":"string"}},{"name":"pageNum","in":"query","description":"Page number，default 1","required":false,"example":"1","schema":{"type":"number"}},{"name":"pageSize","in":"query","description":"Size of one page，default 10","required":false,"example":"10","schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"Authoirzation token","required":true,"example":"{{token-prefix}}{{token-text}}","schema":{"type":"string"}},{"name":"Referer","in":"header","description":"User Referer","required":true,"example":"{{referer}}","schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"User Agent","required":true,"example":"Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36","schema":{"type":"string"}},{"name":"Accept-Language","in":"header","description":"en_US;q=0.9","required":true,"example":"en_US;q=0.9","schema":{"type":"string"}}],"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer"},"msg":{"type":"string"},"total":{"type":"integer"},"rows":{"type":"array","items":{"type":"object","properties":{"postId":{"type":"string","title":"岗位ID"},"postCode":{"type":"string","title":"编码"},"postName":{"type":"string","title":"名称"},"postSort":{"type":"integer","title":"排序"},"status":{"type":"string","title":"状态"},"createBy":{"type":"string"},"createTime":{"type":"string"},"remark":{"type":"string","title":"备注"}},"required":["postId","postCode","postName","postSort","status","createBy","createTime","remark"]}}},"required":["code","msg","total","rows"]},"examples":{"1":{"summary":"成功示例","value":{"code":200,"msg":"成功","total":4,"rows":[{"postId":"1","postCode":"ceo","postName":"董事长","postSort":1,"status":"1","createBy":"maskAdmin","createTime":"1682264526344","remark":""},{"postId":"2","postCode":"se","postName":"项目经理","postSort":2,"status":"1","createBy":"maskAdmin","createTime":"1682264526348","remark":""},{"postId":"3","postCode":"hr","postName":"人力资源","postSort":3,"status":"1","createBy":"maskAdmin","createTime":"1682264526354","remark":""},{"postId":"4","postCode":"user","postName":"普通员工","postSort":4,"status":"1","createBy":"maskAdmin","createTime":"1682264526358","remark":""}]}}}}}}},"security":[]}},"/system/user/profile":{"get":{"summary":"基础信息获取","deprecated":false,"description":"","tags":["需登录"],"parameters":[{"name":"Authorization","in":"header","description":"Authoirzation token","required":true,"example":"{{token-prefix}}{{token-text}}","schema":{"type":"string"}},{"name":"Referer","in":"header","description":"User Referer","required":true,"example":"{{referer}}","schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"User Agent","required":true,"example":"Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36","schema":{"type":"string"}},{"name":"Accept-Language","in":"header","description":"en_US;q=0.9","required":true,"example":"en_US;q=0.9","schema":{"type":"string"}}],"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer"},"msg":{"type":"string"},"data":{"type":"object","properties":{"user":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"object","properties":{"roleId":{"type":"string"},"roleName":{"type":"string"},"roleKey":{"type":"string"},"roleSort":{"type":"integer"},"dataScope":{"type":"string"},"status":{"type":"string"}}},"title":"角色信息"},"userId":{"type":"string"},"deptId":{"type":"string"},"userName":{"type":"string"},"nickName":{"type":"string"},"userType":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"},"phonenumber":{"type":"string"},"sex":{"type":"string"},"status":{"type":"string"},"delFlag":{"type":"string"},"loginIp":{"type":"string"},"loginDate":{"type":"string"},"createBy":{"type":"string"},"createTime":{"type":"string"},"remark":{"type":"string"},"dept":{"type":"object","properties":{"deptId":{"type":"string"},"parentId":{"type":"string"},"ancestors":{"type":"string"},"deptName":{"type":"string"},"orderNum":{"type":"iLine truncated