@sigmaott/base-next 1.0.6

package/src/schemas/ssaiApi.json

@@ -0,0 +1,1108 @@
+{
+  "openapi": "3.0.0",
+  "paths": {
+    "/api/ssai/ads": {
+      "get": {
+        "operationId": "VastController_findAll",
+        "summary": "List Sigma DAI Advertisers collection",
+        "description": "Sigma DAI Advertisers is ads return by vast ads request from ads decision server",
+        "parameters": [
+          {
+            "name": "sort",
+            "required": false,
+            "in": "query",
+            "example": "created_at|desc;filename|asc",
+            "description": "Use only allowed properties separated by semicolon; default is ascending created_at; prefix name with hyphen/minus sign to get descending order",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "page",
+            "required": false,
+            "in": "query",
+            "example": "1",
+            "description": "pagination number",
+            "schema": {
+              "type": "number"
+            }
+          },
+          {
+            "name": "perPage",
+            "required": false,
+            "in": "query",
+            "example": "10",
+            "description": "",
+            "schema": {
+              "type": "number"
+            }
+          },
+          {
+            "name": "limit",
+            "required": false,
+            "in": "query",
+            "example": "10",
+            "description": "",
+            "schema": {
+              "type": "number"
+            }
+          },
+          {
+            "name": "offset",
+            "required": false,
+            "in": "query",
+            "example": "0",
+            "description": "",
+            "schema": {
+              "type": "number"
+            }
+          },
+          {
+            "name": "fields",
+            "required": false,
+            "in": "query",
+            "example": "id,name,url",
+            "description": "Nevertheless, you may choose that some fields would always be sent along with the requested fields, in the response payload. Like the id for example.",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "populates",
+            "required": false,
+            "in": "query",
+            "example": "author,book",
+            "description": "Nevertheless, you may choose that some fields would always be sent along with the requested fields, in the response payload. Like the id for example.",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/VastAssetCollection"
+                }
+              }
+            }
+          }
+        },
+        "tags": [
+          "Advertisers"
+        ],
+        "security": [
+          {
+            "basic": []
+          }
+        ]
+      }
+    },
+    "/api/ssai/ads/{id}": {
+      "delete": {
+        "operationId": "VastController_delete",
+        "summary": "Delete Sigma DAI Advertiser",
+        "description": "Delete a Sigma DAI Advertiser",
+        "parameters": [
+          {
+            "name": "id",
+            "required": true,
+            "in": "path",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/VastAsset"
+                }
+              }
+            }
+          }
+        },
+        "tags": [
+          "Advertisers"
+        ],
+        "security": [
+          {
+            "basic": []
+          }
+        ]
+      }
+    },
+    "/api/ssai/ads/{id}/allow": {
+      "patch": {
+        "operationId": "VastController_allow",
+        "summary": "Allow Sigma DAI Advertiser",
+        "description": "Allow a Sigma DAI Advertiser",
+        "parameters": [
+          {
+            "name": "id",
+            "required": true,
+            "in": "path",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/AllowVastDto"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/VastAsset"
+                }
+              }
+            }
+          }
+        },
+        "tags": [
+          "Advertisers"
+        ],
+        "security": [
+          {
+            "basic": []
+          }
+        ]
+      }
+    },
+    "/api/ssai/channels": {
+      "post": {
+        "operationId": "ChannelController_create",
+        "summary": "Create Dynamic Ads Insert Channel",
+        "description": "Create Dynamic Ads Insert Channel",
+        "parameters": [],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/CreateChannelDto"
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Channel"
+                }
+              }
+            }
+          }
+        },
+        "tags": [
+          "Channel"
+        ],
+        "security": [
+          {
+            "basic": []
+          }
+        ]
+      },
+      "get": {
+        "operationId": "ChannelController_findAll",
+        "summary": "Get Dynamic Ads Insert Channel Collection",
+        "description": "Get Dynamic Ads Insert Channel Collection",
+        "parameters": [
+          {
+            "name": "sort",
+            "required": false,
+            "in": "query",
+            "example": "created_at|desc;filename|asc",
+            "description": "Use only allowed properties separated by semicolon; default is ascending created_at; prefix name with hyphen/minus sign to get descending order",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "page",
+            "required": false,
+            "in": "query",
+            "example": "1",
+            "description": "pagination number",
+            "schema": {
+              "type": "number"
+            }
+          },
+          {
+            "name": "perPage",
+            "required": false,
+            "in": "query",
+            "example": "10",
+            "description": "",
+            "schema": {
+              "type": "number"
+            }
+          },
+          {
+            "name": "limit",
+            "required": false,
+            "in": "query",
+            "example": "10",
+            "description": "",
+            "schema": {
+              "type": "number"
+            }
+          },
+          {
+            "name": "offset",
+            "required": false,
+            "in": "query",
+            "example": "0",
+            "description": "",
+            "schema": {
+              "type": "number"
+            }
+          },
+          {
+            "name": "fields",
+            "required": false,
+            "in": "query",
+            "example": "id,name,url",
+            "description": "Nevertheless, you may choose that some fields would always be sent along with the requested fields, in the response payload. Like the id for example.",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "populates",
+            "required": false,
+            "in": "query",
+            "example": "author,book",
+            "description": "Nevertheless, you may choose that some fields would always be sent along with the requested fields, in the response payload. Like the id for example.",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ChannelCollection"
+                }
+              }
+            }
+          }
+        },
+        "tags": [
+          "Channel"
+        ],
+        "security": [
+          {
+            "basic": []
+          }
+        ]
+      }
+    },
+    "/api/ssai/channels/{id}": {
+      "get": {
+        "operationId": "ChannelController_findOne",
+        "summary": "Get Dynamic Ads Insert Channel By Id",
+        "description": "Get Dynamic Ads Insert Channel By Id",
+        "parameters": [
+          {
+            "name": "id",
+            "required": true,
+            "in": "path",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Channel"
+                }
+              }
+            }
+          }
+        },
+        "tags": [
+          "Channel"
+        ],
+        "security": [
+          {
+            "basic": []
+          }
+        ]
+      },
+      "patch": {
+        "operationId": "ChannelController_update",
+        "summary": "Update Dynamic Ads Insert Channel By Id",
+        "description": "Update Dynamic Ads Insert Channel By Id",
+        "parameters": [
+          {
+            "name": "id",
+            "required": true,
+            "in": "path",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/UpdateChannelDto"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Channel"
+                }
+              }
+            }
+          }
+        },
+        "tags": [
+          "Channel"
+        ],
+        "security": [
+          {
+            "basic": []
+          }
+        ]
+      },
+      "delete": {
+        "operationId": "ChannelController_remove",
+        "summary": "Delete Dynamic Ads Insert Channel By Id",
+        "description": "Delete Dynamic Ads Insert Channel By Id",
+        "parameters": [
+          {
+            "name": "id",
+            "required": true,
+            "in": "path",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Channel"
+                }
+              }
+            }
+          }
+        },
+        "tags": [
+          "Channel"
+        ],
+        "security": [
+          {
+            "basic": []
+          }
+        ]
+      }
+    },
+    "/api/ssai/channels/actions/get-tags": {
+      "get": {
+        "operationId": "ChannelController_getTags",
+        "summary": "Get list Tags using in Channel",
+        "description": "Get list Tags using in Channel",
+        "parameters": [
+          {
+            "name": "search",
+            "required": true,
+            "in": "query",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TagsDto"
+                }
+              }
+            }
+          }
+        },
+        "tags": [
+          "Channel"
+        ],
+        "security": [
+          {
+            "basic": []
+          }
+        ]
+      }
+    },
+    "/api/ssai/sub-channels": {
+      "get": {
+        "operationId": "SubChannelController_findAll",
+        "summary": "Get List Sub-Channel",
+        "description": "Get List Sub-Channel",
+        "parameters": [
+          {
+            "name": "channelId",
+            "required": true,
+            "in": "query",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "subChannel",
+            "required": true,
+            "in": "query",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": ""
+          }
+        },
+        "tags": [
+          "Sub-Channel"
+        ]
+      }
+    },
+    "/api/ssai/settings/app": {
+      "post": {
+        "operationId": "SettingController_create",
+        "summary": "Create Setting",
+        "description": "Create Setting",
+        "parameters": [],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/CreateSettingDto"
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Setting"
+                }
+              }
+            }
+          }
+        },
+        "tags": [
+          "Setting"
+        ],
+        "security": [
+          {
+            "basic": []
+          }
+        ]
+      },
+      "get": {
+        "operationId": "SettingController_getOne",
+        "summary": "Get  App Setting",
+        "description": "Get App Setting",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Setting"
+                }
+              }
+            }
+          }
+        },
+        "tags": [
+          "Setting"
+        ],
+        "security": [
+          {
+            "basic": []
+          }
+        ]
+      }
+    }
+  },
+  "info": {
+    "title": "Sigma Dynamic Ads Insert",
+    "description": "Sigma Streaming Platform Dynamic Ads Insert ",
+    "version": "1.0",
+    "contact": {}
+  },
+  "tags": [],
+  "servers": [],
+  "components": {
+    "securitySchemes": {
+      "basic": {
+        "type": "http",
+        "scheme": "basic"
+      }
+    },
+    "schemas": {
+      "VastAsset": {
+        "type": "object",
+        "properties": {
+          "adId": {
+            "type": "string",
+            "filterable": true,
+            "sortable": true,
+            "description": "Vast id"
+          },
+          "title": {
+            "type": "string",
+            "filterable": true,
+            "sortable": true,
+            "description": "Title"
+          },
+          "duration": {
+            "type": "number",
+            "filterable": true,
+            "sortable": true,
+            "description": "Duration"
+          },
+          "appId": {
+            "type": "string",
+            "filterable": true,
+            "sortable": true
+          },
+          "lastResponseTime": {
+            "format": "date-time",
+            "type": "string",
+            "filterable": true,
+            "sortable": true,
+            "description": "Last Response Time"
+          },
+          "hlsManifestUrl": {
+            "type": "string"
+          },
+          "status": {
+            "type": "string"
+          },
+          "sourceMediaUrl": {
+            "type": "string"
+          },
+          "url": {
+            "type": "string"
+          },
+          "state": {
+            "type": "string"
+          },
+          "isAllow": {
+            "type": "boolean"
+          },
+          "thumbnail": {
+            "type": "string"
+          },
+          "errorCount": {
+            "type": "number"
+          },
+          "playUrl": {
+            "type": "string"
+          },
+          "id": {
+            "type": "string"
+          },
+          "createdAt": {
+            "format": "date-time",
+            "type": "string"
+          },
+          "updatedAt": {
+            "format": "date-time",
+            "type": "string"
+          }
+        },
+        "required": [
+          "appId",
+          "hlsManifestUrl",
+          "status",
+          "sourceMediaUrl",
+          "url",
+          "state",
+          "isAllow",
+          "thumbnail",
+          "errorCount",
+          "id"
+        ]
+      },
+      "VastAssetCollection": {
+        "type": "object",
+        "properties": {
+          "data": {
+            "readOnly": true,
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/VastAsset"
+            }
+          },
+          "count": {
+            "type": "number",
+            "readOnly": true
+          },
+          "total": {
+            "type": "number",
+            "readOnly": true
+          },
+          "page": {
+            "type": "number",
+            "readOnly": true
+          },
+          "perPage": {
+            "type": "number",
+            "readOnly": true
+          }
+        },
+        "required": [
+          "count",
+          "total",
+          "page",
+          "perPage"
+        ]
+      },
+      "AllowVastDto": {
+        "type": "object",
+        "properties": {
+          "isAllow": {
+            "type": "boolean"
+          }
+        },
+        "required": [
+          "isAllow"
+        ]
+      },
+      "ChannelSettingDto": {
+        "type": "object",
+        "properties": {
+          "cdnContentSegmentPrefix": {
+            "type": "string",
+            "maxLength": 2048
+          },
+          "cdnAdSegmentPrefix": {
+            "type": "string",
+            "maxLength": 2048
+          },
+          "adMarkerPassthrough": {
+            "type": "boolean"
+          }
+        }
+      },
+      "BumperDto": {
+        "type": "object",
+        "properties": {
+          "startAssetId": {
+            "type": "string",
+            "nullable": true
+          },
+          "endAssetId": {
+            "type": "string",
+            "nullable": true
+          }
+        }
+      },
+      "CreateChannelDto": {
+        "type": "object",
+        "properties": {
+          "settings": {
+            "$ref": "#/components/schemas/ChannelSettingDto"
+          },
+          "bumper": {
+            "$ref": "#/components/schemas/BumperDto"
+          },
+          "name": {
+            "type": "string",
+            "maxLength": 256
+          },
+          "description": {
+            "type": "string"
+          },
+          "tags": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "slateAssetId": {
+            "type": "string",
+            "nullable": true
+          },
+          "origin": {
+            "type": "string",
+            "maxLength": 2048
+          },
+          "adsServer": {
+            "type": "string",
+            "maxLength": 2048
+          },
+          "delayInsertAds": {
+            "type": "number"
+          }
+        },
+        "required": [
+          "name",
+          "tags",
+          "origin",
+          "adsServer",
+          "delayInsertAds"
+        ]
+      },
+      "ChannelSettings": {
+        "type": "object",
+        "properties": {
+          "cdnContentSegmentPrefix": {
+            "type": "string",
+            "description": "CDN Content Segment Prefix"
+          },
+          "cdnAdSegmentPrefix": {
+            "type": "string",
+            "description": "CDN Ad Segment Prefix"
+          },
+          "adMarkerPassthrough": {
+            "type": "boolean",
+            "description": "Ad Marker Passthrough"
+          }
+        }
+      },
+      "Asset": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "filterable": true
+          },
+          "state": {
+            "type": "object",
+            "filterable": true
+          },
+          "type": {
+            "type": "object",
+            "filterable": true
+          },
+          "name": {
+            "type": "string",
+            "filterable": true,
+            "sortable": true
+          }
+        },
+        "required": [
+          "id",
+          "state",
+          "type",
+          "name"
+        ]
+      },
+      "Bumper": {
+        "type": "object",
+        "properties": {
+          "startAssetId": {
+            "type": "string",
+            "description": "Asset Id Bumper Start"
+          },
+          "endAssetId": {
+            "type": "string",
+            "description": "Asset Id Bumper End"
+          },
+          "startAsset": {
+            "$ref": "#/components/schemas/Asset"
+          },
+          "endAsset": {
+            "$ref": "#/components/schemas/Asset"
+          }
+        }
+      },
+      "EndpointPrefix": {
+        "type": "object",
+        "properties": {
+          "hls": {
+            "type": "string",
+            "description": "Channel HLS endpoint prefix",
+            "example": "https://ssai.sigmaott.com/ingest/hls/"
+          },
+          "dash": {
+            "type": "string",
+            "description": "Channel DASH endpoint prefix"
+          },
+          "session": {
+            "type": "string",
+            "description": "Channel session endpoint prefix"
+          }
+        },
+        "required": [
+          "hls",
+          "dash",
+          "session"
+        ]
+      },
+      "Channel": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "filterable": true,
+            "description": "channel Identify"
+          },
+          "name": {
+            "type": "string",
+            "filterable": true,
+            "sortable": true,
+            "description": "Channel SSAI name"
+          },
+          "description": {
+            "type": "string",
+            "filterable": true,
+            "description": "Channel SSAI Description"
+          },
+          "tags": {
+            "filterable": true,
+            "description": "Tag marking resource channel SSAI",
+            "example": "tag1",
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "origin": {
+            "type": "string",
+            "filterable": true,
+            "sortable": true,
+            "description": "Channel origin",
+            "example": "https://example.com/"
+          },
+          "slateAssetId": {
+            "type": "string",
+            "description": "Asset Id Of Slate "
+          },
+          "adsServer": {
+            "type": "string",
+            "filterable": true,
+            "sortable": true,
+            "description": "Channel ads server",
+            "example": "https://search.spotx.com/exchange"
+          },
+          "createdAt": {
+            "format": "date-time",
+            "type": "string",
+            "filterable": true,
+            "sortable": true
+          },
+          "updatedAt": {
+            "format": "date-time",
+            "type": "string",
+            "filterable": true,
+            "sortable": true
+          },
+          "appId": {
+            "type": "string"
+          },
+          "settings": {
+            "$ref": "#/components/schemas/ChannelSettings"
+          },
+          "bumper": {
+            "$ref": "#/components/schemas/Bumper"
+          },
+          "endpoint": {
+            "type": "string"
+          },
+          "delayInsertAds": {
+            "type": "number"
+          },
+          "endpointPrefix": {
+            "$ref": "#/components/schemas/EndpointPrefix"
+          }
+        },
+        "required": [
+          "id",
+          "name",
+          "description",
+          "tags",
+          "origin",
+          "adsServer",
+          "appId",
+          "settings",
+          "bumper",
+          "endpoint",
+          "delayInsertAds",
+          "endpointPrefix"
+        ]
+      },
+      "ChannelCollection": {
+        "type": "object",
+        "properties": {
+          "data": {
+            "readOnly": true,
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Channel"
+            }
+          },
+          "count": {
+            "type": "number",
+            "readOnly": true
+          },
+          "total": {
+            "type": "number",
+            "readOnly": true
+          },
+          "page": {
+            "type": "number",
+            "readOnly": true
+          },
+          "perPage": {
+            "type": "number",
+            "readOnly": true
+          }
+        },
+        "required": [
+          "count",
+          "total",
+          "page",
+          "perPage"
+        ]
+      },
+      "UpdateChannelDto": {
+        "type": "object",
+        "properties": {
+          "settings": {
+            "$ref": "#/components/schemas/ChannelSettingDto"
+          },
+          "bumper": {
+            "$ref": "#/components/schemas/BumperDto"
+          },
+          "name": {
+            "type": "string",
+            "maxLength": 256
+          },
+          "description": {
+            "type": "string"
+          },
+          "tags": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "slateAssetId": {
+            "type": "string",
+            "nullable": true
+          },
+          "origin": {
+            "type": "string",
+            "maxLength": 2048
+          },
+          "adsServer": {
+            "type": "string",
+            "maxLength": 2048
+          },
+          "delayInsertAds": {
+            "type": "number"
+          }
+        }
+      },
+      "TagsDto": {
+        "type": "object",
+        "properties": {
+          "tags": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        },
+        "required": [
+          "tags"
+        ]
+      },
+      "CreateSettingDto": {
+        "type": "object",
+        "properties": {
+          "enableInspectionAds": {
+            "type": "boolean"
+          }
+        },
+        "required": [
+          "enableInspectionAds"
+        ]
+      },
+      "Setting": {
+        "type": "object",
+        "properties": {
+          "createdAt": {
+            "format": "date-time",
+            "type": "string",
+            "filterable": true,
+            "description": "created at",
+            "sortable": true
+          },
+          "updatedAt": {
+            "format": "date-time",
+            "type": "string",
+            "filterable": true,
+            "description": "updated at",
+            "sortable": true
+          },
+          "appId": {
+            "type": "string",
+            "filterable": true,
+            "description": "app Id",
+            "sortable": true
+          },
+          "id": {
+            "type": "string"
+          },
+          "enableInspectionAds": {
+            "type": "boolean"
+          }
+        },
+        "required": [
+          "enableInspectionAds"
+        ]
+      }
+    }
+  }
+}