@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.4

package/dist/docs/specifications/api/docs-cloud-f5-com.0213.public.ves.io.schema.shape.bot_defense.subscription.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.shape.bot_defense.subscription","description":"Use this API to subscribe to Shape Bot Defense","version":""},"paths":{"/api/shape/bot/namespaces/system/bot-defense/addon/subscribe":{"post":{"summary":"Subscribe to Shape Bot Defense","description":"Subscribe to Shape Bot Defense","operationId":"ves.io.schema.shape.bot_defense.subscription.CustomAPI.Subscribe","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriptionSubscribeResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"$ref":"#/components/requestBodies/subscriptionSubscribeRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-subscription-customapi-subscribe"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.subscription.CustomAPI.Subscribe"},"x-displayname":"Shape Bot Defense Subscription API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.subscription.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/system/bot-defense/addon/unsubscribe":{"post":{"summary":"Unsubscribe to Shape Bot Defense","description":"Unsubscribe to Shape Bot Defense","operationId":"ves.io.schema.shape.bot_defense.subscription.CustomAPI.Unsubscribe","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriptionUnsubscribeResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"$ref":"#/components/requestBodies/subscriptionUnsubscribeRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-subscription-customapi-unsubscribe"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.subscription.CustomAPI.Unsubscribe"},"x-displayname":"Shape Bot Defense Subscription API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.subscription.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/subscribe":{"post":{"summary":"Subscribe to Shape Bot Defense","description":"Subscribe to Shape Bot Defense","operationId":"ves.io.schema.shape.bot_defense.subscription.CustomAPI.Subscribe","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriptionSubscribeResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"$ref":"#/components/requestBodies/subscriptionSubscribeRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-subscription-customapi-subscribe"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.subscription.CustomAPI.Subscribe"},"x-displayname":"Shape Bot Defense Subscription API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.subscription.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/unsubscribe":{"post":{"summary":"Unsubscribe to Shape Bot Defense","description":"Unsubscribe to Shape Bot Defense","operationId":"ves.io.schema.shape.bot_defense.subscription.CustomAPI.Unsubscribe","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriptionUnsubscribeResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"$ref":"#/components/requestBodies/subscriptionUnsubscribeRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-subscription-customapi-unsubscribe"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.subscription.CustomAPI.Unsubscribe"},"x-displayname":"Shape Bot Defense Subscription API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.subscription.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Shape Bot Defense Subscription API","x-ves-proto-package":"ves.io.schema.shape.bot_defense.subscription","components":{"requestBodies":{"subscriptionSubscribeRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriptionSubscribeRequest"}}},"required":true},"subscriptionUnsubscribeRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriptionUnsubscribeRequest"}}},"required":true}},"schemas":{"schemaEmpty":{"type":"object","description":"This can be used for messages where no values are needed","title":"Empty","x-displayname":"Empty","x-ves-proto-message":"ves.io.schema.Empty"},"subscriptionAdvancedTier":{"type":"object","description":"x-displayName: \"AdvancedTier\"\nBot Defense Tier - Advanced.","title":"AdvancedTier","properties":{"data_storage_region":{"$ref":"#/components/schemas/subscriptionBotDefenseRegion"},"namespace":{"type":"string","description":"x-displayName: \"Namespace\"\nx-required","title":"Namespace"}}},"subscriptionBasicTier":{"type":"object","description":"x-displayName: \"BasicTier\"\nBot Defense Tier - Basic.","title":"BasicTier"},"subscriptionBotDefenseRegion":{"type":"string","description":"x-displayName: \"Bot Defense Region\"\nDefines a selection for Bot Defense region\n\n - US: US\n\nx-displayName: \"US\"\nUnited States of America\n - EU: EU\n\nx-displayName: \"EU\"\nEuropean Union","title":"BotDefenseRegion","enum":["US","EU"],"default":"US"},"subscriptionPremiumTier":{"type":"object","description":"x-displayName: \"PremiumTier\"\nBot Defense Tier - Premium.","title":"PremiumTier"},"subscriptionSubscribeRequest":{"type":"object","description":"Request to subscribe to Shape Bot Defense","title":"SubscribeRequest","x-displayname":"Subscribe Request","x-ves-oneof-field-tier":"[\"standard\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.subscription.SubscribeRequest","properties":{"standard":{"$ref":"#/components/schemas/schemaEmpty"}}},"subscriptionSubscribeResponse":{"type":"object","description":"Response of subscribe to Shape Bot Defense","title":"SubscribeResponse","x-displayname":"Subscribe Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.subscription.SubscribeResponse"},"subscriptionUnsubscribeRequest":{"type":"object","description":"Request to unsubscribe to Shape Bot Defense","title":"UnsubscribeRequest","x-displayname":"Unsubscribe Request","x-ves-proto-message":"ves.io.schema.shape.bot_defense.subscription.UnsubscribeRequest"},"subscriptionUnsubscribeResponse":{"type":"object","description":"Response of unsubscribe to Shape Bot Defense","title":"UnsubscribeResponse","x-displayname":"Unsubscribe Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.subscription.UnsubscribeResponse"}}}}

package/dist/docs/specifications/api/docs-cloud-f5-com.0214.public.ves.io.schema.shape.recognize.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.shape.recognize","description":"Use this API to forward API calls into the Shape APIs","version":""},"paths":{"/api/shape/recognize/namespaces/system/recognize/addon/dashboard/channel":{"post":{"summary":"Channel Dashboard","description":"Get channel chart data from shape recognize api","operationId":"ves.io.schema.shape.recognize.CustomAPI.Channel","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recognizeChannelResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/recognizeChannelRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-recognize-customapi-channel"},"x-ves-proto-rpc":"ves.io.schema.shape.recognize.CustomAPI.Channel"},"x-displayname":"Shape Recognize Proxy","x-ves-proto-service":"ves.io.schema.shape.recognize.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/recognize/namespaces/system/recognize/addon/dashboard/conversion":{"post":{"summary":"Conversion Dashboard","description":"Get conversion chart data from shape recognize api","operationId":"ves.io.schema.shape.recognize.CustomAPI.Conversion","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recognizeConversionResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/recognizeConversionRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-recognize-customapi-conversion"},"x-ves-proto-rpc":"ves.io.schema.shape.recognize.CustomAPI.Conversion"},"x-displayname":"Shape Recognize Proxy","x-ves-proto-service":"ves.io.schema.shape.recognize.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/recognize/namespaces/system/recognize/addon/dashboard/enjoy":{"post":{"summary":"Enjoy Dashboard","description":"Get enjoy chart data from shape recognize api","operationId":"ves.io.schema.shape.recognize.CustomAPI.Enjoy","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recognizeEnjoyResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/recognizeEnjoyRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-recognize-customapi-enjoy"},"x-ves-proto-rpc":"ves.io.schema.shape.recognize.CustomAPI.Enjoy"},"x-displayname":"Shape Recognize Proxy","x-ves-proto-service":"ves.io.schema.shape.recognize.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/recognize/namespaces/system/recognize/addon/dashboard/friction_aggregation":{"post":{"summary":"Friction Aggregation Dashboard","description":"Get Friction Aggregation chart data from shape recognize api","operationId":"ves.io.schema.shape.recognize.CustomAPI.FrictionAggregation","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recognizeFrictionAggregationResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/recognizeFrictionAggregationRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-recognize-customapi-frictionaggregation"},"x-ves-proto-rpc":"ves.io.schema.shape.recognize.CustomAPI.FrictionAggregation"},"x-displayname":"Shape Recognize Proxy","x-ves-proto-service":"ves.io.schema.shape.recognize.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/recognize/namespaces/system/recognize/addon/dashboard/friction_histogram":{"post":{"summary":"Friction Histogram Dashboard","description":"Get Histogram Aggregation chart data from shape recognize api","operationId":"ves.io.schema.shape.recognize.CustomAPI.FrictionHistogram","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recognizeFrictionHistogramResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/recognizeFrictionHistogramRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-recognize-customapi-frictionhistogram"},"x-ves-proto-rpc":"ves.io.schema.shape.recognize.CustomAPI.FrictionHistogram"},"x-displayname":"Shape Recognize Proxy","x-ves-proto-service":"ves.io.schema.shape.recognize.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/recognize/namespaces/system/recognize/addon/dashboard/health":{"get":{"summary":"Health Check","description":"Health Check","operationId":"ves.io.schema.shape.recognize.CustomAPI.Health","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recognizeHealthResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-recognize-customapi-health"},"x-ves-proto-rpc":"ves.io.schema.shape.recognize.CustomAPI.Health"},"x-displayname":"Shape Recognize Proxy","x-ves-proto-service":"ves.io.schema.shape.recognize.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/recognize/namespaces/system/recognize/addon/dashboard/lift":{"post":{"summary":"Lift Dashboard","description":"Get lift chart data from shape recognize api","operationId":"ves.io.schema.shape.recognize.CustomAPI.Lift","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recognizeLiftResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/recognizeLiftRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-recognize-customapi-lift"},"x-ves-proto-rpc":"ves.io.schema.shape.recognize.CustomAPI.Lift"},"x-displayname":"Shape Recognize Proxy","x-ves-proto-service":"ves.io.schema.shape.recognize.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/recognize/namespaces/system/recognize/addon/dashboard/rescue":{"post":{"summary":"Rescue Dashboard","description":"Get rescue chart data from shape recognize api","operationId":"ves.io.schema.shape.recognize.CustomAPI.Rescue","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recognizeRescueResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/recognizeRescueRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-recognize-customapi-rescue"},"x-ves-proto-rpc":"ves.io.schema.shape.recognize.CustomAPI.Rescue"},"x-displayname":"Shape Recognize Proxy","x-ves-proto-service":"ves.io.schema.shape.recognize.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/recognize/namespaces/system/recognize/addon/dashboard/top_reason_code":{"post":{"summary":"Top Reason Codes","description":"Top Reason Codes","operationId":"ves.io.schema.shape.recognize.CustomAPI.TopReasonCodes","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recognizeTopReasonCodesResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/recognizeTopReasonCodesRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-recognize-customapi-topreasoncodes"},"x-ves-proto-rpc":"ves.io.schema.shape.recognize.CustomAPI.TopReasonCodes"},"x-displayname":"Shape Recognize Proxy","x-ves-proto-service":"ves.io.schema.shape.recognize.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/recognize/namespaces/system/recognize/addon/provision":{"get":{"summary":"Get Recognize Provision Status Addon","description":"Get Recognize provision status as add-on service","operationId":"ves.io.schema.shape.recognize.CustomAPI.GetStatusAddon","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recognizeGetStatusResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-recognize-customapi-getstatusaddon"},"x-ves-proto-rpc":"ves.io.schema.shape.recognize.CustomAPI.GetStatusAddon"},"x-displayname":"Shape Recognize Proxy","x-ves-proto-service":"ves.io.schema.shape.recognize.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/recognize/namespaces/system/recognize/addon/state":{"get":{"summary":"State","description":"Get customer State if after or before","operationId":"ves.io.schema.shape.recognize.CustomAPI.State","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recognizeStateResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-recognize-customapi-state"},"x-ves-proto-rpc":"ves.io.schema.shape.recognize.CustomAPI.State"},"x-displayname":"Shape Recognize Proxy","x-ves-proto-service":"ves.io.schema.shape.recognize.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/recognize/namespaces/system/recognize/addon/subscribe":{"post":{"summary":"Subscribe to Shape Recognize","description":"Subscribe to Shape Recognize as add-on service","operationId":"ves.io.schema.shape.recognize.CustomAPI.Subscribe","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recognizeSubscribeResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/recognizeSubscribeRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-recognize-customapi-subscribe"},"x-ves-proto-rpc":"ves.io.schema.shape.recognize.CustomAPI.Subscribe"},"x-displayname":"Shape Recognize Proxy","x-ves-proto-service":"ves.io.schema.shape.recognize.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/recognize/namespaces/system/recognize/addon/unsubscribe":{"post":{"summary":"Unsubscribe to Shape Recognize","description":"Unsubscribe to Shape Recognize as add-on service","operationId":"ves.io.schema.shape.recognize.CustomAPI.Unsubscribe","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recognizeUnsubscribeResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/recognizeUnsubscribeRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-recognize-customapi-unsubscribe"},"x-ves-proto-rpc":"ves.io.schema.shape.recognize.CustomAPI.Unsubscribe"},"x-displayname":"Shape Recognize Proxy","x-ves-proto-service":"ves.io.schema.shape.recognize.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/recognize/namespaces/system/recognize/addon/validate/src_tag_injection":{"post":{"summary":"ValidateSrcTagInjection Addon","description":"Validate src tag injection in the target url","operationId":"ves.io.schema.shape.recognize.CustomAPI.ValidateSrcTagInjectionAddon","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recognizeValidateSrcTagInjectionResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/recognizeValidateSrcTagInjectionRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-recognize-customapi-validatesrctaginjectionaddon"},"x-ves-proto-rpc":"ves.io.schema.shape.recognize.CustomAPI.ValidateSrcTagInjectionAddon"},"x-displayname":"Shape Recognize Proxy","x-ves-proto-service":"ves.io.schema.shape.recognize.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Shape Recognize Proxy","x-ves-proto-package":"ves.io.schema.shape.recognize","components":{"schemas":{"recognizeChannelData":{"type":"object","description":"Channel Data that represent the data to chart","title":"Channel Data","x-displayname":"Channel Data","x-ves-proto-message":"ves.io.schema.shape.recognize.ChannelData","properties":{"itemUnit":{"type":"string","description":" Item Unit","title":"itemUnit","x-displayname":"itemUnit"},"items":{"type":"array","description":" Items","title":"items","items":{"$ref":"#/components/schemas/recognizeChannelItem"},"x-displayname":"items"},"totalItems":{"type":"integer","description":" Total Items","title":"totalItems","format":"int32","x-displayname":"totalItems"}}},"recognizeChannelItem":{"type":"object","description":"Channel Item that represent the data to chart","title":"Channel Item","x-displayname":"Channel Item","x-ves-proto-message":"ves.io.schema.shape.recognize.ChannelItem","properties":{"OBSOLETE2_date":{"type":"integer","description":" date","title":"OBSOLETE2_date","format":"int32","x-displayname":"OBSOLETE2_date"},"OBSOLETE_date":{"type":"string","description":" date","title":"OBSOLETE_date","format":"int64","x-displayname":"OBSOLETE_date"},"date":{"type":"number","description":" date","title":"date","format":"double","x-displayname":"date"},"firstTime":{"$ref":"#/components/schemas/recognizeChannelMWItem"},"total":{"$ref":"#/components/schemas/recognizeChannelMWItem"}}},"recognizeChannelMWItem":{"type":"object","description":"Enjoy Login Item prevFailedLogin or total","title":"Enjoy Login Item","x-displayname":"Enjoy Login Item","x-ves-proto-message":"ves.io.schema.shape.recognize.ChannelMWItem","properties":{"mobile":{"type":"number","description":" mobile data\n\nExample: ` \"0.0\"`","title":"mobile","format":"double","x-displayname":"mobile","x-ves-example":"0.0"},"web":{"type":"number","description":" web data\n\nExample: ` \"0.0\"`","title":"web","format":"double","x-displayname":"web","x-ves-example":"0.0"}}},"recognizeChannelRequest":{"type":"object","description":"Since and to times to generate the Channel Request","title":"Channel Request","x-displayname":"Channel Request","x-ves-proto-message":"ves.io.schema.shape.recognize.ChannelRequest","properties":{"endTime":{"type":"string","description":" the time to we want the channel data\n\nExample: ` \"1639008000000\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"endTime","format":"int64","x-displayname":"endTime","x-ves-example":"1639008000000","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"itemUnit":{"type":"string","description":" the unit where the data is represented\n\nExample: ` \"d\"`","title":"itemUnit","x-displayname":"itemUnit","x-ves-example":"d"},"startTime":{"type":"string","description":" the time since we want the channel data\n\nExample: ` \"1607558400000\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"startTime","format":"int64","x-displayname":"startTime","x-ves-example":"1607558400000","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"recognizeChannelResponse":{"type":"object","description":"The data of Chanel Response Chart","title":"ChannelResponse","x-displayname":"Channel Response","x-ves-proto-message":"ves.io.schema.shape.recognize.ChannelResponse","properties":{"apiVersion":{"type":"string","description":" The actual version of the shape recognize api","title":"ApiVersion","x-displayname":"apiVersion"},"data":{"$ref":"#/components/schemas/recognizeChannelData"},"id":{"type":"string","description":" The Id from the Lift Response\n\nExample: ` \"b841c67034d248e7906a81ecccc90218\"`","title":"Id","x-displayname":"id","x-ves-example":"b841c67034d248e7906a81ecccc90218"}}},"recognizeConversionData":{"type":"object","description":"Conversion Data that represent all the data to fill the chart","title":"Conversion Data","x-displayname":"Conversion Data","x-ves-proto-message":"ves.io.schema.shape.recognize.ConversionData","properties":{"avgDailyConversion":{"type":"number","description":" Avarage Daily Conversion\n\nExample: ` 0.016445446197512315`","title":"avgDailyConversion","format":"double","x-displayname":"avgDailyConversion"},"avgMonthlyConversion":{"type":"number","description":" Avarage Monthly Conversion\n\nExample: ` 0.49336338592536944`","title":"avgMonthlyConversion","format":"double","x-displayname":"avgMonthlyConversion"},"itemUnit":{"type":"string","description":" The system unit to represent the data \n\nExample: ` \"d\"`","title":"itemUnit","x-displayname":"itemUnit","x-ves-example":"d"},"items":{"type":"array","description":" the collection of data to be filled into the chart","title":"items","items":{"$ref":"#/components/schemas/recognizeConversionItem"},"x-displayname":"items"},"kind":{"type":"string","description":" see if the chart is after or before extension\n\nExample: ` \"after\"`","title":"kind","x-displayname":"kind","x-ves-example":"after"},"projectionAnnualConversion":{"type":"number","description":" Projection Annual Conversion\n\nExample: ` 6.002587862091994`","title":"projectionAnnualConversion","format":"double","x-displayname":"projectionAnnualConversion"},"projectionStartTime":{"type":"number","description":" Projection Start Time\n\nExample: ` 1642462142000.0`","title":"projectionStartTime","format":"double","x-displayname":"projectionStartTime"},"totalItems":{"type":"integer","description":" Total items to be filled into the chart\n\nExample: ` 363`","title":"totalItems","format":"int32","x-displayname":"totalItems"},"yearToDateConversion":{"type":"number","description":" Year to date conversion\n\nExample: ` 5.969696969696971`","title":"yearToDateConversion","format":"double","x-displayname":"yearToDateConversion"}}},"recognizeConversionItem":{"type":"object","description":"Conversion Item that represent the data to chart","title":"Conversion Item","x-displayname":"Conversion Item","x-ves-proto-message":"ves.io.schema.shape.recognize.ConversionItem","properties":{"OBSOLETE2_date":{"type":"integer","description":" The date of the data to display in chart\n\nExample: ` 1638921600000`","title":"OBSOLETE2_date","format":"int32","x-displayname":"OBSOLETE2_date"},"OBSOLETE_date":{"type":"string","description":" The date of the data to display in chart\n\nExample: ` OBSOLETE_date`","title":"OBSOLETE_date","format":"int64","x-displayname":"date"},"count":{"type":"number","description":" The quantity data to display\n\nExample: ` \"0.2727272727272728\"`","title":"count","format":"double","x-displayname":"count","x-ves-example":"0.2727272727272728"},"date":{"type":"number","description":" The date of the data to display in chart\n\nExample: ` 1638921600000`","title":"date","format":"double","x-displayname":"date"}}},"recognizeConversionRequest":{"type":"object","description":"Since and to times to generate the Conversion request","title":"ConversionRequest","x-displayname":"Conversion Request","x-ves-proto-message":"ves.io.schema.shape.recognize.ConversionRequest","properties":{"agent":{"type":"string","description":" agent data\n\nExample: ` \"f5cs\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"agent","x-displayname":"agent","x-ves-example":"f5cs","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"endTime":{"type":"string","description":" the time to we want the conversion data\n\nExample: ` \"1639008000000\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"endTime","format":"int64","x-displayname":"endTime","x-ves-example":"1639008000000","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"itemUnit":{"type":"string","description":" the unit where the data is represented\n\nExample: ` \"d\"`","title":"itemUnit","x-displayname":"itemUnit","x-ves-example":"d"},"startTime":{"type":"string","description":" the time since we want the conversion data\n\nExample: ` \"1607558400000\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"startTime","format":"int64","x-displayname":"startTime","x-ves-example":"1607558400000","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"tenant":{"type":"string","description":" tenant data\n\nExample: ` \"miguel\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"tenant","x-displayname":"tenant","x-ves-example":"miguel","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"recognizeConversionResponse":{"type":"object","description":"The data of Conversion Response Chart","title":"ConversionResponse","x-displayname":"Conversion Response","x-ves-proto-message":"ves.io.schema.shape.recognize.ConversionResponse","properties":{"apiVersion":{"type":"string","description":" The actual version of the shape recognize api","title":"apiVersion","x-displayname":"apiVersion"},"data":{"$ref":"#/components/schemas/recognizeConversionData"},"id":{"type":"string","description":" The id from the Conversion Response\n\nExample: ` \"c85b106cef1043c486651aa072c7b593\"`","title":"id","x-displayname":"id","x-ves-example":"c85b106cef1043c486651aa072c7b593"}}},"recognizeEnjoyData":{"type":"object","description":"Enjoy Data that represent the data to chart","title":"Enjoy Data","x-displayname":"Enjoy Data","x-ves-proto-message":"ves.io.schema.shape.recognize.EnjoyData","properties":{"itemUnit":{"type":"string","description":" Item Unit","title":"itemUnit","x-displayname":"itemUnit"},"items":{"type":"array","description":" Items","title":"items","items":{"$ref":"#/components/schemas/recognizeEnjoyItem"},"x-displayname":"items"},"totalItems":{"type":"integer","description":" Total Items","title":"totalItems","format":"int32","x-displayname":"totalItems"}}},"recognizeEnjoyItem":{"type":"object","description":"Enjoy Item that represent the data to chart","title":"Enjoy Item","x-displayname":"Enjoy Item","x-ves-proto-message":"ves.io.schema.shape.recognize.EnjoyItem","properties":{"OBSOLETE2_date":{"type":"integer","description":" date","title":"OBSOLETE2_date","format":"int32","x-displayname":"OBSOLETE2_date"},"OBSOLETE_date":{"type":"string","description":" date","title":"OBSOLETE_date","format":"int64","x-displayname":"OBSOLETE_date"},"date":{"type":"number","description":" date","title":"date","format":"double","x-displayname":"date"},"prevFailedLogin":{"$ref":"#/components/schemas/recognizeEnjoyLoginItem"},"total":{"$ref":"#/components/schemas/recognizeEnjoyLoginItem"}}},"recognizeEnjoyLoginItem":{"type":"object","description":"Enjoy Login Item prevFailedLogin or total","title":"Enjoy Login Item","x-displayname":"Enjoy Login Item","x-ves-proto-message":"ves.io.schema.shape.recognize.EnjoyLoginItem","properties":{"converted":{"type":"number","description":" converted data\n\nExample: ` \"110.0\"`","title":"converted","format":"double","x-displayname":"converted","x-ves-example":"110.0"},"notConverted":{"type":"number","description":" No converted data\n\nExample: ` \"101.0\"`","title":"notConverted","format":"double","x-displayname":"notConverted","x-ves-example":"101.0"}}},"recognizeEnjoyRequest":{"type":"object","description":"Since and to times to generate the Enjoy Request","title":"Enjoy Request","x-displayname":"Enjoy Request","x-ves-proto-message":"ves.io.schema.shape.recognize.EnjoyRequest","properties":{"endTime":{"type":"string","description":" the time to we want the enjoy data\n\nExample: ` \"1639008000000\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"endTime","format":"int64","x-displayname":"endTime","x-ves-example":"1639008000000","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"itemUnit":{"type":"string","description":" the unit where the data is represented\n\nExample: ` \"d\"`","title":"itemUnit","x-displayname":"itemUnit","x-ves-example":"d"},"startTime":{"type":"string","description":" the time since we want the enjoy data\n\nExample: ` \"1607558400000\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"startTime","format":"int64","x-displayname":"startTime","x-ves-example":"1607558400000","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"recognizeEnjoyResponse":{"type":"object","description":"The data of Enjoy Response Chart","title":"EnjoyResponse","x-displayname":"Enjoy Response","x-ves-proto-message":"ves.io.schema.shape.recognize.EnjoyResponse","properties":{"apiVersion":{"type":"string","description":" The actual version of the shape recognize api","title":"ApiVersion","x-displayname":"ApiVersion"},"data":{"$ref":"#/components/schemas/recognizeEnjoyData"},"id":{"type":"string","description":" The Id from the Lift Response\n\nExample: ` \"b841c67034d248e7906a81ecccc90218\"`","title":"Id","x-displayname":"id","x-ves-example":"b841c67034d248e7906a81ecccc90218"}}},"recognizeFrictionAggregationData":{"type":"object","description":"Friction Aggregation Data that represent the data to chart","title":"Friction Aggregation Data","x-displayname":"Channel Data","x-ves-proto-message":"ves.io.schema.shape.recognize.FrictionAggregationData","properties":{"finalSuccessTotal":{"type":"number","description":" finalSuccessTotal","title":"finalSuccessTotal","format":"double","x-displayname":"finalSuccessTotal"},"firstSuccessTotal":{"type":"number","description":" firstSuccessTotal","title":"firstSuccessTotal","format":"double","x-displayname":"firstSuccessTotal"},"itemUnit":{"type":"string","description":" Item Unit","title":"itemUnit","x-displayname":"itemUnit"},"noSuccessTotal":{"type":"number","description":" noSuccessTotal","title":"noSuccessTotal","format":"double","x-displayname":"noSuccessTotal"},"spareables":{"type":"array","description":" spareables","title":"spareables","items":{"$ref":"#/components/schemas/recognizeFrictionAggregationItem"},"x-displayname":"spareables"},"totalItems":{"type":"number","description":" totalItems","title":"totalItems","format":"double","x-displayname":"totalItems"}}},"recognizeFrictionAggregationItem":{"type":"object","description":"Friction Aggregation Spareable Item data to fill the chart","title":"Friction Aggregation Item","x-displayname":"Friction Aggregation Spareable Item","x-ves-proto-message":"ves.io.schema.shape.recognize.FrictionAggregationItem","properties":{"finalSuccess":{"type":"number","description":" finalSuccess","title":"finalSuccess","format":"double","x-displayname":"FinalSuccess"},"firstSuccess":{"type":"number","description":" firstSuccess","title":"firstSuccess","format":"double","x-displayname":"FirstSuccess"},"noSuccess":{"type":"number","description":" noSuccess","title":"noSuccess","format":"double","x-displayname":"NoSuccess"},"upperBound":{"type":"number","description":" upperBound","title":"upperBound","format":"double","x-displayname":"UpperBound"}}},"recognizeFrictionAggregationRequest":{"type":"object","description":"Since and to times to generate the Friction Aggregation Request","title":"Friction Aggregation Request","x-displayname":"Friction Aggregation Request","x-ves-proto-message":"ves.io.schema.shape.recognize.FrictionAggregationRequest","properties":{"endTime":{"type":"string","description":" the time to we want the channel data\n\nExample: ` \"1639008000000\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"endTime","format":"int64","x-displayname":"endTime","x-ves-example":"1639008000000","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"itemUnit":{"type":"string","description":" the unit where the data is represented\n\nExample: ` \"d\"`","title":"itemUnit","x-displayname":"itemUnit","x-ves-example":"d"},"startTime":{"type":"string","description":" the time since we want the channel data\n\nExample: ` \"1607558400000\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"startTime","format":"int64","x-displayname":"startTime","x-ves-example":"1607558400000","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"recognizeFrictionAggregationResponse":{"type":"object","description":"The data of Friction Aggregation Response Chart","title":"Fricction Aggregation Response","x-displayname":"Friction Aggregation Response","x-ves-proto-message":"ves.io.schema.shape.recognize.FrictionAggregationResponse","properties":{"apiVersion":{"type":"string","description":" The actual version of the shape recognize api","title":"ApiVersion","x-displayname":"apiVersion"},"data":{"$ref":"#/components/schemas/recognizeFrictionAggregationData"},"id":{"type":"string","description":" The Id from the Lift Response\n\nExample: ` \"b841c67034d248e7906a81ecccc90218\"`","title":"Id","x-displayname":"id","x-ves-example":"b841c67034d248e7906a81ecccc90218"}}},"recognizeFrictionHistogramData":{"type":"object","description":"Friction Histogram Data that represent the data to chart","title":"Friction Histogram Data","x-displayname":"Friction Histogram Data","x-ves-proto-message":"ves.io.schema.shape.recognize.FrictionHistogramData","properties":{"itemUnit":{"type":"string","description":" Item Unit","title":"itemUnit","x-displayname":"itemUnit"},"items":{"type":"array","description":" items","title":"items","items":{"$ref":"#/components/schemas/recognizeFrictionHistogramItem"},"x-displayname":"items"},"totalItems":{"type":"number","description":" totalItems","title":"totalItems","format":"double","x-displayname":"totalItems"}}},"recognizeFrictionHistogramItem":{"type":"object","description":"Friction Histogram Spareable Item data to fill the chart","title":"Friction Histogram Item","x-displayname":"Friction Histogram Spareable Item","x-ves-proto-message":"ves.io.schema.shape.recognize.FrictionHistogramItem","properties":{"OBSOLETE2_date":{"type":"integer","description":" date","title":"OBSOLETE2_date","format":"int32","x-displayname":"OBSOLETE2_date"},"OBSOLETE_date":{"type":"string","description":" date","title":"OBSOLETE_date","format":"int64","x-displayname":"OBSOLETE_date"},"date":{"type":"number","description":" date","title":"date","format":"double","x-displayname":"date"},"directResetPw":{"type":"number","description":" directResetPw","title":"directResetPw","format":"double","x-displayname":"directResetPw"},"finalSuccess":{"type":"number","description":" finalSuccess","title":"finalSuccess","format":"double","x-displayname":"finalSuccess"},"firstSuccess":{"type":"number","description":" firstSuccess","title":"firstSuccess","format":"double","x-displayname":"FirstSuccess"},"loginFailResetPw":{"type":"number","description":" loginFailResetPw","title":"loginFailResetPw","format":"double","x-displayname":"loginFailResetPw"},"noSuccess":{"type":"number","description":" noSuccess","title":"noSuccess","format":"double","x-displayname":"NoSuccess"},"nonRecogUser":{"type":"number","description":" nonRecogUser","title":"nonRecogUser","format":"double","x-displayname":"nonRecogUser"},"recogUser":{"type":"number","description":" recogUser","title":"recogUser","format":"double","x-displayname":"recogUser"}}},"recognizeFrictionHistogramRequest":{"type":"object","description":"Since and to times to generate the Friction Histogram Request","title":"Friction Histogram Request","x-displayname":"Friction Histogram Request","x-ves-proto-message":"ves.io.schema.shape.recognize.FrictionHistogramRequest","properties":{"endTime":{"type":"string","description":" the time to we want the channel data\n\nExample: ` \"1639008000001\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"endTime","format":"int64","x-displayname":"endTime","x-ves-example":"1639008000001","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"itemUnit":{"type":"string","description":" the unit where the data is represented\n\nExample: ` \"d\"`","title":"itemUnit","x-displayname":"itemUnit","x-ves-example":"d"},"startTime":{"type":"string","description":" the time since we want the channel data\n\nExample: ` \"1607558400001\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"startTime","format":"int64","x-displayname":"startTime","x-ves-example":"1607558400001","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"recognizeFrictionHistogramResponse":{"type":"object","description":"The data of Friction Histogram Response","title":"Friction Histogram Response","x-displayname":"Friction Histogram Response","x-ves-proto-message":"ves.io.schema.shape.recognize.FrictionHistogramResponse","properties":{"apiVersion":{"type":"string","description":" The actual version of the shape recognize api","title":"ApiVersion","x-displayname":"apiVersion"},"data":{"$ref":"#/components/schemas/recognizeFrictionHistogramData"},"id":{"type":"string","description":" The Id from the Lift Response\n\nExample: ` \"b841c67034d248e7906a81ecccc90218\"`","title":"Id","x-displayname":"id","x-ves-example":"b841c67034d248e7906a81ecccc90218"}}},"recognizeGetStatusProvisionResponse":{"type":"object","description":"Provision struct response\nGetStatusProvisionResponse","title":"GetStatusProvisionResponse","x-displayname":"Struct of the Provision Status","x-ves-proto-message":"ves.io.schema.shape.recognize.GetStatusProvisionResponse","properties":{"code":{"type":"number","description":" code","title":"Code","format":"double","x-displayname":"202"},"status":{"type":"string","description":" status","title":"Status","x-displayname":"fail"}}},"recognizeGetStatusResponse":{"type":"object","description":"Any payload to be return by Get Provision API","title":"GetStatusResponse","x-displayname":"Recognize Provision Status Response","x-ves-proto-message":"ves.io.schema.shape.recognize.GetStatusResponse","properties":{"apiVersion":{"type":"string","description":" Provision Api Version\n\nExample: ` \"v1\"`","title":"ApiVersion","x-ves-example":"v1"},"bid":{"type":"string","description":" Backend identifier\n\nExample: ` \"test-N307-b9b88d00\"`","title":"Bid","x-displayname":"Bid","x-ves-example":"test-N307-b9b88d00"},"data":{"$ref":"#/components/schemas/recognizeGetStatusProvisionResponse"},"id":{"type":"string","description":" Id response\n\nExample: ` \"fa959ceb5e4745ada89e1d919bde7fd9\"`","title":"Id","x-ves-example":"fa959ceb5e4745ada89e1d919bde7fd9"},"src":{"type":"string","description":" Javascript tag src attribute\n\nExample: ` \"https://us.dev.zeronaught.com/__imp_apg__/js/abc.js\"`","title":"Src","x-ves-example":"https://us.dev.zeronaught.com/__imp_apg__/js/abc.js"},"tag":{"type":"string","description":" Javascript tag injected to URL paths that user configures\n\nExample: ` \"<script async defer src=\\\"https://us.dev.zeronaught.com/__imp_apg__/js/abc.js\\\"></script>\"`","title":"Tag","x-displayname":"Tag","x-ves-example":"<script async defer src=\\\"https://us.dev.zeronaught.com/__imp_apg__/js/abc.js\\\"></script>"}}},"recognizeHealthResponse":{"type":"object","description":"HealthResponse","title":"Health Response","x-displayname":"HealthResponse","x-ves-proto-message":"ves.io.schema.shape.recognize.HealthResponse","properties":{"message":{"type":"string","description":" message","title":"Message","x-displayname":"message"}}},"recognizeLiftControlItem":{"type":"object","description":"Lift Control Item absolute or relative","title":"Lift Control Item","x-displayname":"Lift Control Item","x-ves-proto-message":"ves.io.schema.shape.recognize.LiftControlItem","properties":{"control":{"type":"number","description":" control data\n\nExample: ` \"0.14545454545454545\"`","title":"control","format":"double","x-displayname":"control","x-ves-example":"0.14545454545454545"},"extended":{"type":"number","description":" extended data\n\nExample: ` \"0.16\"`","title":"extended","format":"double","x-displayname":"extended","x-ves-example":"0.16"}}},"recognizeLiftData":{"type":"object","description":"Lift Data that represent the data to chart","title":"Lift Data","x-displayname":"Lift Data","x-ves-proto-message":"ves.io.schema.shape.recognize.LiftData","properties":{"avgAbsoluteLift":{"type":"number","description":" Avarage Absolute Lift","title":"avgAbsoluteLift","format":"double","x-displayname":"avgAbsoluteLift"},"avgRelativeLift":{"type":"number","description":" Avarage Relative Lift","title":"avgRelativeLift","format":"double","x-displayname":"avgRelativeLift"},"itemUnit":{"type":"string","description":" Item Unit","title":"itemUnit","x-displayname":"itemUnit"},"items":{"type":"array","description":" Items","title":"items","items":{"$ref":"#/components/schemas/recognizeLiftItem"},"x-displayname":"items"},"totalItems":{"type":"integer","description":" Total Items","title":"totalItems","format":"int32","x-displayname":"totalItems"}}},"recognizeLiftItem":{"type":"object","description":"Lift Item that represent the data to chart","title":"Lift Item","x-displayname":"Lift Item","x-ves-proto-message":"ves.io.schema.shape.recognize.LiftItem","properties":{"OBSOLETE2_date":{"type":"integer","description":" date","title":"OBSOLETE2_date","format":"int32","x-displayname":"OBSOLETE2_date"},"OBSOLETE_date":{"type":"string","description":" date","title":"OBSOLETE_date","format":"int64","x-displayname":"OBSOLETE_date"},"absolute":{"$ref":"#/components/schemas/recognizeLiftControlItem"},"date":{"type":"number","description":" date","title":"date","format":"double","x-displayname":"date"},"relative":{"$ref":"#/components/schemas/recognizeLiftControlItem"}}},"recognizeLiftRequest":{"type":"object","description":"Since and to times to generate the Lift Request","title":"Lift Request","x-displayname":"Lift Request","x-ves-proto-message":"ves.io.schema.shape.recognize.LiftRequest","properties":{"endTime":{"type":"string","description":" the time to we want the lift data\n\nExample: ` \"1639008000000\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"endTime","format":"int64","x-displayname":"endTime","x-ves-example":"1639008000000","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"itemUnit":{"type":"string","description":" the unit where the data is represented\n\nExample: ` \"d\"`","title":"itemUnit","x-displayname":"itemUnit","x-ves-example":"d"},"startTime":{"type":"string","description":" the time since we want the lift data\n\nExample: ` \"1607558400000\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"startTime","format":"int64","x-displayname":"startTime","x-ves-example":"1607558400000","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"recognizeLiftResponse":{"type":"object","description":"The data of Lift Response Chart","title":"LiftResponse","x-displayname":"Lift Response","x-ves-proto-message":"ves.io.schema.shape.recognize.LiftResponse","properties":{"apiVersion":{"type":"string","description":" The actual version of the shape recognize api","title":"ApiVersion","x-displayname":"ApiVersion"},"data":{"$ref":"#/components/schemas/recognizeLiftData"},"id":{"type":"string","description":" The Id from the Lift Response\n\nExample: ` \"b841c67034d248e7906a81ecccc90218\"`","title":"Id","x-displayname":"id","x-ves-example":"b841c67034d248e7906a81ecccc90218"}}},"recognizeRescueData":{"type":"object","description":"Rescue Data that represent all the data to fill the chart","title":"Rescue Data","x-displayname":"Rescue Data","x-ves-proto-message":"ves.io.schema.shape.recognize.RescueData","properties":{"OBSOLETE2_endTime":{"type":"integer","description":" End Time\n\nExample: ` 1639008000000`","title":"endTime","format":"int32","x-displayname":"endTime"},"OBSOLETE2_startTime":{"type":"integer","description":" Start Time\n\nExample: ` 1607558400000`","title":"OBSOLETE2_startTime","format":"int32","x-displayname":"OBSOLETE2_startTime"},"OBSOLETE_endTime":{"type":"string","description":" End Time\n\nExample: ` \"1639008000000\"`","title":"OBSOLETE_endTime","format":"int64","x-displayname":"OBSOLETE_endTime","x-ves-example":"1639008000000"},"OBSOLETE_startTime":{"type":"string","description":" Start Time\n\nExample: ` \"1607558400000\"`","title":"OBSOLETE_startTime","format":"int64","x-displayname":"OBSOLETE_startTime","x-ves-example":"1607558400000"},"abandonLoginCount":{"type":"number","description":" Abandon Login Count\n\nExample: ` \"0.0\"`","title":"abandonLoginCount","format":"double","x-displayname":"abandonLoginCount","x-ves-example":"0.0"},"endTime":{"type":"number","description":" End Time\n\nExample: ` 1639008000000`","title":"endTime","format":"double","x-displayname":"endTime"},"itemUnit":{"type":"string","description":" The system unit to represent the data \n\nExample: ` \"d\"`","title":"itemUnit","x-displayname":"itemUnit","x-ves-example":"d"},"items":{"type":"array","description":" the collection of data to be filled into the chart","title":"items","items":{"$ref":"#/components/schemas/recognizeRescueItem"},"x-displayname":"items"},"kind":{"type":"string","description":" see if the chart is after or before extension\n\nExample: ` \"after\"`","title":"kind","x-displayname":"kind","x-ves-example":"after"},"noBenefit":{"type":"number","description":" No Benefit\n\nExample: ` \"0.10648148148148148\"`","title":"noBenefit","format":"double","x-displayname":"noBenefit","x-ves-example":"0.10648148148148148"},"startTime":{"type":"number","description":" Start Time\n\nExample: ` 1607558400000`","title":"startTime","format":"double","x-displayname":"startTime"},"totalItems":{"type":"integer","description":" Total items to be filled into the chart\n\nExample: ` \"18\"`","title":"totalItems","format":"int32","x-displayname":"totalItems","x-ves-example":"18"}}},"recognizeRescueItem":{"type":"object","description":"Conversion Item that represent the data to chart","title":"Rescue Item","x-displayname":"Rescue Item","x-ves-proto-message":"ves.io.schema.shape.recognize.RescueItem","properties":{"OBSOLETE2_upperBound":{"type":"integer","description":" The upperBound data\n\nExample: ` 0`","title":"OBSOLETE2_upperBound","format":"int32","x-displayname":"OBSOLETE2_upperBound"},"OBSOLOTE_upperBound":{"type":"string","description":" The upperBound data\n\nExample: ` 0`","title":"OBSOLOTE_upperBound","format":"int64","x-displayname":"OBSOLOTE_upperBound"},"upperBound":{"type":"number","description":" The upperBound data\n\nExample: ` 0`","title":"upperBound","format":"double","x-displayname":"upperBound"},"value":{"type":"number","description":" The value of the data to display in chart\n\nExample: ` 110.0`","title":"value","format":"double","x-displayname":"value"}}},"recognizeRescueRequest":{"type":"object","description":"Since and to times to generate the Rescue Request","title":"Rescue Request","x-displayname":"Rescue Request","x-ves-proto-message":"ves.io.schema.shape.recognize.RescueRequest","properties":{"endTime":{"type":"string","description":" the time to we want the rescue data\n\nExample: ` \"1639008000000\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"endTime","format":"int64","x-displayname":"endTime","x-ves-example":"1639008000000","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"itemUnit":{"type":"string","description":" the unit where the data is represented\n\nExample: ` \"d\"`","title":"itemUnit","x-displayname":"itemUnit","x-ves-example":"d"},"startTime":{"type":"string","description":" the time since we want the rescue data\n\nExample: ` \"1607558400000\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"startTime","format":"int64","x-displayname":"startTime","x-ves-example":"1607558400000","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"recognizeRescueResponse":{"type":"object","description":"The data of Rescue Response Chart","title":"RescueResponse","x-displayname":"Rescue Response","x-ves-proto-message":"ves.io.schema.shape.recognize.RescueResponse","properties":{"apiVersion":{"type":"string","description":" The actual version of the shape recognize api","title":"ApiVersion","x-displayname":"apiVersion"},"data":{"$ref":"#/components/schemas/recognizeRescueData"},"id":{"type":"string","description":" The Id from the Rescue Response\n\nExample: ` \"b841c67034d248e7906a81ecccc90218\"`","title":"Id","x-displayname":"id","x-ves-example":"b841c67034d248e7906a81ecccc90218"}}},"recognizeStateData":{"type":"object","description":"The data of State Data","title":"StateData","x-displayname":"State Data","x-ves-proto-message":"ves.io.schema.shape.recognize.StateData","properties":{"OBSOLETE2_jsDetectedTime":{"type":"string","description":" The detected time  \n\nExample: ` 1639008000000`","title":"OBSOLETE2_jsDetectedTime","format":"int64","x-displayname":"jsDetectedTime"},"OBSOLETE2_recommendationConsumptionTime":{"type":"string","description":" the recommendation consumption time \n\nExample: ` 1639008000000`","title":"OBSOLETE2_recommendationConsumptionTime","format":"int64","x-displayname":"recommendationConsumptionTime"},"OBSOLETE_jsDetectedTime":{"type":"string","description":" The detected time  \n\nExample: ` \"1639008000000\"`","title":"OBSOLETE_jsDetectedTime","x-displayname":"OBSOLETE_jsDetectedTime","x-ves-example":"1639008000000"},"OBSOLETE_recommendationConsumptionTime":{"type":"string","description":" the recommendation consumption time \n\nExample: ` \"1639008000000\"`","title":"OBSOLETE_recommendationConsumptionTime","x-displayname":"OBSOLETE_recommendationConsumptionTime","x-ves-example":"1639008000000"},"code":{"type":"integer","description":" The code response\n\nExample: ` \"200\"`","title":"code","format":"int32","x-displayname":"code","x-ves-example":"200"},"dashboardState":{"type":"string","description":" The conversion data to fill the chart \n\nExample: ` \"after\"`","title":"dashboardState","x-displayname":"dashboardState","x-ves-example":"after"},"jsDetectedTime":{"type":"number","description":" The detected time  \n\nExample: ` 1639008000000`","title":"jsDetectedTime","format":"double","x-displayname":"jsDetectedTime"},"recommendationConsumptionTime":{"type":"number","description":" the recommendation consumption time \n\nExample: ` 1639008000000`","title":"recommendationConsumptionTime","format":"double","x-displayname":"recommendationConsumptionTime"}}},"recognizeStateResponse":{"type":"object","description":"The data of State Response","title":"StateResponse","x-displayname":"State Response","x-ves-proto-message":"ves.io.schema.shape.recognize.StateResponse","properties":{"apiVersion":{"type":"string","description":" The actual version of the shape recognize api","title":"apiVersion","x-displayname":"apiVersion"},"data":{"$ref":"#/components/schemas/recognizeStateData"},"id":{"type":"string","description":" The id from the State Response\n\nExample: ` \"b841c67034d248e7906a81ecccc90218\"`","title":"id","x-displayname":"id","x-ves-example":"b841c67034d248e7906a81ecccc90218"}}},"recognizeSubscribeRequest":{"type":"object","description":"Any payload to be passed on the Subscribe API","title":"SubscribeRequest","x-displayname":"Subscribe Request","x-ves-proto-message":"ves.io.schema.shape.recognize.SubscribeRequest"},"recognizeSubscribeResponse":{"type":"object","description":"Any payload to be returned by Subscribe API","title":"SubscribeResponse","x-displayname":"Subscribe Response","x-ves-proto-message":"ves.io.schema.shape.recognize.SubscribeResponse"},"recognizeTopReasonCodesData":{"type":"object","description":"Top Reason Codes Data that represent all the data to fill the chart","title":"Top Reason Codes Data","x-displayname":"Top Reason Codes Data","x-ves-proto-message":"ves.io.schema.shape.recognize.TopReasonCodesData","properties":{"LOE":{"type":"number","description":" Lack of Evidence","title":"LOE","format":"double","x-displayname":"LOE"},"LSBH":{"type":"number","description":" Lack of safe browsing history\n\nExample: ` \"100\"`","title":"LSBH","format":"double","x-displayname":"LSBH","x-ves-example":"100"},"MUD":{"type":"number","description":" Multi User Device\n\nExample: ` \"250\"`","title":"MUD","format":"double","x-displayname":"MUD","x-ves-example":"250"},"SH":{"type":"number","description":" Short History\n\nExample: ` \"50\"`","title":"SH","format":"double","x-displayname":"SH","x-ves-example":"50"},"prevTotal":{"type":"number","description":" Previews Total\n\nExample: ` \"5000\"`","title":"prevTotal","format":"double","x-displayname":"prevTotal","x-ves-example":"5000"}}},"recognizeTopReasonCodesRequest":{"type":"object","description":"Top Reason Codes Request","title":"TopReasonCodesRequest","x-displayname":"TopReasonCodesRequest","x-ves-proto-message":"ves.io.schema.shape.recognize.TopReasonCodesRequest","properties":{"endTime":{"type":"string","description":" the time to we want the rescue data\n\nExample: ` \"1639008000000\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"endTime","format":"int64","x-displayname":"endTime","x-ves-example":"1639008000000","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"startTime":{"type":"string","description":" the time since we want the rescue data\n\nExample: ` \"1607558400000\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"startTime","format":"int64","x-displayname":"startTime","x-ves-example":"1607558400000","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"recognizeTopReasonCodesResponse":{"type":"object","description":"The data of Top Reason Codes Response","title":"TopReasonCodesResponse","x-displayname":"Top Reason Codes Response","x-ves-proto-message":"ves.io.schema.shape.recognize.TopReasonCodesResponse","properties":{"apiVersion":{"type":"string","description":" The actual version of the shape recognize api\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 16\n","title":"ApiVersion","maxLength":16,"x-displayname":"apiVersion","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"16"}},"data":{"$ref":"#/components/schemas/recognizeTopReasonCodesData"},"id":{"type":"string","description":" The Id from the Rescue Response\n\nExample: ` \"b841c67034d248e7906a81ecccc90218\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 256\n","title":"Id","maxLength":256,"x-displayname":"id","x-ves-example":"b841c67034d248e7906a81ecccc90218","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"256"}}}},"recognizeUnsubscribeRequest":{"type":"object","description":"Any payload to be passed on the Unsubscribe API","title":"UnsubscribeRequest","x-displayname":"Unsubscribe Request","x-ves-proto-message":"ves.io.schema.shape.recognize.UnsubscribeRequest"},"recognizeUnsubscribeResponse":{"type":"object","description":"Any payload to be returned by Unsubscribe API","title":"UnsubscribeResponse","x-displayname":"Unsubscribe Response","x-ves-proto-message":"ves.io.schema.shape.recognize.UnsubscribeResponse"},"recognizeValidateSrcTagInjectionRequest":{"type":"object","description":"Request to verify shape recognize src tag injection","title":"ValidateSrcTagInjectionRequest","x-displayname":"Validate SrcTagInjection Request","x-ves-proto-message":"ves.io.schema.shape.recognize.ValidateSrcTagInjectionRequest","properties":{"src":{"type":"string","description":" Content to be present in customer webpage's source\n\nExample: ` \" ``https://us.dev.zeronaught.com/__imp_apg__/js/abc.js`` \"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.uri_ref: true\n","title":"Src","x-displayname":"src","x-ves-example":" ``https://us.dev.zeronaught.com/__imp_apg__/js/abc.js`` ","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.uri_ref":"true"}},"url":{"type":"string","description":" Target webpage to check src tag injection\n\nExample: ` \" ``https://www.example.com`` \"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.uri: true\n","title":"Url","x-displayname":"url","x-ves-example":" ``https://www.example.com`` ","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.uri":"true"}}}},"recognizeValidateSrcTagInjectionResponse":{"type":"object","description":"Response to indicate whether customer webpage has\ncustom script tag to track devices been injected or not","title":"ValidateSrcTagInjectionResponse","x-displayname":"SrcTagInjection Response","x-ves-proto-message":"ves.io.schema.shape.recognize.ValidateSrcTagInjectionResponse","properties":{"isInjected":{"type":"boolean","description":" Status about src script tag injected in customer's webpage.\n\nExample: ` true`","title":"IsInjected","format":"boolean","x-displayname":"isInjected"},"message":{"type":"string","description":" The error string if not injected\n\nExample: ` \"unreachable\"`","title":"Message","x-displayname":"Message","x-ves-example":"unreachable"}}}}}}

package/dist/docs/specifications/api/docs-cloud-f5-com.0215.public.ves.io.schema.shape.safeap.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.shape.safeap","description":"Use this API to interact with SAFE Account Protection endpoints.\nAll calls which not include user interaction allow a blob as the payload and return a CubeJS Structure as the return parameter.","version":""},"paths":{"/api/shape/safeap/namespaces/system/safeap/addon/subscribe":{"post":{"summary":"Subscribe to Safe AP","description":"Subscribe to Safe AP as add-on service","operationId":"ves.io.schema.shape.safeap.CustomAPI.Subscribe","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/safeapSubscribeResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/safeapSubscribeRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-safeap-customapi-subscribe"},"x-ves-proto-rpc":"ves.io.schema.shape.safeap.CustomAPI.Subscribe"},"x-displayname":"Shape SAFE Account Protection","x-ves-proto-service":"ves.io.schema.shape.safeap.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/safeap/namespaces/system/safeap/addon/unsubscribe":{"post":{"summary":"Unsubscribe to Safe AP","description":"Unsubscribe to Safe AP as add-on service","operationId":"ves.io.schema.shape.safeap.CustomAPI.Unsubscribe","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/safeapUnsubscribeResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/safeapUnsubscribeRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-safeap-customapi-unsubscribe"},"x-ves-proto-rpc":"ves.io.schema.shape.safeap.CustomAPI.Unsubscribe"},"x-displayname":"Shape SAFE Account Protection","x-ves-proto-service":"ves.io.schema.shape.safeap.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/safeap/namespaces/system/safeap/dashboard/getcurrentfrauddata":{"post":{"summary":"GetCurrentFraudData","description":"Get Current Fraud data request for a time range","operationId":"ves.io.schema.shape.safeap.CustomAPI.GetCurrentFraudData","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/safeapGetCurrentFraudResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/safeapGetCurrentFraudRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-safeap-customapi-getcurrentfrauddata"},"x-ves-proto-rpc":"ves.io.schema.shape.safeap.CustomAPI.GetCurrentFraudData"},"x-displayname":"Shape SAFE Account Protection","x-ves-proto-service":"ves.io.schema.shape.safeap.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/safeap/namespaces/system/safeap/dashboard/gettopriskyaccounts":{"post":{"summary":"GetTopRiskyAccounts","description":"Get top risky accounts data request in a time range","operationId":"ves.io.schema.shape.safeap.CustomAPI.GetTopRiskyAccounts","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/safeapGetTopRiskyAccountsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/safeapGetTopRiskyAccountsRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-safeap-customapi-gettopriskyaccounts"},"x-ves-proto-rpc":"ves.io.schema.shape.safeap.CustomAPI.GetTopRiskyAccounts"},"x-displayname":"Shape SAFE Account Protection","x-ves-proto-service":"ves.io.schema.shape.safeap.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/safeap/namespaces/system/safeap/dashboard/gettopriskydevices":{"post":{"summary":"GetTopRiskyDevices","description":"Get top risky devices data request in a time range","operationId":"ves.io.schema.shape.safeap.CustomAPI.GetTopRiskyDevices","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/safeapGetTopRiskyDevicesResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/safeapGetTopRiskyDevicesRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-safeap-customapi-gettopriskydevices"},"x-ves-proto-rpc":"ves.io.schema.shape.safeap.CustomAPI.GetTopRiskyDevices"},"x-displayname":"Shape SAFE Account Protection","x-ves-proto-service":"ves.io.schema.shape.safeap.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/safeap/namespaces/system/safeap/dashboard/gettopriskyipaddresses":{"post":{"summary":"GetTopRiskyIpAddresses","description":"Get top risky ip addresses data request in a time range","operationId":"ves.io.schema.shape.safeap.CustomAPI.GetTopRiskyIpAddresses","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/safeapGetTopRiskyIpAddressesResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/safeapGetTopRiskyIpAddressesRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-safeap-customapi-gettopriskyipaddresses"},"x-ves-proto-rpc":"ves.io.schema.shape.safeap.CustomAPI.GetTopRiskyIpAddresses"},"x-displayname":"Shape SAFE Account Protection","x-ves-proto-service":"ves.io.schema.shape.safeap.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/safeap/namespaces/system/safeap/dashboard/gettopriskyreasons":{"post":{"summary":"GetTopRiskyReasons","description":"Get top risky reasons data request for a time range","operationId":"ves.io.schema.shape.safeap.CustomAPI.GetTopRiskyReasons","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/safeapGetTopRiskyReasonsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/safeapGetTopRiskyReasonsRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-safeap-customapi-gettopriskyreasons"},"x-ves-proto-rpc":"ves.io.schema.shape.safeap.CustomAPI.GetTopRiskyReasons"},"x-displayname":"Shape SAFE Account Protection","x-ves-proto-service":"ves.io.schema.shape.safeap.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/safeap/namespaces/system/safeap/dashboard/gettransactiondata":{"post":{"summary":"GetTransactionData","description":"Get Transaction data request for a time range","operationId":"ves.io.schema.shape.safeap.CustomAPI.GetTransactionData","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/safeapGetTransactionResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/safeapGetTransactionRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-safeap-customapi-gettransactiondata"},"x-ves-proto-rpc":"ves.io.schema.shape.safeap.CustomAPI.GetTransactionData"},"x-displayname":"Shape SAFE Account Protection","x-ves-proto-service":"ves.io.schema.shape.safeap.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/safeap/namespaces/system/safeap/dashboard/health":{"get":{"summary":"Health Check","description":"Health Check","operationId":"ves.io.schema.shape.safeap.CustomAPI.Health","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/safeapHealthResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-safeap-customapi-health"},"x-ves-proto-rpc":"ves.io.schema.shape.safeap.CustomAPI.Health"},"x-displayname":"Shape SAFE Account Protection","x-ves-proto-service":"ves.io.schema.shape.safeap.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/safeap/namespaces/system/safeap/dashboard/safecubejsdata":{"post":{"summary":"GetSafeCubeJSData","description":"Get Safe CubeJS data request for a given query","operationId":"ves.io.schema.shape.safeap.CustomAPI.GetSafeCubeJSData","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/safeapGetSafeCubeJSResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/safeapGetSafeCubeJSRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-safeap-customapi-getsafecubejsdata"},"x-ves-proto-rpc":"ves.io.schema.shape.safeap.CustomAPI.GetSafeCubeJSData"},"x-displayname":"Shape SAFE Account Protection","x-ves-proto-service":"ves.io.schema.shape.safeap.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Shape SAFE Account Protection","x-ves-proto-package":"ves.io.schema.shape.safeap","components":{"schemas":{"safeapGetCurrentFraudRequest":{"type":"object","description":"Any payload to be passed on the Get Current Fraud Request API\nGetCurrentFraudRequest\n\npayload to get Current Fraud Data in a given time range","title":"GetCurrentFraudRequest","x-displayname":"Get Current Fraud CubeJS Request","x-ves-proto-message":"ves.io.schema.shape.safeap.GetCurrentFraudRequest","properties":{"app_key":{"type":"string","description":" CubeJS AppKey\n\nExample: ` \"\"`","title":"app_key","x-displayname":"app_key"},"end_time":{"type":"string","description":" end_time\n\nExample: ` \"\"`","title":"end_time","x-displayname":"End Time"},"start_time":{"type":"string","description":" start_time \n\nExample: ` \"\"`","title":"start_time","x-displayname":"Start Time"}}},"safeapGetCurrentFraudResponse":{"type":"object","description":"Current Fraud response data from CubeJS","title":"GetCurrentFraudResponse","x-displayname":"GetCurrentFraudResponse","x-ves-proto-message":"ves.io.schema.shape.safeap.GetCurrentFraudResponse","properties":{"response":{"type":"string","description":" response from cubejs","title":"Response","x-displayname":"response"}}},"safeapGetSafeCubeJSRequest":{"type":"object","description":"Any payload to be passed from the SAFE Dashboard to the Safe CubeJS API","title":"GetSafeCubeJSRequest","x-displayname":"GetSafeCubeJSRequest","x-ves-proto-message":"ves.io.schema.shape.safeap.GetSafeCubeJSRequest","properties":{"app_key":{"type":"string","description":" CubeJS AppKey\n\nExample: ` \"\"`","title":"AppKey","x-displayname":"Appkey"},"query":{"type":"string","description":" Data in query string form to send parameters to backend api\n\nExample: ` \"query={\"measures\":[\"Users.count\"]}\"`","title":"Query","x-displayname":"Query","x-ves-example":"query={\"measures\":[\"Users.count\"]}"}}},"safeapGetSafeCubeJSResponse":{"type":"object","description":"Any payload to be return by Safe CubeJS API after processing the request","title":"GetSafeCubeJSResponse","x-displayname":"GetSafeCubeJSResponse","x-ves-proto-message":"ves.io.schema.shape.safeap.GetSafeCubeJSResponse","properties":{"response":{"type":"string","description":" response from cubejs","title":"Response","x-displayname":"response"}}},"safeapGetTopRiskyAccountsRequest":{"type":"object","description":"Any payload to be passed on the Get Top 5 Risky Accounts Fraud Request API\nGetTopRiskyAccountsRequest\n\npayload to get top 5 risky accounts in a given time range","title":"GetTopRiskyAccountsRequest","x-displayname":"Get Top 5 Risky Accounts CubeJS Request","x-ves-proto-message":"ves.io.schema.shape.safeap.GetTopRiskyAccountsRequest","properties":{"app_key":{"type":"string","description":" CubeJS AppKey\n\nExample: ` \"\"`","title":"app_key","x-displayname":"app_key"},"end_time":{"type":"string","description":" end_time\n\nExample: ` \"\"`","title":"end_time","x-displayname":"End Time"},"start_time":{"type":"string","description":" start_time \n\nExample: ` \"\"`","title":"start_time","x-displayname":"Start Time"}}},"safeapGetTopRiskyAccountsResponse":{"type":"object","description":"Get Top 5 Risky Accounts data from CubeJS","title":"GetTopRiskyAccountsResponse","x-displayname":"GetTopRiskyAccountsResponse","x-ves-proto-message":"ves.io.schema.shape.safeap.GetTopRiskyAccountsResponse","properties":{"response":{"type":"string","description":" response from cubejs","title":"Response","x-displayname":"response"}}},"safeapGetTopRiskyDevicesRequest":{"type":"object","description":"Any payload to be passed on the Get Top 5 Risky Devices Request API\nGetTopRiskyDevicesRequest\n\npayload to get top 5 risky devices in a given time range","title":"GetTopRiskyDevicesRequest","x-displayname":"Get Top 5 Risky Devices CubeJS Request","x-ves-proto-message":"ves.io.schema.shape.safeap.GetTopRiskyDevicesRequest","properties":{"app_key":{"type":"string","description":" CubeJS AppKey\n\nExample: ` \"\"`","title":"app_key","x-displayname":"app_key"},"end_time":{"type":"string","description":" end_time\n\nExample: ` \"\"`","title":"end_time","x-displayname":"End Time"},"start_time":{"type":"string","description":" start_time \n\nExample: ` \"\"`","title":"start_time","x-displayname":"Start Time"}}},"safeapGetTopRiskyDevicesResponse":{"type":"object","description":"Get Top 5 Risky Devices data from CubeJS","title":"GetTopRiskyDevicesResponse","x-displayname":"GetTopRiskyDevicesResponse","x-ves-proto-message":"ves.io.schema.shape.safeap.GetTopRiskyDevicesResponse","properties":{"response":{"type":"string","description":" response from cubejs","title":"Response","x-displayname":"response"}}},"safeapGetTopRiskyIpAddressesRequest":{"type":"object","description":"Any payload to be passed on the Get Top 5 Risky Ip Addresses Request API\nGetTopRiskyIpAddressesRequest\n\npayload to get top 5 risky ip addressses in a given time range","title":"GetTopRiskyIpAddressesRequest","x-displayname":"Get Top 5 Risky Ip Addresses CubeJS Request","x-ves-proto-message":"ves.io.schema.shape.safeap.GetTopRiskyIpAddressesRequest","properties":{"app_key":{"type":"string","description":" CubeJS AppKey\n\nExample: ` \"\"`","title":"app_key","x-displayname":"app_key"},"end_time":{"type":"string","description":" end_time\n\nExample: ` \"\"`","title":"end_time","x-displayname":"End Time"},"start_time":{"type":"string","description":" start_time \n\nExample: ` \"\"`","title":"start_time","x-displayname":"Start Time"}}},"safeapGetTopRiskyIpAddressesResponse":{"type":"object","description":"Get Top 5 Risky Ip Addresses data from CubeJS","title":"GetTopRiskyIpAddressesResponse","x-displayname":"GetTopRiskyIpAddressesResponse","x-ves-proto-message":"ves.io.schema.shape.safeap.GetTopRiskyIpAddressesResponse","properties":{"response":{"type":"string","description":" response from cubejs","title":"Response","x-displayname":"response"}}},"safeapGetTopRiskyReasonsRequest":{"type":"object","description":"Any payload to be passed on the Get Top 5 Risky Reasons Request API\nGetTopRiskyReasonsRequest\n\npayload to get top 5 risky reasons in a given time range","title":"GetTopRiskyReasonsRequest","x-displayname":"Get Top 5 Risky Reasons CubeJS Request","x-ves-proto-message":"ves.io.schema.shape.safeap.GetTopRiskyReasonsRequest","properties":{"app_key":{"type":"string","description":" CubeJS AppKey\n\nExample: ` \"\"`","title":"app_key","x-displayname":"app_key"},"end_time":{"type":"string","description":" end_time\n\nExample: ` \"\"`","title":"end_time","x-displayname":"End Time"},"start_time":{"type":"string","description":" start_time \n\nExample: ` \"\"`","title":"start_time","x-displayname":"Start Time"}}},"safeapGetTopRiskyReasonsResponse":{"type":"object","description":"Get Top 5 Risky Reasons data from CubeJS","title":"GetTopRiskyReasonsResponse","x-displayname":"GetTopRiskyReasonsResponse","x-ves-proto-message":"ves.io.schema.shape.safeap.GetTopRiskyReasonsResponse","properties":{"response":{"type":"string","description":" response from cubejs","title":"Response","x-displayname":"response"}}},"safeapGetTransactionRequest":{"type":"object","description":"Any payload to be passed on the Get Transaction Request API\nGetTransactionRequest\n\npayload to get Transaction Data in a given time range","title":"GetTransactionRequest","x-displayname":"Get Transaction CubeJS Request","x-ves-proto-message":"ves.io.schema.shape.safeap.GetTransactionRequest","properties":{"app_key":{"type":"string","description":" CubeJS AppKey\n\nExample: ` \"\"`","title":"app_key","x-displayname":"app_key"},"end_time":{"type":"string","description":" end_time\n\nExample: ` \"\"`","title":"end_time","x-displayname":"End Time"},"start_time":{"type":"string","description":" start_time \n\nExample: ` \"\"`","title":"start_time","x-displayname":"Start Time"}}},"safeapGetTransactionResponse":{"type":"object","description":"Transaction response data from CubeJS","title":"GetTransactionResponse","x-displayname":"GetTransactionResponse","x-ves-proto-message":"ves.io.schema.shape.safeap.GetTransactionResponse","properties":{"response":{"type":"string","description":" response from cubejs","title":"Response","x-displayname":"response"}}},"safeapHealthResponse":{"type":"object","description":"HealthResponse","title":"Health Response","x-displayname":"HealthResponse","x-ves-proto-message":"ves.io.schema.shape.safeap.HealthResponse","properties":{"message":{"type":"string","description":" message","title":"Message","x-displayname":"message"}}},"safeapSubscribeRequest":{"type":"object","description":"Any payload to be passed on the Subscribe API","title":"SubscribeRequest","x-displayname":"Subscribe Request","x-ves-proto-message":"ves.io.schema.shape.safeap.SubscribeRequest"},"safeapSubscribeResponse":{"type":"object","description":"Any payload to be returned by Subscribe API","title":"SubscribeResponse","x-displayname":"Subscribe Response","x-ves-proto-message":"ves.io.schema.shape.safeap.SubscribeResponse"},"safeapUnsubscribeRequest":{"type":"object","description":"Any payload to be passed on the Unsubscribe API","title":"UnsubscribeRequest","x-displayname":"Unsubscribe Request","x-ves-proto-message":"ves.io.schema.shape.safeap.UnsubscribeRequest"},"safeapUnsubscribeResponse":{"type":"object","description":"Any payload to be returned by Unsubscribe API","title":"UnsubscribeResponse","x-displayname":"Unsubscribe Response","x-ves-proto-message":"ves.io.schema.shape.safeap.UnsubscribeResponse"}}}}