@celigo/api-specs 0.2.50 → 0.2.51
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/subscription.yml +19 -7
- package/package.json +1 -1
- package/schemas.json +1 -1
package/dist/subscription.yml
CHANGED
|
@@ -1062,31 +1062,43 @@ components:
|
|
|
1062
1062
|
example: POC – HubSpot → Snowflake
|
|
1063
1063
|
EndpointUsage:
|
|
1064
1064
|
type: object
|
|
1065
|
-
description:
|
|
1065
|
+
description: |-
|
|
1066
|
+
Endpoint entitlement usage for the requesting environment. An endpoint is a connected
|
|
1067
|
+
application, not a connection record: connections that share a Celigo-managed application
|
|
1068
|
+
profile (`assistant`) are one endpoint, generic HTTP connections without one are grouped by
|
|
1069
|
+
`baseURI`, databases by `rdbms` engine and host, and other adaptor types by their own connection
|
|
1070
|
+
identity (for example host and port). Each `endpoints[]` entry carries the fields it was grouped by.
|
|
1066
1071
|
properties:
|
|
1067
1072
|
numConsumed:
|
|
1068
1073
|
type: integer
|
|
1069
|
-
description:
|
|
1074
|
+
description: |-
|
|
1075
|
+
Endpoints counted against the entitlement in the requesting environment, one per distinct
|
|
1076
|
+
endpoint (see `endpoints`). Which flows bring an endpoint into the count follows the account's
|
|
1077
|
+
pricing model, as for `flowUsage.numEnabled`: flows that are enabled on plans that meter
|
|
1078
|
+
enabled resources, flows that ran in the billing period on plans that meter runs.
|
|
1079
|
+
x-celigo-ai-guidance:
|
|
1080
|
+
- Read the account license before interpreting this number. On run-metered plans an endpoint whose flows are enabled but have not run this period is not counted, and one used by a flow that ran even once counts for the whole period; on enabled-metered plans it is counted while any enabled flow references one of its connections, run or not.
|
|
1081
|
+
- Connections referenced by no flow are never counted, and connections to the platform's own API (`api.integrator.io`) never count. On enabled-metered plans a connection referenced only by disabled flows is not counted; on run-metered plans an endpoint used by a flow that ran this period stays counted for the period even if that flow is disabled afterwards.
|
|
1070
1082
|
example: 8
|
|
1071
1083
|
endpoints:
|
|
1072
1084
|
type: array
|
|
1073
|
-
description:
|
|
1085
|
+
description: The endpoints being counted, each with the connections that roll up into it.
|
|
1086
|
+
x-celigo-ai-guidance:
|
|
1087
|
+
- Two generic HTTP connections to the same application through different base URIs (a second store, a different API version in the path) are two endpoints; to explain an unexpected count, read each entry's `connections` and name the connection that carries the extra endpoint.
|
|
1074
1088
|
items:
|
|
1075
1089
|
type: object
|
|
1076
1090
|
properties:
|
|
1077
1091
|
type:
|
|
1078
1092
|
type: string
|
|
1079
1093
|
description: Endpoint adaptor type (e.g., `http`, `rdbms`, `ftp`).
|
|
1080
|
-
x-celigo-ai-guidance:
|
|
1081
|
-
- Endpoint type/category.
|
|
1082
1094
|
example: http
|
|
1083
1095
|
assistant:
|
|
1084
1096
|
type: string
|
|
1085
|
-
description: Application assistant identifier, if the connection uses a Celigo-managed application profile (e.g., `hubspot`, `netsuite`).
|
|
1097
|
+
description: Application assistant identifier, if the connection uses a Celigo-managed application profile (e.g., `hubspot`, `netsuite`). Connections sharing an assistant are one endpoint.
|
|
1086
1098
|
example: hubspot
|
|
1087
1099
|
baseURI:
|
|
1088
1100
|
type: string
|
|
1089
|
-
description: Base URI
|
|
1101
|
+
description: Base URI that identifies this endpoint for generic HTTP connections (those without an `assistant`); connections whose base URIs differ are separate endpoints.
|
|
1090
1102
|
example: https://api.hubspot.com
|
|
1091
1103
|
rdbms:
|
|
1092
1104
|
type: object
|
package/package.json
CHANGED