| Deployment | +Endpoint | +
| AU | +https://api.au.sumologic.com/api/ | +
| CA | +https://api.ca.sumologic.com/api/ | +
| DE | +https://api.de.sumologic.com/api/ | +
| EU | +https://api.eu.sumologic.com/api/ | +
| FED | +https://api.fed.sumologic.com/api/ | +
| IN | +https://api.in.sumologic.com/api/ | +
| JP | +https://api.jp.sumologic.com/api/ | +
| KR | +https://api.kr.sumologic.com/api/ | +
| US1 | +https://api.sumologic.com/api/ | +
| US2 | +https://api.us2.sumologic.com/api/ | +
| HTTP Status Code | +Error Code | +Description | +
| 301 | +moved | +The requested resource SHOULD be accessed through returned URI in Location Header. See [troubleshooting](https://help.sumologic.com/docs/api/troubleshooting/#api---301-error---moved) for details. | +
| 401 | +unauthorized | +Credential could not be verified. | +
| 403 | +forbidden | +This operation is not allowed for your account type or the user doesn't have the role capability to perform this action. See [troubleshooting](https://help.sumologic.com/docs/api/troubleshooting/#api---401-error---credential-could-not-be-verified) for details. | +
| 404 | +notfound | +Requested resource could not be found. | +
| 405 | +method.unsupported | +Unsupported method for URL. | +
| 415 | +contenttype.invalid | +Invalid content type. | +
| 429 | +rate.limit.exceeded | +The API request rate is higher than 4 request per second or inflight API requests are higher than 10 request per second. | +
| 500 | +internal.error | +Internal server error. | +
| 503 | +service.unavailable | +Service is currently unavailable. | +
| Operator | +Accepted value types | +
|---|---|
| < <= > >= = | +DoubleTracingValue IntegerTracingValue | +
| between | +RangeTracingValue of DoubleTracingValue / IntegerTracingValue | +
| Operator | +Accepted value types | +
|---|---|
| < <= > >= = != | +StringTracingValue DoubleTracingValue IntegerTracingValue DateTimeTracingValue | +
| in | +ArrayTracingValue of StringTracingValue / DoubleTracingValue / IntegerTracingValue / DateTimeTracingValue | +
| between | +RangeTracingValue of StringTracingValue / DoubleTracingValue / IntegerTracingValue / DateTimeTracingValue | +
| Operator | +Accepted value types | +
|---|---|
| < <= > >= = != | +StringTracingValue DoubleTracingValue IntegerTracingValue DateTimeTracingValue | +
| in | +ArrayTracingValue of StringTracingValue / DoubleTracingValue / IntegerTracingValue / DateTimeTracingValue | +
| between | +RangeTracingValue of StringTracingValue / DoubleTracingValue / IntegerTracingValue / DateTimeTracingValue | +
30 Seconds API Will Take To Respond
+ playbookId: + type: string + description: The id of the playbook. + example: "1" + name: + type: string + description: The name of the playbook. + example: Test + versionId: + type: string + description: The version id of the playbook. + example: "1" + type: + type: string + description: The type of the playbook. + example: Analytics + description: The single monitor playbook. + MonitorContentSyncDefinition: + required: + - name + - type + type: object + properties: + type: + type: string + description: "The type of the item. Valid values are `MonitorFolderDefinition`,\ + \ `MonitorWithDependenciesDefinition`." + name: + type: string + description: The name of the item. + discriminator: + propertyName: type + NextInstancesResponse: + type: object + properties: + nextInstances: + type: array + description: list of next instances in epoch + items: + type: integer + description: epoch in millisecond + format: int64 + example: 1689119100000 + NextInstancesRequest: + required: + - rrule + - startDate + - startTime + - timezone + type: object + properties: + timezone: + type: string + description: "Time zone for the schedule per [IANA Time Zone Database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List)." + startDate: + type: string + description: Schedule start date in the format of `yyyy-mm-dd` + startTime: + type: string + description: Schedule start time in the format of `hh:mm` + rrule: + type: string + description: RRule (Recurrence Rule) + ListAlertsLibraryAlertResponse: + type: array + description: List of Alerts. + items: + $ref: '#/components/schemas/AlertsLibraryAlertResponse' + RelatedAlertsLibraryAlertResponse: + type: object + properties: + data: + type: array + description: All alerts related to the given alert and their relationship + tags. + items: + $ref: '#/components/schemas/RelatedAlert' + description: List of related Alerts. + RelatedAlert: + type: object + properties: + alert: + $ref: '#/components/schemas/AlertsLibraryAlertResponse' + relations: + type: array + description: Tags describing the relationship between the two alerts. + items: + $ref: '#/components/schemas/RelationTypeTag' + description: An alert and how it is related to the given alert + RelationTypeTag: + pattern: ^(Time|Entity)$ + type: string + description: |- + The nature of the relationship between alerts. Valid values: + 1. `Time`: Alerts are related by their time of creation. + 2. `Entity`: Alerts are related by the entities linked to their queries. + example: Time + x-pattern-message: should be either 'Time' or 'Entity' + AlertsListPageResponse: + type: object + properties: + data: + type: array + description: List of alerts summaries. + items: + $ref: '#/components/schemas/AlertsListPageObject' + description: List of Alert list page objects. + AlertsListPageObject: + type: object + properties: + id: + type: string + description: Identifier of the alert. + example: 000000000000000A + name: + type: string + description: Name of the alert. + example: CPU Total above 90 + severity: + pattern: ^(Critical|Warning|MissingData)$ + type: string + description: |- + The severity of the Alert. Valid values: + 1. `Critical` + 2. `Warning` + 3. `MissingData` + example: Warning + x-pattern-message: "should be either 'Critical', 'Warning' or 'MissingData'" + status: + pattern: ^(Active|Resolved)$ + type: string + description: |- + The status of the Alert. Valid values: + 1. `Active` + 2. `Resolved` + example: Active + x-pattern-message: should be either 'Active' or 'Resolved' + entitiesInfo: + type: array + description: | + List of AlertEntityInfo for primary entities. The primary entity is the most concrete entity (e.g. k8s container) that can be assigned per time series or log group, secondary entities are the less specific ones (e.g. k8s cluster or EC2 host). + items: + $ref: '#/components/schemas/AlertEntityInfo' + secondaryEntitiesInfo: + type: array + description: | + List of secondary AlertEntityInfo for primary entities. Primary/secondary entities are explained in description for `entitiesInfo`. + items: + $ref: '#/components/schemas/AlertEntityInfo' + violationCount: + type: string + description: The number of unique result groups that have met the alert + condition. + example: "2" + lastViolation: + type: string + description: The condition from the last alert violation. + example: greater than 90.0 for all of the last 5 minutes + duration: + type: string + description: The current duration of the alert. + example: 2 hours + createdAt: + type: string + description: The creation time of the alert. + example: "11:11 AM August 25, 2021" + lastUpdated: + type: string + description: The time when this alert was updated with the most recent violation. + example: "1:11 PM August 25, 2021" + isMuted: + type: boolean + description: True if the ARP was created while the monitor was muted + example: true + default: false + description: Alert list page object. + AlertChartDataResult: + required: + - metadata + - series + type: object + properties: + series: + type: array + description: List of time series of the alert chart data. + items: + $ref: '#/components/schemas/SeriesData' + metadata: + $ref: '#/components/schemas/AlertChartMetadata' + description: Response for alert response chart data visualization. + AlertChartMetadata: + type: object + properties: + abnormalityStartTime: + type: integer + description: The time stamp at which abnomarlity started. + format: int64 + example: 1630017549842 + abnormalityEndTime: + type: integer + description: The time stamp at which abnomarlity ended. + format: int64 + example: 1630017549842 + evaluationDelay: + type: integer + description: The delay duration for evaluating the monitor (relative to + current time). The timerange of monitor will be shifted in the past by + this delay time. + format: int64 + example: 1630017549842 + alertCreatedAt: + type: integer + description: The time stamp at which the alert response page is created. + format: int64 + example: 1630017549842 + alertResolvedAt: + type: integer + description: The time stamp at which the alert response page is resolved. + format: int64 + example: 1630017549842 + description: The metadata timestamps of alert chart data + ActiveCount: + type: integer + description: The number of currently active alerts. + format: int32 + example: 205 + PlaybookExecutionResponse: + type: object + properties: + runningId: + type: string + description: The id of the playbook which is running. + playbookExecutedId: + type: string + description: The id of the playbook when it is executed. + description: The response for executing the playbook. + PlaybookExecutionParameters: + required: + - alertId + - playbookId + type: object + properties: + playbookId: + type: string + description: The id of the playbook which needs to run. + example: "1" + alertId: + type: string + description: The alert id which needs to run the playbook. + description: The parameters for executing the playbook. + PlaybookRunningResultList: + type: array + items: + $ref: '#/components/schemas/PlaybookRunningResult' + PlaybookRunningResult: + required: + - id + - isChild + - name + - playbookId + - status + - statusCode + type: object + properties: + startDate: + type: string + description: The running start date time of the playbook. + format: date-time + example: 2018-10-16T09:10:00Z + endDate: + type: string + description: The running end date time of the playbook. + format: date-time + example: 2018-10-16T09:10:00Z + id: + type: string + description: The id of the playbook running. + playbookId: + type: string + description: The id of the playbook. + isChild: + type: boolean + description: The isChild of other playbook. + default: false + name: + type: string + description: The name of the playbook running. + status: + type: string + description: The status of the playbook running. + statusCode: + type: integer + description: The status code of the playbook running. + format: int32 + example: 200 + PlaybookRunningListRequest: + required: + - alertId + type: object + properties: + alertId: + type: string + description: The alert id. + example: "0000000000000001" + description: The request parameters for getting all running playbooks' status. + CompliancePeriodRef: + required: + - complianceRefType + type: object + properties: + complianceRefType: + pattern: ^(Relative)$ + type: string + description: Type of reference to the compliance period. Must be `Relative`. + example: Relative + x-pattern-message: Must be `Relative` + relativeShift: + type: integer + description: Relative shift of compliance period from the latest/current + compliance period. + example: -1 + description: Reference to the compliance period of the SLO. + DashboardSearchResult: + required: + - axes + - series + - status + type: object + properties: + status: + $ref: '#/components/schemas/DashboardSearchStatus' + axes: + $ref: '#/components/schemas/VisualDataAxes' + series: + type: array + description: The series returned from a search. + items: + $ref: '#/components/schemas/VisualDataSeries' + errors: + type: array + description: Errors returned by backend. + items: + $ref: '#/components/schemas/ErrorDescription' + timeRange: + $ref: '#/components/schemas/BeginBoundedTimeRange' + requestToken: + type: string + description: A user-generated string to uniquely identify the search request. + This field can be safely ignored if you don't intend to identify a search + request. + fieldOrdering: + type: array + description: | + The expected ordering of the column fields in tabular format. If null or empty, the ordering is unknown or indeterminate. + example: + - _timeslice + - _sourceHost + items: + type: string + infrequentScannedBytes: + type: number + description: The total number of scanned bytes from infrequent tier data + for the query in bytes. + format: int64 + example: 350000 + scannedBytes: + $ref: '#/components/schemas/ScannedBytes' + backfillPercent: + type: number + description: The backfill percentage of a continuous query. + format: float + DashboardSearchStatus: + required: + - state + type: object + properties: + state: + type: string + description: Current state of the search. + percentCompleted: + maximum: 100 + minimum: 0 + type: integer + description: Percentage of search completed. + format: int32 + VisualDataAxes: + required: + - x + - "y" + type: object + properties: + x: + type: array + description: The data of the primary x axis. + items: + $ref: '#/components/schemas/VisualAxisData' + "y": + type: array + description: The data of the primary y axis. + items: + $ref: '#/components/schemas/VisualAxisData' + x2: + type: array + description: The data of the secondary x axis. + items: + $ref: '#/components/schemas/VisualAxisData' + y2: + type: array + description: The data of the secondary y axis. + items: + $ref: '#/components/schemas/VisualAxisData' + VisualAxisData: + type: object + properties: + index: + type: integer + description: The value of the axis labels. + format: int32 + example: 0 + VisualDataSeries: + required: + - dataPoints + - name + - queryId + type: object + properties: + queryId: + type: string + description: The id of the query. + example: A + name: + type: string + description: | + The meaning of 'name' depends on the series type. + - For results of type 'timeseries', it is the value of the 'metric' key. + - For results of type 'nontimeseries', it is the name of one of the fields that is not part of 'xAxisKeys'. + - For results of type 'table', it is the comma-separated string of names of all fields. + example: max(Disk_Used) + dataPoints: + type: array + description: A list of data points in the visual series. + items: + $ref: '#/components/schemas/VisualPointData' + aggregateInfo: + $ref: '#/components/schemas/VisualAggregateData' + metaData: + $ref: '#/components/schemas/VisualMetaData' + seriesType: + pattern: ^(timeseries|nontimeseries|table)$|^$ + type: string + description: Type of the visual series. + example: timeseries + xAxisKeys: + type: array + description: Keys that will be plotted as a point on the x axis. + example: + - _sourceCategory + - _sourceHost + items: + type: string + valueType: + type: string + description: Value that represents if the series values are String or Double + example: Double + source: + pattern: ^(Logs|Metrics)$|^$ + type: string + description: Source of the visual series. + example: Logs + xAxisKeyTypes: + maxProperties: 1000 + type: object + additionalProperties: + type: string + description: Keys that will be plotted as a point on the x axis and their + data type + example: + _sourceCategory: String + default: {} + queryInfo: + $ref: '#/components/schemas/MetricsQueryResultInfo' + VisualPointData: + required: + - "y" + type: object + properties: + x: + type: number + description: Value that represents a point on the x axis. + format: double + example: 1.0 + "y": + type: string + description: Value that represents a point on the y axis. + example: "12.3" + isFilled: + type: boolean + description: Whether the field is interpolated or extrapolated - not derived + from underlying data. + example: false + default: false + xAxisValues: + maxProperties: 1000 + type: object + additionalProperties: + type: string + description: Values that represents a point on the x axis. + example: + _sourceCategory: collector + _collector: stag-index-7 + default: {} + outlierData: + $ref: '#/components/schemas/VisualOutlierData' + VisualOutlierData: + required: + - baseline + - isOutlier + - lowerBound + - unit + - upperBound + type: object + properties: + baseline: + type: number + description: The estimated value of the data point. + format: double + example: 1.2 + unit: + type: number + description: The variation in the estimated value of the data point. + format: double + example: 5.6 + lowerBound: + type: number + description: The lower bound of the outlier band + format: double + example: 5.3 + upperBound: + type: number + description: The upper bound of the outlier band + format: double + example: 6.3 + isOutlier: + type: boolean + description: Indicates if the data point is outlier or not. + example: false + VisualAggregateData: + required: + - avg + - latest + - max + - min + - sum + type: object + properties: + max: + type: number + description: The maximum value in the series. + format: double + example: 10.0 + min: + type: number + description: The minimum value in the series. + format: double + example: 1.2 + avg: + type: number + description: The average value in the series. + format: double + example: 5.6 + sum: + type: number + description: The sum of all the values in the series. + format: double + example: 123.4 + latest: + type: number + description: The last value in the series. + format: double + example: 23.4 + count: + type: number + description: The number of values in the series. + format: double + example: 600 + VisualMetaData: + required: + - data + type: object + properties: + data: + maxProperties: 1000 + type: object + additionalProperties: + type: string + description: The value of the metadata. + example: + deployment: dev + cluster: frontend + instance: frontend-12 + default: {} + MetricsQueryResultInfo: + type: object + properties: + rowId: + type: string + description: Metrics Query row id. + resultContext: + $ref: '#/components/schemas/MetricsQueryResultContext' + ScannedBytes: + type: object + properties: + infrequent: + type: integer + description: The total number of scanned bytes from infrequent tier data + for the query in bytes. + format: int64 + example: 350000 + continuous: + type: integer + description: The total number of scanned bytes from continuous tier data + for the query in bytes. + format: int64 + example: 350000 + frequent: + type: integer + description: The total number of scanned bytes from frequent tier data for + the query in bytes. + format: int64 + example: 350000 + security: + type: integer + description: The total number of scanned bytes from security tier data for + the query in bytes. + format: int64 + example: 350000 + tracing: + type: integer + description: The total number of scanned bytes from tracing tier data for + the query in bytes. + format: int64 + example: 350000 + upfront: + type: integer + description: The total number of scanned bytes from upfront tier data for + the query in bytes. + format: int64 + example: 350000 + metered: + type: integer + description: The total number of scanned bytes from metered tier data for + the query in bytes. + format: int64 + example: 350000 + rce: + type: integer + description: The total number of scanned bytes from rce tier data for the + query in bytes. + format: int64 + example: 350000 + flex: + type: integer + description: The total number of scanned bytes from flex tier data for the + query in bytes. + format: int64 + example: 350000 + continuousSecurity: + type: integer + description: The total number of scanned bytes from continuous security + tier data for the query in bytes. + format: int64 + example: 350000 + flexSecurity: + type: integer + description: The total number of scanned bytes from flex security tier data + for the query in bytes. + format: int64 + example: 350000 + flexUpfront: + type: integer + description: The total number of scanned bytes from flex upfront tier data + for the query in bytes. + format: int64 + example: 350000 + flexMetered: + type: integer + description: The total number of scanned bytes from flex metered tier data + for the query in bytes. + format: int64 + example: 350000 + description: | + The total number of scanned bytes from tiered data sources (ex. infrequent, continuous, frequent). See https://help.sumologic.com/docs/manage/partitions-data-tiers/data-tiers/ for a more detailed explaination. + CompliancePeriods: + required: + - periods + - timezone + type: object + properties: + timezone: + type: string + description: "Time zone for the compliance periods as per the [IANA Time\ + \ Zone Database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List)." + example: America/Los_Angeles + periods: + type: array + description: List of CompliancePeriodProgress. + items: + $ref: '#/components/schemas/CompliancePeriodProgress' + description: Compliance periods along with SLO data availability progress. + CompliancePeriodProgress: + required: + - endTime + - irrecoverableError + - progress + - relativeReference + - startTime + type: object + properties: + relativeReference: + type: integer + description: Relative shift of compliance period from the latest/current + compliance period. + example: -1 + startTime: + type: string + description: Start time of the compliance period. + format: date-time + example: 2018-10-16T09:10:00Z + endTime: + type: string + description: End time of the compliance period. + format: date-time + example: 2018-10-16T09:10:00Z + progress: + maximum: 100.0 + minimum: 0.0 + type: number + description: SLO data availability progress. + format: double + example: 50.0 + irrecoverableError: + type: boolean + description: Whether a permanent error is encountered and no further progress + is expected. + description: SLO data availability progress of a compliance period. + SliQueriesValidationResult: + type: object + properties: + isValid: + type: boolean + description: Whether or not if queries are valid. + example: false + message: + type: string + description: Message from validation. + example: "Field fieldName not found, please check the spelling and try again." + default: "" + description: Validation result for the SLI queries. + SliQueries: + required: + - queryGroup + - queryType + type: object + properties: + queryGroup: + $ref: '#/components/schemas/SliQueryGroup' + queryType: + pattern: ^(Logs|Metrics)$ + type: string + description: Type of queries for SLI (Logs/Metrics). + example: Logs + x-pattern-message: Must be `Logs` or `Metrics` + evaluationType: + pattern: ^(Window|Request|Monitor)$ + type: string + description: SLI evaluation type. + example: Window + x-pattern-message: Must be `Window` or `Request` or `Monitor` + windowSize: + type: string + description: Size of the SLI aggregation window (valid only for `Window` + evaluation type). + example: 15m + IdToSliStatusMap: + maxProperties: 1000 + type: object + additionalProperties: + $ref: '#/components/schemas/SliStatus' + description: Map of SLO identifier to SliStatus object. + SliStatus: + required: + - status + type: object + properties: + status: + pattern: ^(Success|Error|InProgress)$ + type: string + description: Whether the SLI computation is complete / had an error / is + in progress. + example: Success + sliPercentage: + type: number + description: SLI percentage for the compliance period. Available if `status` + is `Success`. + format: double + example: 95.14 + errorBudgetRemainingPercentage: + type: number + description: Percentage of error budget remaining for the compliance period. + Available if `status` is `Success`. + format: double + absoluteErrorBudgetRemaining: + type: string + description: "Formatted string for the absolute error budget remaining (time\ + \ duration for window-based SLIs, request count for request-based SLIs).\ + \ Available if `status` is `Success`." + example: "1h56m, -3h45m, -241.3k req, 1.5k req" + progressPercentage: + type: number + description: SLI computation progress. + format: double + description: "Status of the SLI computation. If the status is successful, also\ + \ contains the SLI value and error budget remaining for the current compliance\ + \ period." + SloUsageInfo: + type: array + description: The usage info of logs and metrics SLOs. + items: + $ref: '#/components/schemas/SloUsage' + SloUsage: + properties: + sliType: + pattern: ^(Logs|Metrics|Monitors)$ + type: string + description: The type of SLO usage info (Logs/Metrics/Monitor based). + example: Logs + x-pattern-message: Either `Logs` or `Metrics` or `Monitors`. + usage: + type: integer + description: Current number of active Logs/Metrics/Monitors SLOs. + example: 100 + limit: + type: integer + description: The limit of active Logs/Metrics/Monitors SLOs. + example: 100 + description: The usage info of SLOs. + SloScanEstimatesResponse: + type: object + properties: + scanEstimates: + type: array + description: Scan estimates by data tier for the SLO configuration. + items: + $ref: '#/components/schemas/TierEstimate_1' + description: SLO scan estimates. + TierEstimate_1: + type: object + properties: + tier: + type: string + description: Name of the data tier + example: Flex + perDayInBytes: + type: integer + description: estimate data scanned per day in bytes + format: int64 + perYearInBytes: + type: integer + description: estimate data scanned per year in bytes + format: int64 + description: estimate for a tier + PasswordPolicy: + type: object + properties: + minLength: + maximum: 128 + minimum: 8 + type: integer + description: The minimum length of the password. + format: int32 + example: 8 + default: 8 + maxLength: + maximum: 128 + minimum: 128 + type: integer + description: The maximum length of the password. (Setting this to any value + other than 128 is no longer supported; this field may be deprecated in + the future.) + format: int32 + example: 128 + default: 128 + mustContainLowercase: + type: boolean + description: If the password must contain lower case characters. + example: true + default: true + mustContainUppercase: + type: boolean + description: If the password must contain upper case characters. + example: true + default: true + mustContainDigits: + type: boolean + description: If the password must contain digits. + example: true + default: true + mustContainSpecialChars: + type: boolean + description: If the password must contain special characters. + example: true + default: true + maxPasswordAgeInDays: + maximum: 365 + minimum: -1 + type: integer + description: Maximum number of days that a password can be used before user + is required to change it. Put -1 if the user should not have to change + their password. + format: int32 + example: 365 + default: 365 + minUniquePasswords: + maximum: 12 + minimum: 4 + type: integer + description: The minimum number of unique new passwords that a user must + use before an old password can be reused. + format: int32 + example: 10 + default: 10 + accountLockoutThreshold: + maximum: 10 + minimum: 3 + type: integer + description: Number of failed login attempts allowed before account is locked-out. + format: int32 + example: 6 + default: 6 + failedLoginResetDurationInMins: + maximum: 10 + minimum: 1 + type: integer + description: The duration of time in minutes that must elapse from the first + failed login attempt after which failed login count is reset to 0. + format: int32 + example: 10 + default: 10 + accountLockoutDurationInMins: + maximum: 120 + minimum: 30 + type: integer + description: The duration of time in minutes that a locked-out account remained + locked before getting unlocked automatically. + format: int32 + example: 30 + default: 30 + requireMfa: + type: boolean + description: "If MFA should be required to log in. By default, this field\ + \ is set to `false`." + example: false + default: false + rememberMfa: + type: boolean + description: If MFA should be remembered on the browser. + example: true + default: true + disallowWeakPasswords: + type: boolean + description: "If weak passwords should be disallowed. By default, this field\ + \ is set to `false`." + example: false + default: false + description: Password Policy + Path: + required: + - path + - pathItems + type: object + properties: + pathItems: + type: array + description: Elements of the path. + items: + $ref: '#/components/schemas/PathItem' + path: + type: string + description: String representation of the path. + PathItem: + required: + - id + - name + type: object + properties: + id: + type: string + description: Identifier of the path element. + name: + type: string + description: Name of the path element. + description: + type: string + description: Description of the path element. + ContentCopyParams: + required: + - parentId + type: object + properties: + parentId: + type: string + description: Identifier of the parent folder to copy to. + name: + type: string + description: Optionally provide a new name. + description: + type: string + description: Optionally provide a new description. + ConfidenceScoreResponse: + required: + - confidenceScore + type: object + properties: + confidenceScore: + type: string + description: List of confidence scores to the CSE Insights. + description: CSE insight confidence score. + CseInsightConfidenceRequest: + required: + - cseInsight + type: object + properties: + cseInsight: + type: string + description: List of CSE Insight Created logs for which the confidence score + should be calculated. + example: "\"[{\\\"timestamp\\\":\\\"1605562085024\\\",\\\"type\\\":\\\"\ + event\\\",\\\"name\\\":\\\"insight_closed\\\",\\\"tenant_hash\\\":\\\"\ + d130a603dea563686c911aa5d3f196881b1e6e7a\\\",\\\"created\\\":1605550459107,\\\ + \"id\\\":\\\"ef444d0e-b1f0-351e-aae6-b608d2a4769c\\\",\\\"insight_threshold\\\ + \":12,\\\"insight_lookback_days\\\":14,\\\"resolution\\\":\\\"Resolved\\\ + \",\\\"source\\\":\\\"RULE\\\",\\\"entity_id\\\":\\\"2254232b-d7b4-567b-b4ce-61466b79e491\\\ + \",\\\"entity_type\\\":\\\"username\\\",\\\"rule_ids\\\":[\\\"MATCH-U00018\\\ + \"],\\\"mitre_tactics\\\":[\\\"Initial Access\\\"],\\\"signals\\\":[{\\\ + \"rule_id\\\":\\\"MATCH-U00018\\\",\\\"mitre_tactic\\\":\\\"Initial Access\\\ + \",\\\"timestamp\\\":\\\"1605549391000\\\",\\\"name_hash\\\":\\\"091d66fc35b6ad361d7525238d37319b06ff0bd5\\\ + \",\\\"severity\\\":5,\\\"vendors\\\":[\\\"Proofpoint\\\"],\\\"products\\\ + \":[\\\"Targeted Attack Protection\\\"],\\\"vendor_products\\\":[\\\"\ + Proofpoint Targeted Attack Protection\\\"],\\\"object_types\\\":[\\\"\ + Email\\\"]}]}]\"" + description: CSE insight JSON object. + PaginatedListEndpoints: + required: + - data + type: object + properties: + data: + type: array + description: An array of endpoints. + items: + $ref: '#/components/schemas/EndpointResponse' + next: + type: string + description: Next continuation token. + example: GDCiRv4vebF3UWFJQ1kySXBOR3Bzh69GR0RyWm9vCtc + description: List of open analytics endpoints. + EndpointResponse: + required: + - id + - inputSchema + - name + - outputSchema + - url + properties: + id: + type: string + description: Identifier of endpoint. + example: 00000000000001A5 + name: + type: string + description: Unique name of endpoint. + example: linear_regression + url: + type: string + description: Address of endpoint. + example: http://my-aws-lambda/linear-regression/predict + inputSchema: + type: string + description: Schema of the input table to endpoint. + example: "[]" + outputSchema: + type: string + description: Schema of the output table from endpoint. + example: "[]" + description: Endpoint response object. + EndpointDefinition: + required: + - headers + - inputSchema + - name + - outputSchema + - url + properties: + name: + type: string + description: Unique name of endpoint. + example: linear_regression + url: + type: string + description: Address of endpoint. + example: http://my-aws-lambda/linear-regression/predict + inputSchema: + type: string + description: Schema of the input table to endpoint. + example: "[\"field1\", \"field2\"]" + outputSchema: + type: string + description: Schema of the output table from endpoint. + example: "[\"field1\", \"field2\", \"score\"]" + headers: + type: string + description: HTTP headers for endpoint. + example: "[{\"awsRegion\": \"us-west-2\"}, {\"serviceName\": \"execute-api\"\ + }, {\"accessKey\": \"myAccessKey\"}, {\"secretKey\": \"mySecretKey\"}]" + description: Endpoint creation request object. + SignalsRequest: + required: + - signalContext + - signalTypes + type: object + properties: + signalTypes: + maxItems: 1 + minItems: 1 + type: array + description: | + A list of signal types to compute. Can be `LogFluctuation`, `DimensionalityExplanation`, `GisBenchmark` or `Anomalies` + items: + pattern: ^(LogFluctuation|DimensionalityExplanation|GisBenchmark|Anomalies)$|^$ + type: string + x-pattern-message: "Must be `LogFluctuation`, `DimensionalityExplanation`,\ + \ `GisBenchmark` or `Anomalies`" + signalContext: + $ref: '#/components/schemas/SignalContext' + description: Signal Request object. + SignalContext: + required: + - contextType + type: object + properties: + contextType: + pattern: ^(Alert)$|^$ + type: string + description: Type of context of the request object. + x-pattern-message: Must be `Alert` + discriminator: + propertyName: contextType + mapping: + Alert: '#/components/schemas/AlertSignalContext' + SignalsJobResult: + required: + - isComplete + - signals + - warnings + type: object + properties: + isComplete: + type: boolean + description: Whether the signal computing job finished. + example: true + signals: + type: array + description: Sequence of computed signals. + items: + $ref: '#/components/schemas/SignalsResponse' + warnings: + type: array + description: List of warnings while computing signals. + items: + $ref: '#/components/schemas/WarningDetails' + description: "The job result containing the job status, computed signals and\ + \ any warnings." + SignalsResponse: + required: + - endTime + - openInQueries + - payload + - signalId + - signalType + - startTime + - summary + type: object + properties: + signalType: + pattern: ^(LogFluctuation|DimensionalityExplanation|GisBenchmark|Anomalies)$|^$ + type: string + description: | + The type of the signal to compute. Can be `LogFluctuation`, `DimensionalityExplanation`, `GisBenchmark` or `Anomalies` + x-pattern-message: "Must be `LogFluctuation`, `DimensionalityExplanation`,\ + \ `GisBenchmark` or `Anomalies`" + signalId: + type: string + description: The id for the signal result in hex format. + example: 00000000F5000634 + startTime: + type: string + description: Start time of the signal. + format: date-time + example: 2018-10-16T09:10:00Z + endTime: + type: string + description: End time of the signal. + format: date-time + example: 2018-10-16T09:10:00Z + summary: + type: string + description: Description of the payload. + example: Variation in the logs + payload: + type: string + description: Json string for computed signal. + openInQueries: + type: array + description: Raw data queries for the computed signal. + items: + $ref: '#/components/schemas/OpenInQuery' + description: Signal response object. + OpenInQuery: + required: + - endTime + - query + - startTime + type: object + properties: + query: + $ref: '#/components/schemas/Query' + startTime: + type: string + description: Start time of the query. + format: date-time + example: 2018-10-16T09:10:00Z + endTime: + type: string + description: End time of the query. + format: date-time + example: 2018-10-16T09:10:00Z + description: Raw data query for the computed signal. + WarningDetails: + required: + - code + - detail + - message + type: object + properties: + code: + type: string + description: Warning code. + message: + type: string + description: Warning message. + detail: + type: string + description: Details related to warning. + description: Warning while computing signals. + ListServiceAccountModelsResponse: + required: + - data + type: object + properties: + data: + type: array + description: List of service accounts. + items: + $ref: '#/components/schemas/ServiceAccountModel' + ServiceAccountModel: + type: object + allOf: + - $ref: '#/components/schemas/CreateServiceAccountDefinition' + - $ref: '#/components/schemas/MetadataModel' + - required: + - id + properties: + id: + type: string + description: Unique identifier for the service account. + example: 000000000FE20FE2 + isActive: + type: boolean + description: True if the service account is active. + example: true + CreateServiceAccountDefinition: + required: + - email + - name + - roleIds + type: object + properties: + name: + maxLength: 128 + minLength: 0 + type: string + description: Name of the service account. + example: Service Account + email: + maxLength: 255 + type: string + description: Email address of the service account. + format: email + example: johndoe@acme.com + roleIds: + type: array + description: List of roleIds associated with the service account. + example: + - 00000000000001DF + - 00000000000002D2 + items: + type: string + UpdateServiceAccountDefinition: + type: object + properties: + name: + maxLength: 128 + minLength: 0 + type: string + description: Name of the service account. + example: Service Account + isActive: + type: boolean + description: This has the value `true` if the service account is active + and `false` if it has been deactivated. + example: true + roleIds: + type: array + description: List of role identifiers associated with the service account. + example: + - 00000000000001DF + - 00000000000002D2 + items: + type: string + email: + maxLength: 255 + type: string + description: New email address of the service account. + format: email + example: johndoe@acme.com + PaginatedListOAuthConsentsResult: + required: + - data + type: object + properties: + data: + type: array + description: An array of OAuth consents. + items: + $ref: '#/components/schemas/OAuthConsent' + next: + type: string + description: Next continuation token. + example: GDCiRv4vebF3UWFJQ1kySXBOR3Bzh69GR0RyWm9vCtc + description: List of OAuth consents. + OAuthConsent: + required: + - authorizedAt + - authorizedUser + - clientId + - clientName + - id + - scopes + type: object + properties: + id: + type: string + description: Unique identifier for the consent. + example: 0000000006743FDE + clientId: + type: string + description: The ID of the registered client that was used in granting consent. + example: zVplCFHcpTDwtktBIQmFI2K6s9HEo4HAtcQD1f1M5eQ + clientName: + type: string + description: The name of the registered client that was used in granting + consent. + example: My OAuth App + authorizedAt: + type: string + description: Timestamp when the consent was authorized in UTC in RFC3339 + format. + format: date-time + example: 2018-10-16T09:10:00Z + authorizedUser: + type: string + description: Identifier of the user who authorized the consent. + example: 0000000006743FDD + lastUsedAt: + type: string + description: Timestamp when the consent was last used to grant an access + token in UTC in RFC3339 format. Null if never used. + format: date-time + example: 2018-10-16T09:10:00Z + scopes: + type: array + description: The scopes that were granted in the consent. + example: + - manageUsersAndRoles + - viewCollectors + items: + type: string + description: An OAuth consent granted by a user. + ListSCIMUserModelsResponse: + type: object + properties: + totalResults: + type: integer + description: Total number of users that match the filter criteria + example: 100 + startIndex: + minimum: 0 + type: integer + description: The index of the first returned result + format: int32 + example: 0 + default: 0 + itemsPerPage: + type: integer + description: The number of results returned in this page + example: 10 + Resources: + type: array + description: List of SCIM user resources + items: + $ref: '#/components/schemas/SCIMUserModel' + SCIMUserModel: + type: object + allOf: + - $ref: '#/components/schemas/SCIMCreateUserDefinition' + - required: + - id + properties: + id: + type: string + description: Unique SCIM identifier for the user + example: 000000000FE20FE2 + active: + type: boolean + description: True if the user is active + example: true + meta: + $ref: '#/components/schemas/ResourceData' + SCIMCreateUserDefinition: + required: + - emails + - name + - roles + - schemas + - userName + type: object + properties: + schemas: + type: array + description: Defines the SCIM schemas for the user + example: + - urn:ietf:params:scim:schemas:core:2.0:User + items: + type: string + userName: + maxLength: 64 + type: string + description: Unique identifier for the user (email) + example: jdoe@example.com + name: + $ref: '#/components/schemas/NameInfo' + emails: + type: array + description: Sumo logic accepts only one email address + items: + type: object + properties: + value: + type: string + format: email + example: jdoe@example.com + type: + type: string + example: work + primary: + type: boolean + example: true + default: true + roles: + type: array + description: roles should exactly match with role names within sumologic. + `roles` can be either `Array of strings` or `Array of objects` as shown + in the payload. `primary` always set to 'true' as sumologic doesn't have + a concept of primary/secondary roles + example: + - - role1 + - role2 + - - value: role1 + primary: true + - value: role2 + primary: true + items: {} + NameInfo: + required: + - familyName + - givenName + type: object + properties: + givenName: + type: string + description: Given name of the user (firstName) + example: John + familyName: + type: string + description: Family name of the user (lastName) + example: Doe + ResourceData: + type: object + properties: + resourceType: + type: string + description: The name of the resource type of the resource + example: User + created: + type: string + description: Creation timestamp in date-time format + format: date-time + example: 2024-01-01T12:00:00Z + lastModified: + type: string + description: Last modification timestamp in date-time format + format: date-time + example: 2024-01-01T12:00:00Z + description: Resource meta data of a user + ErrorResponseScim: + required: + - schemas + - status + type: object + properties: + status: + type: integer + description: The HTTP status code. + example: 409 + schemas: + type: array + description: Defines the SCIM schemas for the user + example: + - urn:ietf:params:scim:schemas:core:2.0:User + items: + type: string + scimType: + type: string + description: A SCIM detail error keyword. + example: uniqueness + detail: + type: string + description: An optional fuller English-language description of the error. + example: "Your password was 5 characters long, the minimum length is 12\ + \ characters. See http://example.com/password for more information." + SCIMUpdateUserDefinition: + required: + - active + - emails + - name + - roles + - schemas + type: object + properties: + schemas: + type: array + description: Defines the SCIM schemas for the user + example: + - urn:ietf:params:scim:schemas:core:2.0:User + items: + type: string + name: + $ref: '#/components/schemas/NameInfo' + active: + type: boolean + description: Indicates if the user is active + example: true + emails: + type: array + description: Sumo logic accepts only one email address + items: + type: object + properties: + value: + type: string + format: email + example: jdoe@example.com + type: + type: string + example: work + primary: + type: boolean + example: true + default: true + roles: + type: array + description: roles should exactly match with role names within sumologic. + `roles` can be either `Array of strings` or `Array of objects` as shown + in the payload. `primary` always set to 'true' as sumologic doesn't have + a concept of primary/secondary roles + example: + - - role1 + - role2 + - - value: role1 + primary: true + - value: role2 + primary: true + items: {} + SCIMPatchUserDefinition: + required: + - Operations + - schemas + type: object + properties: + schemas: + type: array + description: Defines the SCIM schemas for the patch operation + example: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + items: + type: string + Operations: + type: array + description: Updates one or more attributes of a SCIM resource using a sequence + of operations + items: + type: object + properties: + op: + pattern: (?i)^(replace|add|remove)$ + type: string + description: "Supports 'add', 'replace' and 'remove' operations" + example: replace + x-pattern-message: "`replace`, `add`, `remove`" + path: + type: string + description: Attribute path to modify + example: name.familyName + value: + type: object + allOf: + - type: object + properties: + value: + type: string + - type: object + properties: + value: + type: array + items: + type: string + MetricsQueryResponse: + required: + - errors + - queryResults + type: object + properties: + queryResult: + type: array + description: A list of the time series returned by metric query. + items: + $ref: '#/components/schemas/TimeSeriesRow' + errors: + type: object + description: "Errors, warnings, and information logged for the query." + example: + id: AXDUI-DGH5I-TJ045 + errors: + - code: metrics:incomplete_results + message: Incomplete results + allOf: + - $ref: '#/components/schemas/ErrorResponse' + TimeSeriesRow: + required: + - rowId + - timeSeriesList + type: object + properties: + rowId: + type: string + description: Row id for the query row as specified in the request. + example: A + timeSeriesList: + $ref: '#/components/schemas/TimeSeriesList' + TimeSeriesList: + required: + - timeSeries + type: object + properties: + timeSeries: + type: array + description: A list of timeseries returned by corresponding query. + items: + $ref: '#/components/schemas/TimeSeries' + unit: + type: string + description: Unit of the query. + example: 1/second + timeShiftLabel: + type: string + description: Time shift value if specified in request in human readable + format. + example: -1h + resultContext: + $ref: '#/components/schemas/MetricsQueryResultContext' + TimeSeries: + required: + - metricDefinition + - points + type: object + properties: + metricDefinition: + $ref: '#/components/schemas/MetricDefinition' + points: + $ref: '#/components/schemas/Points' + MetricDefinition: + type: object + properties: + metric: + type: string + description: Name of the metric returning the timeseries. + example: CPU_Total + dimensions: + maxProperties: 1000 + type: object + additionalProperties: + type: string + description: Metric dimensions / metadata related to each timeseries. + example: + _sourceHost: us2-alert-1 + _sourceCategory: alert + Points: + required: + - timestamps + - values + type: object + properties: + timestamps: + type: array + description: Array of timestamps of datapoints in milliseconds. + items: + type: integer + format: int64 + example: 1623258710000 + values: + type: array + description: Array of values of datapoints corresponding to timestamp array. + items: + type: number + format: double + example: 1.5 + description: "The `values` and `timestamps` are of the same length, and points\ + \ are sorted by time ascending." + MetricsQueryResultContext: + type: object + properties: + quantizationGranularity: + type: integer + description: Quantization granularity. Size of the quantization bucket/quant + in milliseconds. + format: int64 + example: 30000 + rollup: + pattern: ^(Avg|Sum|Min|Max|Count|Rate)$|^$ + type: string + description: "We use the term rollup to refer to the aggregation function\ + \ Sumo Logic uses when quantizing metrics. Can be `Avg`, `Sum`, `Min`,\ + \ `Max`, `Count` or `Rate`." + example: Avg + actualQueryTimeRange: + $ref: '#/components/schemas/Iso8601TimeRange' + MetricsQueryRequest: + required: + - queries + - timeRange + type: object + properties: + queries: + minItems: 1 + type: array + description: A list of metrics queries. + items: + $ref: '#/components/schemas/MetricsQueryRow' + timeRange: + $ref: '#/components/schemas/ResolvableTimeRange' + description: A list of metrics queries to run along with the time range for + the query. + MetricsQueryRow: + required: + - query + - rowId + type: object + properties: + rowId: + pattern: "[A-Z]" + type: string + description: "Row id for the query row, A to Z letter." + example: A + x-pattern-message: Row id must be one character long and must be an upper + case letter between A and Z + query: + maxLength: 3000 + minLength: 3 + type: string + description: |- + A metric query consists of a metric, one or more filters and optionally, one or more [Metrics Operators](https://help.sumologic.com/?cid=10144). Strictly speaking, both filters and operators are optional. + + Most of the [Metrics Operators](https://help.sumologic.com/?cid=10144) are allowed in the query string except `fillmissing`, `outlier`, `quantize` and `timeshift`. + + * `fillmissing`: Not supported in API. + * `outlier`: Not supported in API. + * `quantize`: Only supported through `quantization` param. + * `timeshift`: Only supported through `timeshift` param. + + + In practice, your metric queries will almost always contain filters that narrow the scope of your query. For more information about the query language see [Metrics Queries](https://help.sumologic.com/?cid=1079). + example: metric=CPU_Idle + quantization: + minimum: 1 + type: integer + description: "Segregates time series data by time period. This allows you\ + \ to create aggregated results in buckets of fixed intervals (for example,\ + \ 5-minute intervals). The value is in milliseconds." + format: int64 + example: 60000 + rollup: + pattern: ^(Count|Min|Max|Sum|Avg|None)$|^$ + type: string + description: "We use the term rollup to refer to the aggregation function\ + \ Sumo Logic uses when quantizing metrics. Can be `Avg`, `Sum`, `Min`,\ + \ `Max`, `Count` or `None`." + example: Avg + x-pattern-message: "Must be `Avg`, `Sum`, `Min`, `Max`, `Count` or `None`" + timeshift: + type: integer + description: Shifts the time series from your metrics query by the specified + amount of time. This can help when comparing a time series across multiple + time periods. Specified as a signed duration in milliseconds. + format: int64 + example: -3600000 + CreateTraceQueryResponse: + required: + - queryId + type: object + properties: + queryId: + type: string + description: Id of the created query + example: cafaebf2f4f8320f + AsyncTraceQueryRequest: + required: + - queryRows + - timeRange + type: object + properties: + queryRows: + type: array + description: A list of trace queries. + items: + $ref: '#/components/schemas/AsyncTraceQueryRow' + timeRange: + $ref: '#/components/schemas/ResolvableTimeRange' + AsyncTraceQueryRow: + required: + - query + - rowId + type: object + properties: + query: + $ref: '#/components/schemas/TraceQueryExpression' + rowId: + maxLength: 16 + type: string + description: "An identifier used to reference this particular row of the\ + \ query request while fetching a query result. Within a query, row ids\ + \ must have distinct values." + example: '#A' + orderBy: + $ref: '#/components/schemas/OrderBy' + OrderBy: + required: + - fieldName + - order + type: object + properties: + fieldName: + maxLength: 32 + minLength: 1 + type: string + description: "Field based on which results should be sorted. When not provided,\ + \ the default behavior is to sort by timestamp descending. Sortable fields\ + \ values: `trace_id`, `start_timestamp`, `duration`, `spans_number`, `errors`,\ + \ `status_code`." + example: start_timestamp + order: + pattern: ^(Asc|Desc)$ + type: string + description: Type of sorting values - descending or ascending. + example: Asc + default: Desc + x-pattern-message: should be either 'Asc' or 'Desc' + TraceQueryStatusResponse: + required: + - queryRows + - status + type: object + properties: + queryRows: + type: array + description: A list of trace queries. + items: + $ref: '#/components/schemas/TraceQueryRowStatus' + status: + pattern: ^(Processing|Finished|Error|Canceled)$ + type: string + description: "Status of the query. Possible values: `Processing`, `Finished`,\ + \ `Error`, `Canceled`." + example: Processing + x-pattern-message: "Should be either `Processing`, `Finished`, `Error`,\ + \ `Canceled`." + TraceQueryRowStatus: + required: + - count + - rowId + - status + type: object + properties: + rowId: + type: string + description: A unique identifier of the query. + example: A + status: + pattern: ^(Processing|Finished|Error|Canceled)$ + type: string + description: "Status of the query. Possible values: `Processing`, `Finished`,\ + \ `Error`, `Canceled`." + example: Processing + x-pattern-message: "Should be either `Processing`, `Finished`, `Error`,\ + \ `Canceled`." + statusMessage: + type: string + description: Descriptive message of the status + example: Finished successfully + count: + minimum: 0 + type: integer + description: Number of results matching the query + format: int64 + example: 3215 + TraceQueryResultResponse: + required: + - results + type: object + properties: + results: + type: array + description: List of traces matching the query. + items: + $ref: '#/components/schemas/TraceDetail' + next: + type: string + description: Next continuation token. + example: "10001" + TraceDetail: + required: + - id + type: object + properties: + id: + type: string + description: Trace identifier. + example: 00000000000120CB + rootService: + type: string + description: "Root service which started the trace. Examples: `user-service`,\ + \ `authentication-service`, `payment-service`, `/shopping-cart`" + example: user-service + rootResource: + type: string + description: "Root resource on which the trace was started. Examples: `db.query`,\ + \ `http.request`, `rpc.call`, `container`" + example: http.request + rootStatus: + $ref: '#/components/schemas/TraceSpanStatus' + rootOperationName: + type: string + description: The name of the operation given to the root span. + example: retrieveAccount + metrics: + maxProperties: 1000 + type: object + additionalProperties: + $ref: '#/components/schemas/DoubleTracingValue' + description: Calculated trace metrics. + example: + _duration: 143984411 + startedAt: + type: string + description: "Date and time the trace was started in [ISO 8601 / RFC3339](https://tools.ietf.org/html/rfc3339)\ + \ format." + format: date-time + example: 2019-11-22T09:00:00Z + criticalPathServiceBreakdownSummary: + $ref: '#/components/schemas/CriticalPathServiceBreakdownSummary' + TraceSpanStatus: + required: + - code + type: object + properties: + code: + type: string + description: "Status code of the span. Possible values: `OK`, `ERROR`, `UNKNOWN`." + example: OK + message: + type: string + description: "Optional descriptive message about the status, could be an\ + \ http status code or the kind of an error, e.g. OSError." + example: "404" + CriticalPathServiceBreakdownSummary: + required: + - elements + - idleTime + - otherServicesDuration + type: object + properties: + elements: + type: array + description: List of the elements representing the critical path service + duration breakdown - contains the first few services with the longest + overall duration of the spans contributing to the critical path. + items: + $ref: '#/components/schemas/CriticalPathServiceBreakdownElementBase' + otherServicesDuration: + type: integer + description: Overall processing time in nanoseconds consumed by the rest + of the spans in the critical path (a sum of the duration times of the + spans' critical path segments). + format: int64 + example: 12957153 + idleTime: + type: integer + description: Overall time in nanoseconds when no particular operation was + in progress. + format: int64 + example: 60000000 + CriticalPathServiceBreakdownElementBase: + required: + - duration + type: object + properties: + service: + type: string + description: The name of the service. + example: user-service + serviceColor: + type: string + description: Color hex code assigned to the service. + example: '#fa41c6' + duration: + type: integer + description: Overall processing time in nanoseconds consumed by the spans + belonging to this service in the critical path (a sum of the duration + times of the spans' critical path segments). + format: int64 + example: 12957153 + TraceMetricsResponse: + required: + - metrics + type: object + properties: + metrics: + type: array + description: List of trace metrics. + items: + $ref: '#/components/schemas/TraceMetricDetail' + TraceMetricDetail: + required: + - metric + - type + type: object + properties: + metric: + type: string + description: Trace metric name. In trace queries it can be used in `MetricTracingFilter.metric`. + example: _duration + description: + type: string + description: Short description of the metric. + example: The duration of a trace in nanoseconds. + type: + type: string + description: "The type the values of this field will have. Possible values:\ + \ `DoubleTracingValue`, `IntegerTracingValue`." + example: IntegerTracingValue + TraceFieldsResponse: + required: + - fields + type: object + properties: + fields: + type: array + description: List of filter fields. + items: + $ref: '#/components/schemas/TraceFieldDetail' + TraceFieldDetail: + required: + - field + - fieldType + - type + type: object + properties: + field: + type: string + description: Filter field name. + example: operation + fieldType: + pattern: ^(SpanAttribute|SpanEventAttribute)$ + type: string + description: "Indicates the kind of a field. Possible values: `SpanAttribute`,\ + \ `SpanEventAttribute`." + example: SpanEventAttribute + default: SpanAttribute + x-pattern-message: "Should be one of: `SpanAttribute`, `SpanEventAttribute`." + valueListing: + type: boolean + description: Indicates whether values for this field can be listed. + example: false + description: + type: string + description: Short description of the field. + example: A piece of the workflow represented by a span + type: + type: string + description: "The type the values of this field will have. Possible values:\ + \ `DoubleTracingValue`, `IntegerTracingValue`, `StringTracingValue`, `DateTimeTracingValue`." + example: StringTracingValue + noValuesReason: + $ref: '#/components/schemas/NoTraceFieldValuesReason' + NoTraceFieldValuesReason: + required: + - code + - message + type: object + properties: + code: + pattern: ^(HighCardinalityField|AutocompleteDisabled)$ + type: string + description: "A code uniquely identifying the reason for the lack of trace\ + \ field values. Possible values: `HighCardinalityField`, `AutocompleteDisabled`." + example: HighCardinalityField + x-pattern-message: "Should be either `HighCardinalityField`, `AutocompleteDisabled`." + message: + type: string + description: A short English-language description of the reason. + example: Autocomplete has been disabled for this field due to high cardinality. + TraceFieldValuesResponse: + required: + - fieldValues + - totalCount + type: object + properties: + fieldValues: + type: array + description: List of filter field values. + items: + type: string + totalCount: + type: integer + description: Total number of values for a field matching the query. Can + be approximated when it's above 3000. + format: int64 + example: 1234 + next: + type: string + description: Next continuation token. + example: Mi93V0ZqTTBzaW89 + CreateCpcQueryResponse: + required: + - queryId + type: object + properties: + queryId: + type: string + description: The id of the created query. + example: cafaebf2f4f8320f + CpcQueryRequest: + required: + - queryRows + - timeRange + type: object + properties: + queryRows: + type: array + description: A list of cpc queries. + items: + $ref: '#/components/schemas/CpcQueryRow' + timeRange: + $ref: '#/components/schemas/ResolvableTimeRange' + CpcQueryRow: + required: + - query + - rowId + type: object + properties: + query: + $ref: '#/components/schemas/TraceQueryExpression' + rowId: + maxLength: 16 + type: string + description: "An identifier used to reference this particular row of the\ + \ query request while fetching a query result. Within a query, row ids\ + \ must have distinct values." + example: '#A' + CpcQueryStatusResponse: + required: + - queryRows + - status + type: object + properties: + queryRows: + type: array + description: A list of statuses on a per query row basis. + items: + $ref: '#/components/schemas/CpcQueryRowStatus' + status: + pattern: ^(Processing|Finished|Error|Canceled)$ + type: string + description: "Status of the query. Possible values: `Processing`, `Finished`,\ + \ `Error`, `Canceled`." + example: Processing + x-pattern-message: "Should be either `Processing`, `Finished`, `Error`,\ + \ `Canceled`." + CpcQueryRowStatus: + required: + - buckets + - rowId + - status + type: object + properties: + rowId: + type: string + description: A unique identifier of the query. + example: A + buckets: + type: array + description: A list of CPC query statuses on a per time bucket basis. Each + status corresponds to the status of calculating aggregated CPC data from + a sample of traces matching search criteria falling within a specific + time slice. + items: + $ref: '#/components/schemas/CpcQueryBucketStatus' + status: + pattern: ^(Processing|Finished|Error|Canceled)$ + type: string + description: "Status of the query. Possible values: `Processing`, `Finished`,\ + \ `Error`, `Canceled`." + example: Processing + x-pattern-message: "Should be either `Processing`, `Finished`, `Error`,\ + \ `Canceled`." + CpcQueryBucketStatus: + required: + - bucketId + - status + type: object + properties: + bucketId: + type: string + description: A unique identifier of the bucket. + example: A + status: + pattern: ^(Processing|Finished|Error|Canceled)$ + type: string + description: "Status of the query. Possible values: `Processing`, `Finished`,\ + \ `Error`, `Canceled`." + example: Processing + x-pattern-message: "Should be either `Processing`, `Finished`, `Error`,\ + \ `Canceled`." + statusMessage: + type: string + description: Descriptive message of the status. + example: Finished successfully + CpcQueryResultResponse: + required: + - buckets + type: object + properties: + buckets: + type: array + description: A list of CPC query results on a per time bucket basis. Each + bucket result corresponds to the aggregated CPC data from a sample of + traces matching search criteria falling within a specific time slice. + items: + $ref: '#/components/schemas/CpcQueryBucketResult' + CpcQueryBucketResult: + required: + - avgTraceDuration + - bucketId + - idleTimeCpcSummary + - length + - otherServicesCpcSummary + - perServiceCpcSummaries + - startTimestamp + - totalNumOfTraces + type: object + properties: + bucketId: + type: string + description: A unique identifier of a time bucket. + example: bucket1 + startTimestamp: + type: string + description: "A start of the time bucket in the [ISO 8601 / RFC3339](https://tools.ietf.org/html/rfc3339)\ + \ format." + format: date-time + example: 2021-04-19T17:36:57.47623Z + length: + type: integer + description: The length of a time bucket expressed in milliseconds. + format: int64 + example: 60000 + totalNumOfTraces: + type: integer + description: The total number of traces matching the search criteria based + on which the CPC data is aggregated. + format: int64 + example: 500 + avgTraceDuration: + type: number + description: The average duration in nanoseconds of the traces matching + the search criteria based on which the CPC data is aggregated. + format: double + example: 5000 + perServiceCpcSummaries: + type: array + description: The summary of aggregated Critical Path Contribution data on + a per service basis. Each element of the array corresponds to a summary + for a specific service. + items: + $ref: '#/components/schemas/CpcServiceSummary' + otherServicesCpcSummary: + $ref: '#/components/schemas/CpcSummary' + idleTimeCpcSummary: + $ref: '#/components/schemas/CpcSummary' + CpcServiceSummary: + required: + - color + - cpcSummary + - service + type: object + properties: + service: + type: string + description: The name of the service. + example: user-service + color: + type: string + description: The color hex code assigned to the service. + example: '#fa41c6' + cpcSummary: + $ref: '#/components/schemas/CpcSummary' + CpcSummary: + required: + - avgPercentageInTrace + - avgTimeInTrace + - numOfTraces + - totalTimeTaken + type: object + properties: + numOfTraces: + type: integer + description: The total number of traces matching the search criteria for + a given service based on which the CPC data is aggregated. + format: int64 + example: 200 + avgPercentageInTrace: + type: number + description: The total fraction (value between 0.0 and 1.0) of the trace + duration time consumed by a given service (or a group of services) in + the critical path of analyzed traces. + format: double + example: 0.24 + avgTimeInTrace: + type: number + description: The average time in nanoseconds spent by a given service (or + a group of services) in the critical path of analyzed traces. + format: double + example: 520000 + totalTimeTaken: + type: integer + description: The total time in nanoseconds spent by a given service (or + a group of services) in the critical path of analyzed traces. + format: int64 + example: 600000 + CpcQueryResultRequest: + required: + - bucketIds + type: object + properties: + bucketIds: + type: array + description: A list of the identifiers of CPC query buckets for which aggregated + Critical Path Contribution data should be fetched. + example: + - bucket1 + - bucket2 + items: + type: string + CreateAggregationQueryResponse: + required: + - queryId + type: object + properties: + queryId: + type: string + description: The id of the created query. + example: cafaebf2f4f8320f + AggregationQueryRequest: + required: + - queryRows + - timeRange + - xAxisGroupByAttribute + type: object + properties: + queryRows: + type: array + description: A list of tracing queries. + items: + $ref: '#/components/schemas/AggregationQueryRow' + timeRange: + $ref: '#/components/schemas/ResolvableTimeRange' + xAxisGroupByAttribute: + $ref: '#/components/schemas/AggregationGroupByAttribute' + AggregationQueryRow: + required: + - query + - rowId + type: object + properties: + query: + $ref: '#/components/schemas/TraceQueryExpression' + rowId: + maxLength: 16 + type: string + description: "An identifier used to reference this particular row of the\ + \ query request while fetching a query result. Within a query, row ids\ + \ must have distinct values." + example: '#A' + AggregationGroupByAttribute: + required: + - attributeType + type: object + properties: + attributeType: + type: string + description: Attribute type of the object model. + description: Base group by attribute object. + discriminator: + propertyName: attributeType + AggregationQueryStatusResponse: + required: + - queryRows + - status + type: object + properties: + queryRows: + type: array + description: A list of statuses on a per query row basis. + items: + $ref: '#/components/schemas/AggregationQueryRowStatus' + status: + pattern: ^(Processing|Finished|Error|Canceled)$ + type: string + description: "Status of the query. Possible values: `Processing`, `Finished`,\ + \ `Error`, `Canceled`." + example: Processing + x-pattern-message: "Should be either `Processing`, `Finished`, `Error`,\ + \ `Canceled`." + statusMessage: + type: string + description: Descriptive message of the status. + example: Finished successfully + AggregationQueryRowStatus: + required: + - rowId + - status + type: object + properties: + rowId: + type: string + description: A unique identifier of the query. + example: A + status: + pattern: ^(Processing|Finished|Error|Canceled)$ + type: string + description: "Status of the query. Possible values: `Processing`, `Finished`,\ + \ `Error`, `Canceled`." + example: Processing + x-pattern-message: "Should be either `Processing`, `Finished`, `Error`,\ + \ `Canceled`." + statusMessage: + type: string + description: Descriptive message of the status. + example: Finished successfully + AggregationQueryResultResponse: + required: + - buckets + type: object + properties: + buckets: + type: array + description: A list of an aggregation query results on a per bucket basis. Each + bucket result corresponds to the number of trace query results falling + into the bucket. + items: + $ref: '#/components/schemas/AggregationQueryBucketResult' + AggregationQueryBucketResult: + required: + - bucketKey + - bucketValue + type: object + properties: + bucketKey: + $ref: '#/components/schemas/BucketKey' + bucketValue: + $ref: '#/components/schemas/BucketValue' + BucketKey: + required: + - bucketKeyType + type: object + properties: + bucketKeyType: + type: string + description: Bucket value type of the object model. + description: Base bucket key object. + discriminator: + propertyName: bucketKeyType + BucketValue: + required: + - bucketValueType + - traceCount + type: object + properties: + bucketValueType: + type: string + description: Bucket value type of the object model. + traceCount: + type: integer + description: The number of traces per bucket. + format: int64 + example: 42 + description: Base bucket value object. + discriminator: + propertyName: bucketValueType + TraceExistsResponse: + required: + - exists + type: object + properties: + exists: + type: boolean + description: Indicates whether the trace with the given trace id exists. + example: true + url: + type: string + description: A path to the trace view page in Sumo Logic UI. + example: '#/trace/00000000000120CB' + TraceSpansResponse: + required: + - spans + - totalCount + type: object + properties: + spanPage: + type: array + description: List of trace spans. + items: + $ref: '#/components/schemas/TraceSpan' + totalCount: + type: integer + description: Total count of spans for this trace. + format: int64 + example: 1234 + next: + type: string + description: Next continuation token. + example: dlFXd0lhSkxzRjAwYnpVZkMrRmlhYnF4cGtNMWdnVEI + TraceSpan: + required: + - duration + - id + - operationName + - startedAt + - status + type: object + properties: + id: + type: string + description: Identifier of the span. + example: 00000000002317A9 + parentId: + type: string + description: "Identifier of the parent span, if any. If the span has no\ + \ parent it's considered a root span." + example: 000000000003C7BE + operationName: + type: string + description: The name of the operation given to the span. + example: retrieveAccount + resource: + type: string + description: The name of the resource attached to the span. + example: http.request + service: + type: string + description: The name of the service this span is part of. + example: user-service + serviceColor: + type: string + description: Color hex code assigned to the service. + example: '#fa41c6' + serviceType: + $ref: '#/components/schemas/ServiceType' + duration: + type: integer + description: Number of nanoseconds the span lasted. + format: int64 + example: 212957153 + startedAt: + type: string + description: "Date and time the span was started in the [ISO 8601 / RFC3339](https://tools.ietf.org/html/rfc3339)\ + \ format." + format: date-time + example: 2019-11-22T09:00:00Z + status: + $ref: '#/components/schemas/TraceSpanStatus' + kind: + pattern: ^(CLIENT|SERVER|PRODUCER|CONSUMER|INTERNAL)$ + type: string + description: "Span kind describes the relationship between the Span, its\ + \ parents, and its children in a Trace. Possible values: `CLIENT`, `SERVER`,\ + \ `PRODUCER`, `CONSUMER`, `INTERNAL`." + example: SERVER + x-pattern-message: "Should be either `CLIENT`, `SERVER`, `PRODUCER`, `CONSUMER`\ + \ or `INTERNAL`." + remoteService: + type: string + description: Name of the possible remote span's service. + example: external-service + remoteServiceColor: + type: string + description: Color hex code assigned to the remote service. + example: '#fa41c6' + remoteServiceType: + $ref: '#/components/schemas/ServiceType' + info: + $ref: '#/components/schemas/TraceSpanInfo' + numberOfLinks: + type: integer + description: Number of span links in this span. + format: int32 + example: 2 + ServiceType: + pattern: ^(Db|HTTP|MQ|Web|Mixed|Unknown|Cpp|DotNET|Erlang|Go|Java|NodeJS|Php|Python|Ruby|WebJS|Swift|MSSQL|MySQL|Oracle|Db2|PostgreSQL|Redshift|Hive|Cloudscape|HSQLDB|Progress|MaxDB|HANADB|Ingres|FirstSQL|EnterpriseDB|Cache|Adabas|Firebird|ApacheDerby|FileMaker|Informix|InstantDB|InterBase|MariaDB|Netezza|PervasivePSQL|PointBase|SQLite|Sybase|Teradata|Vertica|H2|ColdFusion|Cassandra|HBase|MongoDB|Redis|Couchbase|CouchDB|CosmosDB|DynamoDB|Neo4j|Geode|Elasticsearch|Memcached|CockroachDB|RPC|gRPC|JavaRMI|DotNETWCF|ApacheDubbo)$ + type: string + description: Defines type of service. + example: HTTP + x-pattern-message: "Should be either `Db`, `HTTP`, `MQ`, `Web`, `Mixed`, `Unknown`,\ + \ `Cpp`, `DotNET`, `Erlang`, `Go`, `Java`, `NodeJS`, `Php`, `Python`, `Ruby`,\ + \ `WebJS`, `Swift`, `MSSQL`, `MySQL`, `Oracle`, `Db2`, `PostgreSQL`, `Redshift`,\ + \ `Hive`, `Cloudscape`, `HSQLDB`, `Progress`, `MaxDB`, `HANADB`, `Ingres`,\ + \ `FirstSQL`, `EnterpriseDB`, `Cache`, `Adabas`, `Firebird`, `ApacheDerby`,\ + \ `FileMaker`, `Informix`, `InstantDB`, `InterBase`, `MariaDB`, `Netezza`,\ + \ `PervasivePSQL`, `PointBase`, `SQLite`, `Sybase`, `Teradata`, `Vertica`,\ + \ `H2`, `ColdFusion`, `Cassandra`, `HBase`, `MongoDB`, `Redis`, `Couchbase`,\ + \ `CouchDB`, `CosmosDB`, `DynamoDB`, `Neo4j`, `Geode`, `Elasticsearch`, `Memcached`,\ + \ `CockroachDB`, `RPC`, `gRPC`, `JavaRMI`, `DotNETWCF` or `ApacheDubbo`" + TraceSpanInfo: + required: + - type + type: object + properties: + type: + type: string + description: "Type of this span. Possible values: `TraceHttpSpanInfo`, `TraceDbSpanInfo`,\ + \ `TraceMessageBusSpanInfo`." + example: TraceHttpSpanInfo + discriminator: + propertyName: type + TagsReversedIndexResponse: + type: object + properties: + tagsIndices: + maxItems: 1000 + minItems: 0 + type: array + description: List of spans tag values indices. + items: + $ref: '#/components/schemas/TagReversedIndex' + attributesIndices: + maxItems: 1000 + minItems: 0 + type: array + description: List of spans attribute values indices. + items: + $ref: '#/components/schemas/AttributeReversedIndex' + next: + type: string + description: Next continuation token. + example: dlFXd0lhSkxzRjAwYnpVZkMrRmlhYnF4cGtNMWdnVEI + TagReversedIndex: + required: + - tagName + - tagValueStatistics + type: object + properties: + tagName: + maxLength: 128 + minLength: 1 + type: string + description: Name of the tag. + example: k8s.container.name + tagValueStatistics: + maxItems: 1000 + minItems: 1 + type: array + description: List of value statistics of the given tag. + items: + $ref: '#/components/schemas/TagValueReversedIndex' + TagValueReversedIndex: + required: + - spanIds + - tagValue + type: object + properties: + tagValue: + maxLength: 128 + minLength: 1 + type: string + description: Value of the tag. + example: web-proxy + spanIds: + maxItems: 1000 + minItems: 1 + type: array + description: List of span ids which have the given tag and value. + example: + - 52c3f60425aba353 + - 432630b74ac37c60 + items: + type: string + AttributeReversedIndex: + required: + - attributeName + - attributeValueStatistics + type: object + properties: + attributeName: + maxLength: 128 + minLength: 1 + type: string + description: Name of the attribute. + example: service + attributeValueStatistics: + maxItems: 1000 + minItems: 1 + type: array + description: List of value statistics of the given attribute. + items: + $ref: '#/components/schemas/AttributeValueReversedIndex' + AttributeValueReversedIndex: + required: + - attributeValue + - spanIds + type: object + properties: + attributeValue: + maxLength: 128 + minLength: 1 + type: string + description: Value of the attribute. + example: rest-soa + spanIds: + maxItems: 1000 + minItems: 1 + type: array + description: List of span ids which have the given attribute and value. + example: + - 52c3f60425aba343 + - 432630b74ac37c50 + items: + type: string + TraceLightEventsResponse: + type: object + properties: + spanEvents: + maxProperties: 1000 + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/LightSpanEvent' + description: "Map of span ids to lists of their events, without their attributes." + next: + type: string + description: Next continuation token. + example: dlFXd0lhSkxzRjAwYnpVZkMrRmlhYnF4cGtNMWdnVEI + LightSpanEvent: + required: + - name + - timestamp + type: object + properties: + timestamp: + type: string + description: "Time when an event happened in the [ISO 8601 / RFC3339](https://tools.ietf.org/html/rfc3339)\ + \ format." + format: date-time + example: 2021-04-19T17:36:57.47623Z + name: + type: string + description: Name of the event. + example: domContentLoadedEventStart + description: "Light version of Span Event, without the attributes." + CriticalPathResponse: + required: + - segments + type: object + properties: + segments: + type: array + description: List of span segments from the critical path. + items: + $ref: '#/components/schemas/SpanPathSegment' + next: + type: string + description: Next continuation token. + example: Mi93V0ZqTTBzaW89 + SpanPathSegment: + required: + - duration + - ratio + - spanId + - startOffset + type: object + properties: + spanId: + type: string + description: Span identifier. + example: 00000000000120CB + service: + type: string + description: The name of the service this span is part of. + example: user-service + serviceColor: + type: string + description: Color hex code assigned to the service. + example: '#fa41c6' + startOffset: + type: integer + description: Number of nanoseconds from the span startedAt the segment started. + format: int64 + example: 311285715 + duration: + type: integer + description: Number of nanoseconds the span segment lasted. + format: int64 + example: 12957153 + fraction: + type: number + description: The fraction (value between 0.0 and 1.0) from the trace duration + time this segment took. + format: double + example: 0.4 + CriticalPathServiceBreakdownResponse: + required: + - elements + - idleTime + type: object + properties: + elements: + type: array + description: List of elements representing the critical path service breakdown. + items: + $ref: '#/components/schemas/CriticalPathServiceBreakdownElementDetail' + idleTime: + type: integer + description: Overall time in nanoseconds when no particular operation was + in progress. + format: int64 + example: 60000000 + CriticalPathServiceBreakdownElementDetail: + allOf: + - $ref: '#/components/schemas/CriticalPathServiceBreakdownElementBase' + - required: + - longestSegmentDuration + - numSpans + type: object + properties: + numSpans: + type: integer + description: Number of spans that are part of this service. + format: int32 + example: 12957153 + longestSegmentDuration: + type: integer + description: Number of nanoseconds the longest span segment in the critical + path lasted. + format: int64 + example: 12957153 + TraceSpanDetail: + allOf: + - $ref: '#/components/schemas/TraceSpan' + - type: object + properties: + errorMessage: + type: string + description: "Produced error message (could be a stack trace, database\ + \ error code, ..)" + example: | + Exception in thread "local[9]" java.lang.OutOfMemoryError: Java heap space + at my.app.force.fields.SpaceShipForceField.main(SpaceShipForceField.java:17) + fields: + type: object + additionalProperties: + $ref: '#/components/schemas/TracingValue' + description: Fields attached to this span. + example: + component: + type: StringTracingValue + value: http + http.request.method: + type: StringTracingValue + value: GET + url.full: + type: StringTracingValue + value: https://example.com/v1/users/123 + http.response.status_code: + type: StringTracingValue + value: "200" + criticalPathContribution: + $ref: '#/components/schemas/TraceSpanCriticalPathContribution' + logs: + type: array + description: Logs attached to this span. + example: + - "[19/Dec/2019:10:58:21 +0000] 'GET /v1/users/123 HTTP/1.1' 200 8215\ + \ 'http://111.111.11.1/' 'Mozilla/5.0 (Macintosh; Intel Mac OS X 11_11_1)\ + \ AppleWebKit/111.11 (KHTML, like Gecko) Chrome/11.1.1111.11 Safari/111.11'" + - "[19/Dec/2019:10:58:24 +0000] 'GET /logo.png HTTP/1.1' 404 555 'http://111.111.11.1/'\ + \ 'Mozilla/5.0 (Macintosh; Intel Mac OS X 11_11_1) AppleWebKit/111.11\ + \ (KHTML, like Gecko) Chrome/11.1.1111.11 Safari/111.11'" + items: + type: string + events: + type: array + description: Events attached to this span. + items: + $ref: '#/components/schemas/SpanEvent' + links: + type: array + description: List of casually related spans. + items: + $ref: '#/components/schemas/SpanLink' + TraceSpanCriticalPathContribution: + required: + - duration + - fraction + type: object + properties: + duration: + type: integer + description: Overall processing time in nanoseconds consumed by this span + in the critical path of its trace (a sum of the duration times of this + span's critical path segments). + format: int64 + example: 12957153 + fraction: + type: number + description: The total fraction (value between 0.0 and 1.0) of the trace + duration time consumed by this span in the critical path of its trace. + format: double + example: 0.4 + SpanEvent: + description: Span event containing all information (in particular attributes). + allOf: + - $ref: '#/components/schemas/LightSpanEvent' + - type: object + properties: + attributes: + type: array + description: Span event attributes. + items: + $ref: '#/components/schemas/SpanEventAttribute' + SpanEventAttribute: + type: object + properties: + attributeName: + type: string + description: Name of the attribute. + example: message_details + attributeValue: + $ref: '#/components/schemas/EventAttributeValue' + SpanLink: + required: + - spanId + - traceId + type: object + properties: + traceId: + type: string + description: Trace identifier of the linked span. + example: 00000000002317A9 + spanId: + type: string + description: Span identifier of the linked span. + example: 000000000003C7BE + description: Details of the linked span. + TraceSpanBillingInfo: + required: + - billedBytes + - billedFormat + type: object + properties: + billedBytes: + type: integer + description: Number of bytes that were charged for the span. + example: 529 + billedFormat: + type: string + description: Billing format of the span. Number of bytes of this representation + of the span is equal to `billedBytes`. + example: traceId=2ff9c457b1aa00f4;spanId=97872e33215c4275;parentSpanId=98bcdfc5da874c40;operation=spanId-97872e33215c4275;startTimestamp=1603283111874000000;endTimestamp=1603283112268000000;service=ServiceA;status.code=ERROR;status.message=ERROR;kind=SERVER;custom-tag-2=value2;_sourcehost=127.0.0.1;url.full=https://example.com/api/operation-x;message=Some + error message;_sourcecategory=Http Input;custom-tag-1=value1;error=true;_sourcename=Http + Input;error.kind=InvalidInput;_collector=trace-generator-collector;http.request.method=GET; + SpanQueryResponse: + required: + - queryId + - queryRows + type: object + properties: + queryId: + type: string + description: Id of the created query + queryRows: + type: array + description: A list of row responses with details about individual queries. + items: + $ref: '#/components/schemas/SpanQueryRowResponse' + hasErrors: + type: boolean + description: Indicates whether there was an error while executing the query. + example: true + default: false + timeRange: + $ref: '#/components/schemas/BeginBoundedTimeRange' + SpanQueryRowResponse: + required: + - isAggregation + - rowId + type: object + properties: + rowId: + type: string + description: A unique identifier of the query. + example: A + errors: + type: array + description: List of errors which occured when executing the query + items: + $ref: '#/components/schemas/SpanQueryRowError' + isAggregation: + type: boolean + description: Indicates whether this query is an aggregation + example: true + default: false + executedQuery: + type: string + description: The executed query after rewriting + example: _index=_trace_spans traceId=00000000002317A9 + SpanQueryRowError: + required: + - code + - message + type: object + properties: + code: + type: string + description: The error code. + example: spanquery:query_validation_error + message: + type: string + description: Short description of the occured error. + example: Query A was invalid + details: + type: string + description: Details about the occured error. + example: "[1.78] failure: '(' expected but ')' found." + SpanQueryRequest: + required: + - queryRows + - timeRange + type: object + properties: + queryRows: + type: array + description: A list of span analytics queries. + items: + $ref: '#/components/schemas/SpanQueryRow' + timeRange: + $ref: '#/components/schemas/ResolvableTimeRange' + timeZone: + type: string + description: "Time zone for the query time ranges. Follow the format in\ + \ the [IANA Time Zone Database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List)." + example: America/Los_Angeles + default: UTC + SpanQueryRow: + required: + - queryString + - rowId + type: object + properties: + queryString: + type: string + description: Query string using the log search syntax. + rowId: + pattern: "^[a-zA-Z0-9_]*$" + type: string + description: "An identifier used to reference this particular row of the\ + \ query request. Within a query, row ids must have distinct values." + example: A + SpanQueryStatusResponse: + required: + - queryRows + - status + type: object + properties: + queryRows: + type: array + description: A list of span analytics queries. + items: + $ref: '#/components/schemas/SpanQueryRowStatus' + status: + pattern: ^(Processing|Finished|Error|Paused)$ + type: string + description: "Status of the query. Possible values: `Processing`, `Finished`,\ + \ `Error`, `Paused`" + example: Processing + x-pattern-message: "Should be either `Processing`, `Finished`, `Error`,\ + \ `Paused`." + SpanQueryRowStatus: + required: + - count + - rowId + - status + type: object + properties: + rowId: + type: string + description: A unique identifier of the query. + example: A + status: + pattern: ^(Processing|Finished|Error|Paused)$ + type: string + description: "Status of the query. Possible values: `Processing`, `Finished`,\ + \ `Error`, `Paused`." + example: Processing + x-pattern-message: "Should be either `Processing`, `Finished`, `Error`,\ + \ `Paused`." + statusMessage: + type: string + description: Descriptive message of the status. + example: Finished successfully + count: + minimum: 0 + type: integer + description: Number of results matching the query + format: int64 + example: 3215 + approximatedFieldCounts: + type: boolean + description: Indicates whether facet field cardinality counts are approximated + or not. + example: false + facetsCompleted: + type: boolean + description: Indicates whether facets calculation has completed. + example: false + SpanQueryResultSpansResponse: + required: + - spanPage + type: object + properties: + spanPage: + type: array + description: List of trace spans. + items: + $ref: '#/components/schemas/SpanQuerySpanData' + next: + type: string + description: Next continuation token. + example: Mi93V0ZqTTBzaW89 + SpanQuerySpanData: + required: + - duration + - startedAt + type: object + properties: + spanId: + type: string + description: Identifier of the span. + example: 00000000002317A9 + traceId: + type: string + description: Identifier of the trace. + example: 1BB004A0005213C2 + parentSpanId: + type: string + description: "Identifier of the parent span, if any. If the span has no\ + \ parent it's considered a root span." + example: 000000000003C7BE + operationName: + type: string + description: The name of the operation given to the span. + example: retrieveAccount + service: + type: string + description: The name of the service this span is part of. + example: user-service + remoteService: + type: string + description: Name of the possible remote span's service. + example: external-service + duration: + type: integer + description: Number of nanoseconds the span lasted. + format: int64 + example: 212957153 + startedAt: + type: string + description: "Date and time the span was started in [ISO 8601 / RFC3339](https://tools.ietf.org/html/rfc3339)\ + \ format." + format: date-time + example: 2019-11-22T09:00:00Z + status: + $ref: '#/components/schemas/TraceSpanStatus' + kind: + pattern: ^(CLIENT|SERVER|PRODUCER|CONSUMER|INTERNAL)$ + type: string + description: "Span kind describes the relationship between the Span, its\ + \ parents, and its children in a Trace. Possible values: `CLIENT`, `SERVER`,\ + \ `PRODUCER`, `CONSUMER`, `INTERNAL`." + example: SERVER + x-pattern-message: "Should be either `CLIENT`, `SERVER`, `PRODUCER`, `CONSUMER`\ + \ or `INTERNAL`." + tagsJSON: + type: string + description: Tags attached to this span as JSON. + example: |- + { + "http.host":"http://example.com", + "http.request.method":"GET" + } + metadata: + maxProperties: 1000 + type: object + additionalProperties: + type: string + description: Metadata attached to the span. + example: + _sourceCategory: account-backend + SpanQueryResultFacetsResponse: + required: + - facets + type: object + properties: + facets: + type: array + description: List of facets. + items: + $ref: '#/components/schemas/SpanQueryRowFacet' + SpanQueryRowFacet: + required: + - cardinality + - dataType + - name + type: object + properties: + name: + type: string + description: Name of the field facet. + example: _sourceHost + cardinality: + type: integer + description: The number of unique values this field occured. + format: int32 + example: 3 + dataType: + pattern: ^(String|Int|Long|Double|Boolean)$ + type: string + description: Data type of the field. + example: String + x-pattern-message: "Should be either `String`, `Int`, `Long`, `Double` or\ + \ `Boolean`." + inSchema: + type: boolean + description: Indicates whether the field is available in the span schema. + example: false + valueFrequency: + maxProperties: 1000 + type: object + additionalProperties: + type: integer + format: int64 + description: Map of field value frequencies. + example: + _sourceHost: 34099 + SpanQueryAggregateResponse: + required: + - result + type: object + properties: + result: + $ref: '#/components/schemas/SpanQueryAggregateResult' + SpanQueryAggregateResult: + required: + - series + - status + type: object + properties: + status: + pattern: ^(Processing|Finished|Error|Paused)$ + type: string + description: "Status of the query. Possible values: `Processing`, `Finished`,\ + \ `Error`, `Paused`." + example: Processing + x-pattern-message: "Should be either `Processing`, `Finished`, `Error`,\ + \ `Paused`." + statusMessage: + type: string + description: Descriptive message of the status + example: Finished successfully + series: + type: array + description: The series returned from a search. + items: + $ref: '#/components/schemas/SpanQueryAggregateDataSeries' + SpanQueryAggregateDataSeries: + required: + - dataPoints + - name + - queryId + type: object + properties: + queryId: + type: string + description: The id of the query. + example: A + name: + type: string + description: | + The meaning of 'name' depends on the series type. + - For results of type 'timeseries', it is the value of the x axis 'field' key. + - For results of type 'nontimeseries', it is the name of one of the fields that is not part of 'xAxisKeys'. + - For results of type 'table', it is the comma-separated string of names of all fields. + example: max(Disk_Used) + dataPoints: + type: array + description: A list of data points in the series. + items: + $ref: '#/components/schemas/SpanQueryAggregatePointData' + aggregateInfo: + $ref: '#/components/schemas/SpanQueryAggregateAggregateData' + metaData: + $ref: '#/components/schemas/SpanQueryAggregateMetaData' + seriesType: + pattern: ^(TIMESERIES|NONTIMESERIES|TABLE)$ + type: string + description: Type of the visual series. + example: TIMESERIES + x-pattern-message: "Should be either `TIMESERIES`, `NONTIMESERIES`, `TABLE`." + xAxisKeys: + type: array + description: Keys that will be plotted as a point on the x axis. + example: + - _sourceCategory + - _sourceHost + items: + type: string + valueType: + pattern: ^(STRING|DOUBLE)$ + type: string + description: Type of the values in the series. + example: DOUBLE + x-pattern-message: "Should be either `STRING`, `DOUBLE`." + SpanQueryAggregatePointData: + required: + - "y" + type: object + properties: + x: + type: number + description: Value that represents a point on the x axis. + format: double + example: 1.0 + "y": + type: string + description: Value that represents a point on the y axis. + example: "12.3" + xAxisValues: + maxProperties: 1000 + type: object + additionalProperties: + type: string + description: Values that represents a point on the x axis. + example: + operation: /get/accounts + service: accountService + default: {} + SpanQueryAggregateAggregateData: + required: + - avg + - latest + - max + - min + - sum + type: object + properties: + max: + type: number + description: The maximum value in the series. + format: double + example: 10.0 + min: + type: number + description: The minimum value in the series. + format: double + example: 1.2 + avg: + type: number + description: The average value in the series. + format: double + example: 5.6 + sum: + type: number + description: The sum of all the values in the series. + format: double + example: 123.4 + latest: + type: number + description: The last value in the series. + format: double + example: 23.4 + count: + type: number + description: The number of values in the series. + format: double + example: 600 + SpanQueryAggregateMetaData: + required: + - data + type: object + properties: + data: + maxProperties: 1000 + type: object + additionalProperties: + type: string + description: The value of the metadata. + example: + deployment: dev + cluster: frontend + instance: frontend-12 + default: {} + SpanQueryFieldsResponse: + required: + - fields + type: object + properties: + fields: + type: array + description: List of span fields. + items: + $ref: '#/components/schemas/SpanQueryFieldDetail' + SpanQueryFieldDetail: + allOf: + - $ref: '#/components/schemas/TraceFieldDetail' + - required: + - inSchema + type: object + properties: + inSchema: + type: boolean + description: Indicates whether the field is available in the schema. + example: false + ServiceMapResponse: + required: + - edges + - nodes + type: object + properties: + nodes: + type: array + description: List of service map nodes. + items: + $ref: '#/components/schemas/ServiceMapNode' + edges: + type: array + description: List of service map edges. + items: + $ref: '#/components/schemas/ServiceMapEdge' + ServiceMapNode: + required: + - isRemote + - lastSeenAt + - serviceName + - serviceType + type: object + properties: + serviceName: + type: string + description: Name of a service in a service map. + example: service_name_1 + serviceColor: + type: string + description: Color hex code assigned to the service. + example: '#fa41c6' + lastSeenAt: + type: string + description: The last time in UTC a service has been seen. Formatted as + defined by date-time - RFC3339. + format: date-time + example: 2019-11-22T09:00:00Z + isRemote: + type: boolean + description: Indicates whether node comes from inferred remote service or + instrumented one. + example: true + serviceType: + $ref: '#/components/schemas/ServiceType' + ServiceMapEdge: + required: + - lastSeenAt + - source + - target + type: object + properties: + source: + type: string + description: Name of a source service. Edge is directed from source to target. + example: service_name_1 + target: + type: string + description: Name of a target service. Edge is directed from source to target. + example: service_name_2 + lastSeenAt: + type: string + description: The last time in UTC an edge has been seen. Formatted as defined + by date-time - RFC3339. + format: date-time + example: 2019-11-22T09:00:00Z + DatastoreStatusResponse: + required: + - diskSize + - indicatorCount + - indicatorLimit + - sourceStatus + type: object + properties: + diskSize: + type: integer + description: Total DB size in terms of disk bytes + format: int64 + example: 1024 + indicatorCount: + type: integer + description: Total number of indicators in the DB + format: int64 + example: 100 + indicatorLimit: + type: integer + description: Limit number of indicators supported in the DB + format: int64 + example: 10000000 + sourceStatus: + type: array + description: A list of sources and their individual DB sizes and indicator + counts + items: + $ref: '#/components/schemas/DatastoreSourceStatusResponse' + DatastoreSourceStatusResponse: + required: + - source + type: object + properties: + source: + type: string + description: The source name + example: unit42_source + description: + type: string + description: The source description + example: This is a stix1.2 indicators source + diskSize: + type: integer + description: Disk utilization in bytes estimate for the indicator source + format: int64 + example: 1024 + indicatorCount: + type: integer + description: Number of indicators for the indicator source + format: int64 + example: 1024 + sumoProvided: + type: boolean + description: True if sumo provided source + example: false + supportsCat: + type: boolean + description: True if can be used in cat operator + example: false + enabled: + type: boolean + description: True if enabled + example: true + description: DB sizes and indicator counts for an individual source + DatastoreRetentionPeriod: + required: + - retentionPeriod + type: object + properties: + retentionPeriod: + type: integer + description: Retention period in days. + format: int64 + example: 120 + UploadNormalizedIndicatorRequest: + required: + - indicators + type: object + properties: + indicators: + type: array + description: The list of normalized threat intel indicators to upload. + items: + $ref: '#/components/schemas/NormalizedIndicator' + NormalizedIndicator: + required: + - confidence + - id + - indicator + - source + - threatType + - type + - validFrom + type: object + properties: + id: + type: string + description: ID of the indicator + example: indicator--d81f86b9-975b-4c0b-875e-810c5ad45a4f + indicator: + type: string + description: Value of the indicator + example: 182.158.1.1 + type: + type: string + description: Type of indicator + example: ipv4-addr + source: + type: string + description: User-provided text to identify the source of the indicator + example: FreeTAXII + updated: + type: string + description: "When this indicator was most recently updated in Sumo. Timestamp\ + \ in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format." + format: date-time + example: 2023-03-21T12:00:00Z + validFrom: + type: string + description: "Beginning time this indicator is valid. Timestamp in UTC in\ + \ [RFC3339](https://tools.ietf.org/html/rfc3339) format." + format: date-time + example: 2023-03-21T12:00:00Z + validUntil: + type: string + description: "Time at which this indicator expires. If not set, the indicator\ + \ never expires. . Timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339)\ + \ format." + format: date-time + example: 2023-03-21T12:00:00Z + confidence: + maximum: 100 + minimum: 1 + type: integer + description: "Confidence that the creator has in the correctness of their\ + \ data, where 100 is highest" + threatType: + type: string + description: Type of indicator ( https://docs.oasis-open.org/cti/stix/v2.1/os/stix-v2.1-os.html#_cvhfwe3t9vuo + ) + example: benign + actors: + type: string + description: Actors as a comma separated list. + example: "actor1,actor2" + killChain: + type: string + description: Kill Chain as a comma separated list. + example: "KC1,KC2" + fields: + maxProperties: 1000 + type: object + additionalProperties: + type: string + description: Flattened fields from the original indicator object (e.g. flattened + STIX fields) + UploadStixIndicatorsResponse: + required: + - invalidIndicators + type: object + properties: + invalidIndicators: + type: array + description: A list of invalid indicator IDs that were not ingested + example: + - indicator--foo + - indicator--bar + items: + type: string + UploadStixIndicatorsRequest: + required: + - indicators + - source + type: object + properties: + source: + type: string + description: User-provided text to identify the source of the indicator + example: FreeTAXII + indicators: + type: array + description: The list of stix threat intel indicators to upload. + items: + $ref: '#/components/schemas/StixIndicator' + StixIndicator: + required: + - created + - id + - modified + - pattern + - pattern_type + - spec_version + - type + - valid_from + type: object + properties: + type: + type: string + description: The type property identifies the type of STIX Object. + example: indicator + spec_version: + type: string + description: The STIX version + example: "2.1" + id: + type: string + description: The ID of the indicator + example: acme:indicator-bf8bc5d5-c7e6-46b0-8d22-7500fea77196 + created: + type: string + description: The time from which this Indicator is considered a valid indicator + of the behaviors it is related or represents. + format: date-time + example: 2023-03-21T12:00:00Z + modified: + type: string + description: The time from which this Indicator is considered a valid indicator + of the behaviors it is related or represents. + format: date-time + example: 2023-03-21T12:00:00Z + created_by_ref: + type: string + description: Identifier of type identity + example: identity--f431f809-377b-45e0-aa1c-6a4751cae5ff + revoked: + type: boolean + description: The revoked property is only used by STIX Objects that support + versioning and indicates whether the object has been revoked. + labels: + type: array + description: The labels property specifies a set of terms used to describe + this object. The terms are user-defined or trust-group defined and their + meaning is outside the scope of this specification and MAY be ignored. + example: + - heartbleed + - has-logo + items: + type: string + confidence: + maximum: 100 + minimum: 1 + type: integer + description: "Confidence that the creator has in the correctness of their\ + \ data, where 100 is highest" + lang: + type: string + description: "The lang property identifies the language of the text content\ + \ in this object. When present, it MUST be a language code conformant\ + \ to [RFC5646]. If the property is not present, then the language of the\ + \ content is en (English)" + example: en + external_references: + type: array + description: "A list of external references which refer to non-STIX information.\ + \ This property MAY be used to provide one or more Vulnerability identifiers,\ + \ such as a CVE ID" + items: + $ref: '#/components/schemas/ExternalReference' + object_marking_refs: + type: array + description: The object_marking_refs property specifies a list of id properties + of marking-definition objects that apply to this object. + example: + - marking-definition--089a6ecb-cc15-43cc-9494-767639779123 + items: + type: string + granular_markings: + type: array + description: The granular_markings property specifies a list of granular + markings applied to this object + items: + $ref: '#/components/schemas/GranularMarkingType' + extensions: + maxProperties: 1000 + type: object + additionalProperties: + $ref: '#/components/schemas/Extension' + description: "Specifies any extensions of the object, as a dictionary" + name: + type: string + description: The name of the object + description: + type: string + description: A human readable description + indicator_types: + type: array + description: A set of categorizations for this indicator. + example: + - malicious-activity + items: + type: string + pattern: + type: string + description: The detection pattern for this Indicator expressed as a STIX + patter. + example: "[ipv4-addr:value = '1.2.3.4']" + pattern_type: + type: string + description: The type of pattern + example: stix + pattern_version: + type: string + description: The version of the pattern language that is used for the data + in the pattern property which MUST match the type of pattern data included + in the pattern property. + valid_from: + type: string + description: The time from which this Indicator is considered a valid indicator + of the behaviors it is related or represents. + format: date-time + example: 2023-03-21T12:00:00Z + valid_until: + type: string + description: The time at which this Indicator should no longer be considered + a valid indicator of the behaviors it is related to or represents. + format: date-time + example: 2023-03-21T12:00:00Z + kill_chain_phases: + type: array + description: The list of Kill Chain Phases for which this Attack Pattern + is used + items: + $ref: '#/components/schemas/KillChainPhase' + ExternalReference: + required: + - source_name + type: object + properties: + source_name: + type: string + description: The name of the source that the external-reference is defined + within + example: system + description: + type: string + description: A human readable description + url: + type: string + description: A URL reference to an external resource + example: https://github.com/vz-risk/0001AA7F-C601-424A-B2B8-BE6C9F5164E7.json + hashes: + maxProperties: 1000 + type: object + additionalProperties: + type: string + description: Specifies a dictionary of hashes for the contents of the url + example: + SHA-256: 6db12788c37247f2316052e142f42f4b259d6561751e5f401a1ae2a6df9c674b + external_id: + type: string + description: An identifier for the external reference content + example: 0001AA7F-C601-424A-B2B8-BE6C9F5164E7 + GranularMarkingType: + required: + - selectors + type: object + properties: + lang: + type: string + description: The lang property identifies the language of the text identified + by this marking + example: en + marking_ref: + type: string + description: The marking_ref property specifies the ID of the marking-definition + object that describes the marking + example: marking-definition--089a6ecb-cc15-43cc-9494-767639779123 + selectors: + type: array + description: The selectors property specifies a list of selectors for content + contained within the STIX Object in which this property appears + example: + - description + - labels + items: + type: string + Extension: + required: + - created + - created_by_ref + - extension_types + - id + - modified + - name + - schema + - spec_version + - type + - version + type: object + properties: + type: + type: string + description: The type property identifies the type of object + example: indicator + spec_version: + type: string + description: The STIX version + example: "2.1" + id: + type: string + description: The ID of the indicator + example: acme:indicator-bf8bc5d5-c7e6-46b0-8d22-7500fea77196 + created: + type: string + description: The time from which this Indicator is considered a valid indicator + of the behaviors it is related or represents. + format: date-time + example: 2023-03-21T12:00:00Z + modified: + type: string + description: The time from which this Indicator is considered a valid indicator + of the behaviors it is related or represents. + format: date-time + example: 2023-03-21T12:00:00Z + created_by_ref: + type: string + description: Identifier of type identity + example: identity--f431f809-377b-45e0-aa1c-6a4751cae5ff + revoked: + type: boolean + description: The revoked property is only used by STIX Objects that support + versioning and indicates whether the object has been revoked. + labels: + type: array + description: The labels property specifies a set of terms used to describe + this object. The terms are user-defined or trust-group defined and their + meaning is outside the scope of this specification and MAY be ignored. + example: + - heartbleed + - has-logo + items: + type: string + external_references: + type: array + description: "A list of external references which refer to non-STIX information.\ + \ This property MAY be used to provide one or more Vulnerability identifiers,\ + \ such as a CVE ID" + items: + $ref: '#/components/schemas/ExternalReference' + object_marking_refs: + type: array + description: The object_marking_refs property specifies a list of id properties + of marking-definition objects that apply to this object. + example: + - marking-definition--089a6ecb-cc15-43cc-9494-767639779123 + items: + type: string + granular_markings: + type: array + description: The granular_markings property specifies a list of granular + markings applied to this object + items: + $ref: '#/components/schemas/GranularMarkingType' + name: + type: string + description: The name of the object + description: + type: string + description: A human readable description + schema: + type: string + description: "The normative definition of the extension, either as a URL\ + \ or as plain text explaining the definition" + example: https://www.example.com/schema-my-favorite-sdo-1/v1 + version: + type: string + description: The version of this extension + extension_types: + type: array + description: This property specifies one or more extension types contained + within this extension + items: + type: string + enum: + - new-sdo + - new-sco + - new-sro + - property-extension + - toplevel-property-extension + extension_properties: + type: array + description: This property contains the list of new property names that + are added to an object by an extension + items: + type: string + KillChainPhase: + required: + - kill_chain_name + type: object + properties: + kill_chain_name: + type: string + description: The name of the kill chain. The value of this property SHOULD + be all lowercase and SHOULD use hyphens instead of spaces or underscores + as word separators + example: lockheed-martin-cyber-kill-chain + phase_name: + type: string + description: The name of the phase in the kill chain. The value of this + property SHOULD be all lowercase and SHOULD use hyphens instead of spaces + or underscores as word separators + example: reconnaissance + RemoveIndicatorsRequest: + required: + - indicatorIds + - source + type: object + properties: + source: + type: string + description: The source of the indicator ID to match against + example: Crowdstrike + indicatorIds: + type: array + description: The list of indicator IDs to match against + example: + - indicator--abcd + - indicator--ef012 + items: + type: string + DataSourceProperties: + type: object + properties: + enabled: + type: boolean + description: True if enabled. + example: true + description: + type: string + description: The data source description. + example: This is a stix1.2 data source. + ListTagResult: + required: + - result + type: object + properties: + result: + type: array + description: List of Tag Dictionary Values (e.g. Tag Keys or Tag Values). + example: + - aTagKeyOrValue01 + - aTagKeyOrValue02 + items: + type: string + OTCollector: + required: + - createdAt + - createdBy + - id + - modifiedAt + - modifiedBy + - name + - systemInfo + - version + type: object + properties: + id: + type: string + description: Unique identifier of the OT Collector. + example: 0000000005F5E105 + name: + type: string + description: Name of the OT Collector. + example: test OT Collector + version: + required: + - currentVersion + type: object + properties: + currentVersion: + type: string + description: Current version of the OT Collector. + latestAvailableVersion: + type: string + description: Latest available version of the OT Collector. + description: Version information of the OT Collector. + category: + type: string + description: Category of the OT Collector. + example: apache + description: + type: string + description: Description of the OT Collector. + tags: + maxProperties: 1000 + type: object + additionalProperties: + type: string + description: Tags associated with the OT Collector. + example: + team: app-dev + showIcon: true + healthIncidentsTracker: + type: object + properties: + errorsCount: + type: integer + description: Number of errors associated with the OT Collector. + format: int32 + example: 0 + warningsCount: + type: integer + description: Number of warnings associated with the OT Collector. + format: int32 + example: 1 + description: Health incident information. + ephemeral: + type: boolean + description: Ephemeral Status of the OT Collector. + example: false + alive: + type: boolean + description: Alive Status of the OT Collector based on heartbeat. + example: true + isRemotelyManaged: + type: boolean + description: Management Status of the OT Collector based on if it is remotely + or locally managed. + example: true + effectiveConfig: + maxProperties: 1000 + type: object + additionalProperties: + type: string + description: Config map that includes Base 64 Encoded Effective Configuration + Yaml of the Remotely managed OT Collector. + example: + "00000000000000A3": ZGVtbyBjb25maWc= + "00000000000000D5": XFVtbfe34tgcvefv= + systemInfo: + type: object + properties: + hostName: + type: string + description: Host name of the OT Collector. + example: app.test.com + hostOsName: + type: string + description: Host OS name of the OT Collector. + example: Linux + hostOsVersion: + type: string + description: Host OS version of the OT Collector. + example: 5.4.144-69.257.amzn2.x86_64 + hostIpAddress: + type: string + description: Host IP address of the OT Collector. + example: 19.123.24.66 + hostEnv: + type: string + description: Host environment of the OT Collector. + example: EKS-1.20.2 + description: System information of the OT Collector. + timeZone: + type: string + description: timezone of the collector + example: UTC + createdAt: + type: string + description: "Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339)\ + \ format." + format: date-time + example: 2018-10-16T09:10:00Z + createdBy: + type: string + description: Identifier of the user who created the resource. + example: 0000000006A5C7A2 + modifiedAt: + type: string + description: Last modification timestamp in UTC. + format: date-time + example: 2018-10-16T09:10:00Z + modifiedBy: + type: string + description: Identifier of the user who last modified the resource. + example: 0000000006A5C7A2 + sourceTemplateLinkedCount: + type: integer + description: Count of the source templates linked to a collector + example: 1 + description: An OT Collector definition. + OtTag: + required: + - key + - values + type: object + properties: + key: + type: string + description: key of the given tag. + example: key1 + values: + type: array + description: values of the given tag. + items: + type: string + example: value1 + VersionRange: + type: object + properties: + minVersion: + pattern: "^v(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(-sumo.+)?$" + type: string + description: Minimum version of otCollector. + maxVersion: + pattern: "^v(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(-sumo.+)?$" + type: string + description: Maximum version of the collector. + rangeType: + type: string + description: "Specifies how filtering should be applied when `minVersion`\ + \ and `maxVersion` are defined. - `Within`: Filtering includes the specified\ + \ range. - `Outside`: Filtering excludes the specified range. By default,\ + \ filtering includes the specified range." + description: Version range for otCollector. + SourceTemplateListResponse: + required: + - data + type: object + properties: + data: + type: array + description: List of source templates. + items: + $ref: '#/components/schemas/SourceTemplateDefinition' + SourceTemplateDefinition: + type: object + properties: + schemaRef: + $ref: '#/components/schemas/SchemaRef' + id: + type: string + description: id of source template. + example: 0000000003343FDD + inputJson: + maxProperties: 1000 + type: object + additionalProperties: true + description: inputJson of source template + example: {} + config: + type: string + description: configuration of source template + example: apache.yaml.example + selector: + $ref: '#/components/schemas/Selector' + totalCollectorLinked: + type: integer + description: count of total collector linked with this source template. + format: int32 + default: 0 + createdAt: + type: string + description: "Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339)\ + \ format." + format: date-time + example: 2018-10-16T09:10:00Z + modifiedAt: + type: string + description: "Modification timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339)\ + \ format." + format: date-time + example: 2018-10-16T09:10:00Z + createdBy: + type: string + description: Id of the user who created source template + example: 0000000006743FDD + modifiedBy: + type: string + description: Id of the user who last modified the source template + example: 0000000006243FDD + status: + type: string + description: Status of Source template + enum: + - enable + - disable + isEnabled: + type: boolean + description: A boolean parameter to get if the source template is enabled. + example: true + default: true + description: response definition of source template. + SchemaRef: + required: + - type + type: object + properties: + type: + type: string + description: type of source template. + example: Apache + description: schema reference for source template. + Selector: + type: object + properties: + tags: + type: array + description: tags filter for agents + items: + type: array + items: + $ref: '#/components/schemas/OtTag' + names: + type: array + description: names to select custom agents + items: + type: string + example: demo_macOS + description: Agent selector conditions + CollectorCompatibility: + type: object + properties: + os: + type: string + description: Name of the Operating System. + example: linux + collectorVersionRange: + $ref: '#/components/schemas/CollectorVersionRange' + CollectorVersionRange: + type: object + properties: + minVersion: + type: string + description: Minimum compatible version of otCollector. + maxVersion: + type: string + description: "Maximum compatible version of the otcollector. if this is\ + \ null, then latest otcollector is also compatible." + nullable: true + example: + minVersion: v0.89.0 + maxVersion: v0.90.0 + SourceTemplateRequest: + required: + - inputJson + - schemaRef + type: object + properties: + schemaRef: + $ref: '#/components/schemas/SchemaRef' + inputJson: + maxProperties: 1000 + required: + - name + - receivers + type: object + properties: + name: + type: string + description: name of source template. + example: apache_test_source_template + receivers: + type: object + description: receiver information of source template + example: {} + description: + type: string + description: description of source template + example: Demo Description for Source Template + processors: + type: object + description: processors for source template + example: {} + additionalProperties: true + description: inputJson of source template + selector: + $ref: '#/components/schemas/Selector' + isEnabled: + type: boolean + description: "Indicates whether the source template is enabled - **Create\ + \ operation:** Defaults to `true` (the template is enabled when created).\ + \ - **Update operation:** If omitted, the existing status is preserved." + example: true + description: request body for creating source template. + SourceTemplateUpdateRequest: + required: + - inputJson + - schemaRef + type: object + properties: + schemaRef: + $ref: '#/components/schemas/SchemaRef' + inputJson: + maxProperties: 1000 + required: + - name + - receivers + type: object + properties: + name: + type: string + description: Name of source template. + example: apache_test_source_template + receivers: + type: object + description: Receiver information of source template + example: {} + description: + type: string + description: Description of source template + example: Demo Description for source template + processors: + type: object + description: Processors for source template + example: {} + additionalProperties: true + description: InputJson of source template + selector: + $ref: '#/components/schemas/Selector' + isEnabled: + type: boolean + description: "Indicates whether the source template is enabled. If omitted,\ + \ the existing status is preserved." + example: true + description: Request body for updating source template. + SourceTemplateStatusUpdateRequest: + required: + - status + type: object + properties: + status: + type: string + description: status to set for the source template (enable or disable). + enum: + - enable + - disable + example: + status: enable + SourceTemplateUpgradeRequest: + required: + - inputJson + - schemaRef + type: object + properties: + schemaRef: + $ref: '#/components/schemas/UpgradeSchemaRef' + inputJson: + maxProperties: 1000 + required: + - name + - receivers + type: object + properties: + name: + type: string + description: name of source template. + example: apache_test_source_template + receivers: + type: object + description: receiver information of source template + example: + hostmetrics: + receiverType: hostmetrics + collection_interval: 5m + description: + type: string + description: description of source template + example: Demo Description for source template + processors: + type: object + description: processors for source template + example: + resource: + processorType: resource + additionalProperties: true + description: inputJson of source template + description: request body for creating source template. + UpgradeSchemaRef: + required: + - type + - version + type: object + properties: + type: + type: string + description: type of source template. + example: Apache + version: + type: string + description: version of source template. + example: 1.0.0 + description: schema reference for upgrade source template request. + LinkedSourceTemplatesUpdateResponse: + required: + - collectorId + type: object + properties: + collectorId: + type: string + description: otCollector id for which tags are edited. + example: 00005AF3107BF0D6 + addedSourceTemplates: + type: array + description: list of sourceTemplates which are linked to otCollector. + items: + $ref: '#/components/schemas/LinkingUpdatedSourceTemplateDetails' + removedSourceTemplates: + type: array + description: list of sourceTemplates which are removed from otCollector + linking. + items: + $ref: '#/components/schemas/LinkingUpdatedSourceTemplateDetails' + description: linked source template details based on the ot-collector tags user + wants to update. + LinkingUpdatedSourceTemplateDetails: + required: + - reasonTags + - sourceTemplateDefinition + type: object + properties: + sourceTemplateDefinition: + $ref: '#/components/schemas/SourceTemplateDefinition' + reasonTags: + type: array + description: tags which are responsible for source template and collector + linking impact. + items: + type: array + items: + $ref: '#/components/schemas/CollectorTag' + description: source template details with tags responsible for otCollector Linking + update. + CollectorTag: + required: + - key + - values + type: object + properties: + key: + type: string + description: Key of the given tag. + example: key1 + value: + type: string + description: Values of the given tag. + example: value1 + LinkedSourceTemplatesUpdateRequest: + required: + - collectorId + type: object + properties: + collectorId: + type: string + description: otCollector id for which tags are edited. + example: 00005AF3107BF0D6 + tags: + maxProperties: 50 + type: object + additionalProperties: + type: string + description: JSON map of key-value metadata to apply to the otCollector. + example: + environment: production + location: us-west-2 + default: {} + updatedName: + type: string + description: Updated Name of the otCollector. + example: demo_macOS + ListSchemaBaseTypeToVersionsResponse: + required: + - data + type: object + properties: + data: + type: array + description: List of maps containing the mappings schema type -> versions. + items: + $ref: '#/components/schemas/SchemaBaseTypeToVersionsResponse' + SchemaBaseTypeToVersionsResponse: + required: + - type + - versions + type: object + properties: + type: + type: string + description: The type of the schema. + example: Okta + versions: + type: array + description: List of schema base identities sorted by latest version for + a specific schema type. + items: + $ref: '#/components/schemas/SchemaBaseComplete' + description: Map of the schema base type to its list of schema base identities. + SchemaBaseComplete: + type: object + allOf: + - $ref: '#/components/schemas/SchemaBaseIdentityWithMetadata' + - $ref: '#/components/schemas/SchemaBaseTemplateYaml' + SchemaBaseIdentityWithMetadata: + type: object + allOf: + - $ref: '#/components/schemas/SchemaBaseIdentity' + - required: + - id + - type + - version + properties: + id: + type: string + description: Unique identifier of the schema. + createdAt: + type: string + description: "Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339)\ + \ format." + format: date-time + example: 2018-10-16T09:10:00Z + modifiedAt: + type: string + description: Last modification timestamp in UTC. + format: date-time + example: 2018-10-16T09:10:00Z + SchemaBaseIdentity: + required: + - family + - schema + - type + - version + type: object + properties: + type: + maxLength: 128 + minLength: 1 + type: string + description: The type of the integration. + example: Okta + version: + maxLength: 128 + minLength: 5 + pattern: "^([0-9]+)\\.([0-9]+)\\.([0-9]+)$" + type: string + description: The version (or image tag) of the integration. Follows the + Major.Minor.Patch semantic versioning format. + example: 1.0.0 + x-pattern-message: "must follow semantic versioning: https://semver.org/" + description: + maxLength: 1024 + minLength: 0 + type: string + description: The description of the integration. + example: An Okta integration that collects Okta event logs into Sumo Logic. + manifest: + maxProperties: 1000 + type: object + additionalProperties: true + description: The manifest of the integration. + schema: + maxProperties: 1000 + type: object + additionalProperties: true + description: The schema in JSON Schema specification. + family: + type: string + description: The family to which schema belong. + enum: + - OTC_Source_Template + SchemaBaseTemplateYaml: + type: object + properties: + templateYaml: + maxLength: 10960 + minLength: 1 + type: string + description: The template yaml of schema. + example: example templateYaml + EventContext: + required: + - eventContextType + type: object + properties: + eventContextType: + pattern: ^(SearchQueryContext)$ + type: string + description: Context for which correlated events are to be fetched. + example: SearchQueryContext + discriminator: + propertyName: eventContextType + mapping: + SearchQueryContext: '#/components/schemas/SearchQueryContext' + CorrelatedEvents: + required: + - correlationFinished + - events + type: object + properties: + correlationFinished: + type: boolean + description: Flag indicating correlation completion. + example: true + events: + type: array + description: List of events. + items: + $ref: '#/components/schemas/CorrelatedEvent' + CorrelatedEvent: + required: + - eventPriority + - eventSource + - eventType + - name + - startTimeMs + type: object + properties: + name: + type: string + description: The name of the event. + example: monitor-manager deployed. + description: + type: string + description: Description of the events. + example: 2 containers in monitor-manager were upgraded. + eventType: + type: string + description: The type of event. + example: Deploy + eventPriority: + type: string + description: The priority of event. + example: High + eventSource: + type: string + description: The source of the event. + example: Jenkins + startTimeMs: + type: integer + description: The start time of the event. + format: int64 + example: 16794589390 + metadataJson: + type: string + description: JSON string containing metadata of the event. + description: Object specifying an event. + ListEventExtractionRulesResponse: + required: + - data + type: object + properties: + data: + type: array + description: List of event extraction rules. + items: + $ref: '#/components/schemas/EventExtractionRuleWithDetails' + EventExtractionRuleWithDetails: + type: object + description: Event extraction rule object. + allOf: + - $ref: '#/components/schemas/EventExtractionRule' + - required: + - id + type: object + properties: + id: + type: string + description: Id of the event extraction rule. + example: "0000000001213227" + createdAt: + type: string + description: "Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339)\ + \ format." + format: date-time + createdBy: + type: string + description: Identifier of the user who created the resource. + modifiedAt: + type: string + description: Last modification timestamp in UTC. + format: date-time + modifiedBy: + type: string + description: Identifier of the user who last modified the resource. + enabled: + type: boolean + description: Flag indicating whether the event extraction rule is enabled + or disabled. + example: true + disableReason: + type: string + description: "Reason for disabling the event extraction rule, if applicable." + example: Event Extraction Rule output exceeded maximum allowed rate of + 1000 events per hour in last 24 hours. + EventExtractionRule: + required: + - configuration + - name + - query + type: object + properties: + name: + maxLength: 256 + minLength: 1 + type: string + description: Name of event extraction rule. + example: foo + description: + maxLength: 1024 + type: string + description: Description of event extraction rule. + example: foo + query: + type: string + description: | + Query string for the Event Extraction Rule. Logs matching this query are periodically ingested into the `sumologic_userdata_events` index (**Events**). + + Guidelines for creating the query: + - Optimize the query to limit the number of returned log messages (intended for special logs only). + - The query runs in `Manual` mode, explicitly parse and extract only the necessary fields for event correlation and visualization. + - Use the `fields` operator to restrict the output to required fields. + example: _sourceCategory=eventSource + correlationExpression: + required: + - eventFieldName + - queryFieldName + - stringMatchingAlgorithm + type: object + properties: + queryFieldName: + type: string + description: Name of the query field returned by a log search query. + example: _sourcecategory + eventFieldName: + type: string + description: Name of the field from event query output. + example: foo + stringMatchingAlgorithm: + pattern: ^(ExactMatch)$ + type: string + description: Type of string matching algorithm which tells how to match + eventFieldName and queryFieldName. + example: ExactMatch + description: "Correlation Expression specifies how to determine related\ + \ events for a log search query. \nThe value of `eventFieldName` from\ + \ Events is compared with the values of `queryFieldName` from the log\ + \ search query output using the defined stringMatchingAlgorithm. Events\ + \ that match according to this algorithm are considered correlated.\n" + configuration: + maxProperties: 1000 + required: + - eventName + - eventPriority + - eventSource + - eventType + type: object + additionalProperties: + $ref: '#/components/schemas/FieldMapping' + description: | + Configuration for the Event Extraction Rule. + + This object defines how event fields are mapped to their corresponding values. + Each field specifies a `valueSource`, which provides the actual value, and an optional `mappingType`, + indicating the value is hardcoded. + + The following fields are **required**: + - `eventType`: Type of the event. Accepted values are `Deployment`, `Feature Flag Change`, `Configuration Change` or `Infrastructure Change`. + - `eventPriority`: Indicates the priority of the event. Accepted values are `High`, `Medium`, or `Low`. + - `eventSource`: Source system or component where the event originated (e.g., "Jenkins"). + - `eventName`: Descriptive name of the event (e.g., "monitor-manager deployed."). + + The following fields are **optional**: + - `eventDescription`: Additional context or details about the event. + + Custom fields can also be added as needed to capture domain-specific event data. + example: + eventType: + valueSource: Deploy + mappingType: HardCoded + eventPriority: + valueSource: High + mappingType: HardCoded + eventSource: + valueSource: Jenkins + mappingType: HardCoded + eventName: + valueSource: monitor-manager deployed. + mappingType: HardCoded + eventDescription: + valueSource: 2 containers in monitor-manager were upgraded. + mappingType: HardCoded + FieldMapping: + required: + - valueSource + type: object + properties: + valueSource: + maxLength: 256 + type: string + description: The actual value or field reference for the mapping. + example: Knobs Changes + mappingType: + pattern: ^(HardCoded)$ + type: string + description: Specifies valueSource is hardcoded. + example: HardCoded + x-pattern-message: Must be `HardCoded` + EventExtractionRulesQuotaUsage: + required: + - quota + - remaining + type: object + properties: + quota: + type: integer + description: Maximum number of EventExtractionRules allowed. + format: int32 + example: 200 + remaining: + type: integer + description: Remaining number of EventExtractionRules allowed. + format: int32 + example: 121 + ScanBudgetList: + required: + - data + type: object + properties: + data: + type: array + description: List of scan budgets. + items: + $ref: '#/components/schemas/ScanBudget' + next: + type: string + description: Next continuation token. + ScanBudget: + allOf: + - $ref: '#/components/schemas/ScanBudgetDefinition' + - required: + - createdAt + - createdBy + - id + - modifiedAt + - modifiedBy + - orgId + - resetDateOfMonth + - resetDayOfWeek + - resetTime + - resetTimeZone + type: object + properties: + id: + type: string + description: Id of the budget. + orgId: + type: string + description: Org Id of the org for the budget. + resetTime: + maxLength: 5 + minLength: 5 + type: string + description: Reset time of the time based scan budget in HH:MM format + example: 23:30 + default: 00:00 + resetTimeZone: + type: string + description: "Time zone of the reset time for the time based scan budget.\ + \ Follow the format in the [IANA Time Zone Database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List)." + example: America/Los_Angeles + default: Etc/UTC + resetDayOfWeek: + pattern: ^(MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY|SUNDAY)$ + type: string + description: "The day of the week when the budget resets, applicable for\ + \ time based budgets with a Weekly window. Must be a valid day of the\ + \ week." + default: MONDAY + resetDateOfMonth: + maximum: 28 + minimum: 1 + type: integer + description: "The date of the month when the budget resets, applicable\ + \ for time based budgets with a Monthly window. Must be a valid day\ + \ of the month (1-28)." + format: int32 + default: 1 + createdAt: + type: string + description: Date & time when budget was created. + format: date-time + createdBy: + type: string + description: Id of the user who created the budget. + modifiedAt: + type: string + description: Date & time when budget was last modified. + format: date-time + modifiedBy: + type: string + description: Id of the user who last modified the budget. + ScanBudgetDefinition: + required: + - action + - applicableOn + - budgetType + - capacity + - groupBy + - name + - scope + - unit + - window + type: object + properties: + name: + type: string + description: Name of the budget. + capacity: + type: integer + description: Capacity of the budget. + format: int64 + unit: + pattern: ^(GB|MB|TB|KB)$ + type: string + description: Unit of the budget. + example: GB + budgetType: + $ref: '#/components/schemas/BudgetType' + scope: + $ref: '#/components/schemas/ScanBudgetScope' + window: + pattern: ^(Query|Daily|Weekly|Monthly)$ + type: string + description: Window of the budget. Use Daily/Weekly/Monthly for creating + a time based budget (beta) + example: Query + applicableOn: + pattern: ^(PerEntity|Sum)$ + type: string + description: Grouping of the budget. + example: PerEntity + groupBy: + pattern: ^(User)$ + type: string + description: Grouping Entity of the budget. + example: User + action: + pattern: ^(StopForeGroundScan|Warn)$ + type: string + description: Action to be taken if the budget is breached + example: Warn + status: + pattern: ^(active|inactive)$ + type: string + description: Signifies the state of the budget. (Active/Inactive) + example: active + BudgetType: + pattern: ^(ScanBudget)$ + type: string + description: Type of the budget. + example: ScanBudget + ScanBudgetScope: + required: + - excludedRoles + - excludedUsers + - includedRoles + - includedUsers + type: object + properties: + includedUsers: + type: array + description: List of userIds included in the budget. + example: + - 00000000000001DF + - 00000000000002D2 + items: + type: string + excludedUsers: + type: array + description: List of userIds excluded in the budget. + example: + - 00000000000001DF + - 00000000000002D2 + items: + type: string + includedRoles: + type: array + description: List of roleIds included in the budget. + example: + - 00000000000001DF + - 00000000000002D2 + items: + type: string + excludedRoles: + type: array + description: List of roleIds excluded in the budget. + example: + - 00000000000001DF + - 00000000000002D2 + items: + type: string + ScanBudgetUsageList: + required: + - data + type: object + properties: + data: + type: array + description: List of budget usages + items: + $ref: '#/components/schemas/ScanBudgetUsage' + next: + type: string + description: Next continuation token. + ScanBudgetUsage: + required: + - budgetId + - usage + - usagePercentage + type: object + properties: + budgetId: + type: string + description: Budget id. + usage: + type: integer + description: Budget usage (in bytes). + format: int64 + usagePercentage: + type: integer + description: Budget usage percentage. + format: int64 + ContentSyncResponse: + required: + - jobId + type: object + properties: + jobId: + type: string + description: Content Sync Job Id. + example: 68B6D772B616DC06 + ContentSyncRequest: + required: + - contentList + - destinationChildOrgInfo + - sourceChildOrgInfo + type: object + properties: + sourceChildOrgInfo: + $ref: '#/components/schemas/ChildOrgInfo' + destinationChildOrgInfo: + $ref: '#/components/schemas/DestinationChildOrgInfo' + contentList: + type: array + description: List of Content and Configuration Information. + items: + $ref: '#/components/schemas/Content_1' + ChildOrgInfo: + required: + - orgId + type: object + properties: + orgId: + type: string + description: Organization Identifier. + example: us2-0000000000000006 + orgName: + type: string + description: Organization Name. + example: Test Org Name + DestinationChildOrgInfo: + required: + - excluded + - included + type: object + properties: + included: + type: array + description: Organization Info which needs to be included in Destination + Organisation List. + items: + $ref: '#/components/schemas/ChildOrgInfo' + excluded: + type: array + description: Organization Info which needs to be excluded from Destination + Organisation List. + items: + $ref: '#/components/schemas/ChildOrgInfo' + Content_1: + required: + - id + - options + - type + type: object + properties: + id: + type: string + description: Identifier of Content or Configuration + example: MATCH-S00574 + type: + type: string + description: Type Of Content. + example: CSE_RULE + enum: + - CSE_RULE + - CSE_TUNING_EXPRESSION + - LIBRARY_FOLDER + - DASHBOARD + - SEARCH + - SCHEDULED_SEARCH + - MONITOR + - MONITOR_FOLDER + - SOURCE_TEMPLATE + - LOOKUP_TABLE + name: + type: string + description: Name of Content or Configuration + example: Test CSE Rule + options: + maxProperties: 100 + type: object + additionalProperties: + type: string + description: Advance Settings required for syncing content or configuration. + example: + includeCSERule: true + default: {} + ContentSyncStatusResponse: + required: + - progress + - status + type: object + properties: + status: + type: string + description: Content Sync Job status. + example: Success + progress: + type: integer + description: Content Sync Job progress percentage. + example: 100 + RetryOptions: + type: string + description: "Determines retry scope -> \"ALL_CONTENTS\" (default) retries all,\ + \ \"NON_SUCCESS_CONTENTS\" retries only failed ones." + enum: + - ALL_CONTENTS + - NON_SUCCESS_CONTENTS + default: ALL_CONTENTS + ContentSyncResult: + required: + - contentList + type: object + properties: + contentList: + type: array + description: List of content sync items with details. + items: + $ref: '#/components/schemas/ContentSyncItemResult' + ContentSyncItemResult: + required: + - childOrganization + - contentId + - message + type: object + properties: + contentId: + type: string + description: Identifier of Content or Configuration + example: MATCH-S00574 + message: + type: string + description: Message Passed while processing content or configuration sync. + example: "Sync Failed due to an Internal Error, Please check with support\ + \ team for more details." + childOrganization: + $ref: '#/components/schemas/ChildOrgInfo' + ContentSyncJobInfo: + required: + - contentList + - destinationChildOrgInfo + - sourceChildOrgInfo + type: object + properties: + sourceChildOrgInfo: + $ref: '#/components/schemas/ChildOrgInfo' + destinationChildOrgInfo: + $ref: '#/components/schemas/DestinationChildOrgInfo' + contentList: + type: array + description: List of Content and Configuration Information. + items: + $ref: '#/components/schemas/Content_1' + CreateJobResponse: + type: object + properties: + warning: + type: string + description: Warnings value contains the detailed information about the + warning while creating the search job. + id: + type: string + description: The search job identifier. + link: + $ref: '#/components/schemas/Link' + Link: + type: object + properties: + rel: + type: string + description: Relation. + href: + type: string + description: URL of the search job. + CreateJobRequest: + required: + - from + - query + - timezone + - to + type: object + properties: + query: + type: string + description: | + The actual search expression. Ensure your query follows [RFC 8259](https://datatracker.ietf.org/doc/html/rfc8259) and is valid JSON format, you may need to escape certain characters to follow the [RFC 8259](https://datatracker.ietf.org/doc/html/rfc8259). + example: _sourceCategory=service + from: + maxLength: 20 + type: string + description: | + The start date and time of the search. This follows the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) date and time format. + example: 2017-07-26T00:00:00 + to: + maxLength: 20 + type: string + description: | + The end date and time of the search. This follows the [ISO 8601](https://www.w3.org/TR/NOTE-datetime) date and time format. + example: 2017-07-26T00:00:00 + timezone: + type: string + description: "The time zone if from/to is not in milliseconds. See this\ + \ [Wikipedia article](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)\ + \ for a list of time zone codes." + default: UTC + autoParsingMode: + pattern: ^(Manual|AutoParse)$ + type: string + description: | + Define the parsing mode to scan the JSON format log messages. Possible values are: + + AutoParse - System automatically figures out the fields to parse based on the search query. + + Manual - No fields are parsed out automatically. For more information, refer to the [Dynamic Parsing](https://help.sumologic.com/docs/manage/field-extractions/create-field-extraction-rule/). + example: Manual + default: Manual + x-pattern-message: should be either 'Manual' or 'AutoParse' + requiresRawMessages: + type: string + description: | + On enabling this field, the log messages applicable to the search are returned. Maximum value is 100,000. This is only applicable for aggregate queries. + default: "false" + maxRawRecords: + type: string + description: Maximum number of raw records to finish the search. + intervalTimeType: + pattern: ^(messageTime|receiptTime|searchableTime)$ + type: string + description: "This parameter defines whether you want to run the search\ + \ by messageTime, receiptTime or searchableTime." + example: messageTime + default: messageTime + x-pattern-message: should be either 'messageTime' or 'receiptTime' or 'searchableTime' + SearchJobStatusResponse: + type: object + properties: + warning: + type: string + description: Warnings value contains the detailed information about the + warning while obtaining the current status of a search job. + state: + type: string + description: Search job state. + example: DONE GATHERING RESULTS + histogramBuckets: + type: array + description: Histogram buckets for the query. + items: + $ref: '#/components/schemas/HistogramBucket' + messageCount: + type: integer + description: Number of messages found or produced so far. + format: int64 + recordCount: + type: integer + description: Number of records found or produced so far. + format: int64 + pendingWarnings: + type: array + description: Pending warnings that have accumulated since the last time + the status was requested. + items: + type: string + pendingErrors: + type: array + description: Pending errors that have accumulated since the last time the + status was requested. + items: + type: string + usageDetails: + type: object + properties: + dataScannedInBytes: + type: integer + description: Data Scanned in Bytes. + format: int64 + description: Usage details about the search job api. It includes data scanned + in bytes during the search. + HistogramBucket: + required: + - count + - length + - startTimestamp + type: object + properties: + startTimestamp: + type: integer + description: Start time of the bucket. + format: int64 + length: + type: integer + description: "Length is in milliseconds, tells the width of the bucket." + format: int64 + count: + type: integer + description: Count of messages in this bucket. + SearchJobDeleteResponse: + type: object + properties: + warning: + type: string + description: Warnings value contains the detailed information about the + warning while deleting a search job. + jobId: + type: string + description: The Id of the search job which is deleted. + SearchQueryPaginatedMessages: + required: + - fields + - messages + - warning + type: object + properties: + warning: + type: string + description: Detailed information about the warning while paging through + the messages found by a search job. + fields: + type: array + description: List of all the fields defined for each of the messages returned. + items: + $ref: '#/components/schemas/Field' + messages: + type: array + description: Map of the field names to the field values. + items: + $ref: '#/components/schemas/Message' + Field: + required: + - fieldType + - keyField + - name + type: object + properties: + name: + type: string + description: Name of the field. + fieldType: + type: string + description: Type of the field. + example: long + keyField: + type: boolean + description: Flag if the field is a key field. + Message: + type: object + properties: + map: + maxProperties: 1000 + type: object + additionalProperties: + type: string + description: Map message values. + SearchQueryPaginatedRecords: + required: + - fields + - messages + type: object + properties: + warning: + type: string + description: Detailed information about the warning while paging through + the records found by a search job. + fields: + type: array + description: List of all the fields defined for each of the records returned. + items: + $ref: '#/components/schemas/Field' + records: + type: array + description: Map of the field names to the field values. + items: + $ref: '#/components/schemas/Record' + Record: + type: object + properties: + map: + maxProperties: 1000 + type: object + additionalProperties: + type: string + description: Map Records values. + PaginatedMacros: + required: + - macros + type: object + properties: + data: + type: array + description: List of macros. + items: + $ref: '#/components/schemas/Macro' + next: + type: string + description: Next continuation token. `token` is set to null when no more + pages are left. + example: GDCiRv4vebF3UWFJQ1kySXBOR3Bzh69GR0RyWm9vCtc + Macro: + allOf: + - $ref: '#/components/schemas/MacroRequest' + - required: + - createdAt + - createdBy + - id + type: object + properties: + id: + type: string + description: | + Unique identifier for the macro. This id is used to get detailed information about the macro, such as name, definition, arguments and argument validations. + example: C03E086C137F38B4 + createdAt: + type: string + description: "Creation timestamp of the macro in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339)\ + \ format." + format: date-time + example: 2024-10-01T09:10:00Z + createdBy: + type: string + description: The identifier of the user who created the macro. + example: 0000000006743FDD + MacroRequest: + allOf: + - $ref: '#/components/schemas/BaseMacroRequest' + - required: + - name + type: object + properties: + name: + maxLength: 128 + minLength: 1 + type: string + description: Name of the macro. + example: MacroGeoLookup + macroCreationSuggestionId: + type: string + description: "Identifier if the suggestion comes from an macro creation\ + \ suggestion. This id is used to track macro creation suggestions, and\ + \ to delete the suggestion once the macro is created." + example: ABC12 + BaseMacroRequest: + required: + - definition + type: object + properties: + description: + maxLength: 4000 + type: string + description: Description of the macro. + example: Macro for geo lookup. + definition: + type: string + description: The definition of the macro. Use a valid Sumo Log Search expression. + example: | + lookup latitude, longitude from geo://location on ip = {{ip_field}} | count by latitude, longitude | sort _count" + enabled: + type: boolean + description: If the macro is enabled or not (default True) + default: true + arguments: + type: array + description: Arguments used in the macro. + items: + $ref: '#/components/schemas/Argument' + argumentValidations: + type: array + description: Validation expressions for the arguments. + items: + $ref: '#/components/schemas/ArgumentValidation' + Argument: + required: + - name + type: object + properties: + name: + type: string + description: Argument name for the macro. + example: ip_field + type: + pattern: ^(String|Any|Number|Keyword)$ + type: string + description: The type of the macro. + example: String + default: String + x-pattern-message: "Must be `String`, `Any`, `Number or `Keyword`." + ArgumentValidation: + required: + - errorMessage + - evalExpression + type: object + properties: + evalExpression: + type: string + description: The expression to validate a macro argument. + example: isValidIp(ip_field) + errorMessage: + type: string + description: Error message to be shown if the macro argument validation + fails. + example: You need to enter a field name which is a valid ip. + IdToMonitorsLibraryBaseResponseMap: + maxProperties: 1000 + type: object + additionalProperties: + $ref: '#/components/schemas/MonitorsLibraryBaseResponse' + ListMonitorsLibraryItemWithPath: + type: array + description: Multi-type list of types monitor or folder. + items: + $ref: '#/components/schemas/MonitorsLibraryItemWithPath' + MonitorsLibraryItemWithPath: + required: + - item + - path + type: object + properties: + item: + $ref: '#/components/schemas/MonitorsLibraryBaseResponse' + path: + type: string + description: Path of the monitor or folder. + example: /Monitors/SampleFolder/TestMonitor + IdToMutingSchedulesLibraryBaseResponseMap: + maxProperties: 1000 + type: object + additionalProperties: + $ref: '#/components/schemas/MutingSchedulesLibraryBaseResponse' + ListMutingSchedulesLibraryItemWithPath: + type: array + description: Multi-type list of types mutingschedule or folder. + items: + $ref: '#/components/schemas/MutingSchedulesLibraryItemWithPath' + MutingSchedulesLibraryItemWithPath: + required: + - item + - path + type: object + properties: + item: + $ref: '#/components/schemas/MutingSchedulesLibraryBaseResponse' + path: + type: string + description: Path of the mutingschedule or folder. + example: /MutingSchedules/SampleFolder/TestMutingschedule + IdToAlertsLibraryBaseResponseMap: + maxProperties: 1000 + type: object + additionalProperties: + $ref: '#/components/schemas/AlertsLibraryBaseResponse' + ListAlertsLibraryItemWithPath: + type: array + description: Multi-type list of types alert or folder. + items: + $ref: '#/components/schemas/AlertsLibraryItemWithPath' + AlertsLibraryItemWithPath: + required: + - item + - path + type: object + properties: + item: + $ref: '#/components/schemas/AlertsLibraryBaseResponse' + path: + type: string + description: Path of the alert or folder. + example: /Alerts/SampleFolder/TestAlert + IdToSlosLibraryBaseResponseMap: + maxProperties: 1000 + type: object + additionalProperties: + $ref: '#/components/schemas/SlosLibraryBaseResponse' + ListSlosLibraryItemWithPath: + type: array + description: Multi-type list of types slo or folder. + items: + $ref: '#/components/schemas/SlosLibraryItemWithPath' + SlosLibraryItemWithPath: + required: + - item + - path + type: object + properties: + item: + $ref: '#/components/schemas/SlosLibraryBaseResponse' + path: + type: string + description: Path of the slo or folder. + example: /Slos/SampleFolder/TestSlo + IdToMonitorTemplatesLibraryBaseResponseMap: + maxProperties: 1000 + type: object + additionalProperties: + $ref: '#/components/schemas/MonitorTemplatesLibraryBaseResponse' + ListMonitorTemplatesLibraryItemWithPath: + type: array + description: Multi-type list of types monitortemplate or folder. + items: + $ref: '#/components/schemas/MonitorTemplatesLibraryItemWithPath' + MonitorTemplatesLibraryItemWithPath: + required: + - item + - path + type: object + properties: + item: + $ref: '#/components/schemas/MonitorTemplatesLibraryBaseResponse' + path: + type: string + description: Path of the monitortemplate or folder. + example: /MonitorTemplates/SampleFolder/TestMonitortemplate + OperatorData: + required: + - operatorName + - parameters + type: object + properties: + operatorName: + type: string + description: The name of the metrics operator. + example: avg + parameters: + type: array + description: A list of operator parameters for the operator data. + items: + $ref: '#/components/schemas/OperatorParameter' + description: The operator data for metrics query. + example: + operatorName: avg + parameters: + - key: aggregator + value: max + - key: operation + value: "" + - key: value + value: 50 + OperatorParameter: + required: + - key + - value + type: object + properties: + key: + type: string + description: The key of the operator parameter. + example: operation + value: + type: string + description: The value of the operator parameter. + example: '>' + description: The operator parameter for operator data. + example: + key: aggregator + value: max + TracesQueryData: + required: + - filters + type: object + properties: + filters: + type: array + description: A list of filters for the traces query. + items: + $ref: '#/components/schemas/TracesFilter' + description: The data format describing a basic traces query. + TracesFilter: + required: + - type + type: object + properties: + type: + pattern: ^(FieldDescriptor|DurationMetricDescriptor|NumericMetricDescriptor|CPCOfFilterDescriptor|MaxCPCOfFilterDescriptor|MaxCPCFilterDescriptor)$|^$ + type: string + description: The type of the filter. + example: FieldDescriptor + x-pattern-message: "Must be `FieldDescriptor`, `DurationMetricDescriptor`,\ + \ `NumericMetricDescriptor`, `CPCOfFilterDescriptor`, `MaxCPCOfFilterDescriptor`\ + \ or `MaxCPCFilterDescriptor`" + description: The filter for traces query. + discriminator: + propertyName: type + SpansFilter: + required: + - fieldName + - type + type: object + properties: + type: + pattern: ^(StandaloneKey|KeyValuePair)$ + type: string + description: The spans filter type. + example: StandaloneKey + x-pattern-message: Must be `StandaloneKey` or `KeyValuePair`. + fieldName: + type: string + description: The name of the filtering field. + example: service + discriminator: + propertyName: type + mapping: + StandaloneKey: '#/components/schemas/SpansFilterStandaloneKey' + KeyValuePair: '#/components/schemas/SpansFilterKeyValuePair' + SpansVisualization: + required: + - name + - type + type: object + properties: + type: + pattern: ^(count|calculation)$ + type: string + description: The visualization type. + example: count + x-pattern-message: Must be `count` or `calculation` + name: + type: string + description: A unique name of the visualization. + example: duration_pct_95 + discriminator: + propertyName: type + mapping: + count: '#/components/schemas/SpansCountVisualization' + calculation: '#/components/schemas/SpansCalculationVisualization' + SpansGroupBy: + required: + - type + type: object + properties: + type: + pattern: ^(time|field)$ + type: string + description: The type of the group-by clause. + example: time + x-pattern-message: Must be `time` or `field` + discriminator: + propertyName: type + mapping: + time: '#/components/schemas/SpansTimeGroupBy' + field: '#/components/schemas/SpansFieldGroupBy' + SpansLimitItem: + required: + - direction + - limitValue + type: object + properties: + direction: + pattern: ^(asc|desc)$ + type: string + description: Describes whether the results should be sorted in an ascending + or a descending order. + example: asc + x-pattern-message: Must be `asc` or `desc` + limitValue: + type: integer + description: | + The number of aggregated results returned, e.g. if 10 is requested, then only the first 10 aggregated results are returned. + format: int32 + example: 10 + description: | + A representation of the limit operator which reduces the number of aggregate results returned: either the top k results or bottom k results. + LinkedDashboard: + required: + - id + type: object + properties: + id: + type: string + description: Identifier of the linked dashboard. + example: B23OjNs5ZCyn5VdMwOBoLo3PjgRnJSAlNTKEDAcpuDG2CIgRe9KFXMofm2H2 + relativePath: + type: string + description: Relative path of the linked dashboard to the dashboard of the + linking panel. + example: ./subdirectory/LinkedDashboard + includeTimeRange: + type: boolean + description: Include time range from the current dashboard to the linked + dashboard. + example: true + default: true + includeVariables: + type: boolean + description: Include variables from the current dashboard to the linked + dashboard. + example: true + default: true + VariableValuesData: + required: + - variableValues + type: object + properties: + variableValues: + type: array + description: Values for the variable. + example: + - myCluster + items: + type: string + status: + $ref: '#/components/schemas/DashboardSearchStatus' + variableType: + pattern: ^(LogQueryVariableSourceDefinition|MetadataVariableSourceDefinition|CsvVariableSourceDefinition|FilterSourceDefinition)$ + type: string + description: The type of the variable. + example: LogQueryVariableSourceDefinition + x-pattern-message: "Must be `LogQueryVariableSourceDefinition`, `MetadataVariableSourceDefinition`\ + \ `CsvVariableSourceDefinition` or `FilterSourceDefinition`." + valueType: + type: string + description: | + The type of value of the variable. Allowed values are `String`, Any`, `Numeric`, `Integer`, `Long`, `Double`, `Boolean`. - `String` considers as a single phrase and will wrap in double-quotes. - `Any` is all characters. - `Numeric` consists of a numeric value for variables, it will be displayed differently in the UI. - `Integer` is a variable with an `Int` value. - `Long` is a variable with a `Long` value. - `Double` is a variable with a `Double` value. - `Boolean` is a variable with a `Boolean` value. + example: Any + default: Any + allowMultiSelect: + type: boolean + description: Allow multiple selections in the values dropdown. + example: false + default: false + variableKey: + type: string + description: The key of the variable. + example: _source + errors: + type: array + description: Generic errors returned by backend from downstream assemblies. + More specific errors will be thrown in the future. + items: + $ref: '#/components/schemas/ErrorDescription' + description: "Variable values, status, type and errors for the variable values\ + \ search." + ParameterAutoCompleteSyncDefinition: + required: + - autoCompleteType + type: object + properties: + autoCompleteType: + type: string + description: |- + The autocomplete parameter type. Supported values are: + 1. `SKIP_AUTOCOMPLETE` + 2. `CSV_AUTOCOMPLETE` + 3. `AUTOCOMPLETE_KEY` + 4. `VALUE_ONLY_AUTOCOMPLETE` + 5. `VALUE_ONLY_LOOKUP_AUTOCOMPLETE` + 6. `LABEL_VALUE_LOOKUP_AUTOCOMPLETE` + autoCompleteKey: + type: string + description: The autocomplete key to be used to fetch autocomplete values. + example: Ephemeral-3644138589235809747-1583470806220-parameter + autoCompleteValues: + type: array + description: The array of values of the corresponding autocomplete parameter. + items: + $ref: '#/components/schemas/AutoCompleteValueSyncDefinition' + lookupFileName: + type: string + description: The lookup file to use as a source for autocomplete values. + lookupLabelColumn: + type: string + description: The column from the lookup file to use for autocomplete labels. + lookupValueColumn: + type: string + description: The column from the lookup file to fill the actual value when + a particular label is selected. + AutoCompleteValueSyncDefinition: + required: + - label + - value + type: object + properties: + label: + type: string + description: The label of the autocomplete value. + value: + type: string + description: The value of the autocomplete value. + MetricsQuerySyncDefinition: + required: + - query + - rowId + type: object + properties: + query: + type: string + description: The text of a metrics query. + rowId: + type: string + description: A label referring to the query; used if other metrics queries + reference this one. + ReportAutoParsingInfo: + type: object + properties: + mode: + pattern: ^(intelligent|performance)$|^$ + type: string + description: Can be `intelligent` or `performance` + example: performance + default: performance + description: Auto-parsing information for the panel. This information tells + us whether automatic field extraction from JSON log messages is enabled or + not + ReportScheduleSyncDefinition: + required: + - emailNotification + - reportFormat + - scheduleType + - timeZone + type: object + properties: + timeRange: + $ref: '#/components/schemas/ResolvableTimeRange' + variableValues: + $ref: '#/components/schemas/VariablesValuesData' + reportFormat: + pattern: ^(Pdf|Png)$ + type: string + description: File format of the report. Can be `Pdf` or `Png`. `Pdf` is + portable document format. `Png` is portable graphics image format. + example: Pdf + x-pattern-message: "should be one of the following: 'Pdf', 'Png'" + scheduleType: + type: string + description: |- + Run schedule of the scheduled report. Set to "Custom" to specify the schedule with a CRON expression. Possible schedule types are: + - `RealTime` + - `15Minutes` + - `1Hour` + - `2Hours` + - `4Hours` + - `6Hours` + - `8Hours` + - `12Hours` + - `1Day` + - `1Week` + - `Custom` + example: 1Day + cronExpression: + type: string + description: "Cron-like expression specifying the report's schedule. Field\ + \ scheduleType must be set to \"Custom\", otherwise, scheduleType takes\ + \ precedence over cronExpression." + example: 0 0/15 * * * ? * + timeZone: + maxLength: 1024 + minLength: 1 + type: string + description: "Time zone identifier for time specification. Either an abbreviation\ + \ such as \"PST\", a full name such as \"America/Los_Angeles\", or a custom\ + \ ID such as \"GMT-8:00\". Note that the support of abbreviations is for\ + \ JDK 1.1.x compatibility only and full names should be used." + example: America/Los_Angeles + emailNotification: + $ref: '#/components/schemas/Email' + isActive: + type: boolean + description: Is the dashboard report schedule active + default: true + SavedSearchSyncDefinitionBase: + required: + - byReceiptTime + - queryParameters + - queryText + type: object + properties: + queryText: + type: string + description: The text of a Sumo Logic query. + byReceiptTime: + type: boolean + description: "Set it to true to run the search using receipt time. By default,\ + \ searches do not run by receipt time." + default: false + viewName: + type: string + description: The name of the Scheduled View that has indexed the data you + want to search. + viewStartTime: + type: string + description: Start timestamp of the Scheduled View in UTC format. + format: date-time + queryParameters: + type: array + description: An array of search query parameter objects. + items: + $ref: '#/components/schemas/QueryParameterSyncDefinition' + parsingMode: + type: string + description: |- + Define the parsing mode to scan the JSON format log messages. Possible values are: + 1. `AutoParse` + 2. `Manual` + In AutoParse mode, the system automatically figures out fields to parse based on the search query. While in the Manual mode, no fields are parsed out automatically. For more information see [Dynamic Parsing](https://help.sumologic.com/?cid=0011). + example: AutoParse + default: Manual + intervalTimeType: + pattern: ^(messageTime|receiptTime|searchableTime)$ + type: string + description: "This parameter defines whether you want to run the search\ + \ by messageTime, receiptTime, or searchableTime. By default, the search\ + \ will run by messageTime. If both runByReceiptTime and intervalTimeType\ + \ parameters are present then the preference will be given to the intervalTimeType.\ + \ This is available in beta only(Contact your sumologic representative\ + \ to enable this feature)." + example: messageTime + default: messageTime + x-pattern-message: "must be one of the following: `messageTime`, `receiptTime`,\ + \ `searchableTime`" + SearchScheduleWithDependencySyncDefinition: + type: object + properties: + searchSchedule: + $ref: '#/components/schemas/SearchScheduleSyncDefinition' + dependencyDetail: + $ref: '#/components/schemas/ScheduleDependencyDetail' + lookupTableDependencies: + type: array + description: Lookup tables that this search schedule depends on + items: + $ref: '#/components/schemas/LookupTableSyncDefinition' + ScheduleDependencyDetail: + required: + - endpointDetail + type: object + properties: + endpointDetail: + $ref: '#/components/schemas/ConnectionDefinition' + MetricsSavedSearchQuerySyncDefinition: + required: + - query + - rowId + type: object + properties: + rowId: + type: string + description: Row id. All rows ids are represented by subsequent upper case + letters starting with `A`. + example: A + query: + type: string + description: Metrics query. + example: my_metric | avg + description: Definition of a metrics query. + ResourceIdentity: + required: + - id + - type + type: object + properties: + id: + type: string + description: The unique identifier of the resource. + example: C03E086C137F38B4 + name: + type: string + description: The name of the resource. + example: "S3 Source, Scheduled View name." + default: Unknown + type: + type: string + description: "-> Resource type. Supported types are - `Collector`, `Source`,\ + \ `IngestBudget` and `Organisation`." + example: Collector + discriminator: + propertyName: type + mapping: + Collector: '#/components/schemas/CollectorResourceIdentity' + Source: '#/components/schemas/SourceResourceIdentity' + IngestBudget: '#/components/schemas/IngestBudgetResourceIdentity' + Organisation: '#/components/schemas/OrgIdentity' + LogsToMetricsRule: '#/components/schemas/LogsToMetricsRuleIdentity' + ScheduledView: '#/components/schemas/ScheduledViewResourceIdentity' + TrackerIdentity: + required: + - description + - error + - trackerId + type: object + properties: + trackerId: + type: string + description: Name that uniquely identifies the health event. It focuses + on what happened rather than why. + error: + type: string + description: Description of the underlying reason for the event change. + example: Access denied to Amazon S3 bucket + description: + type: string + description: A more elaborate description of why the event occurred. + example: S3 collection is not working as expected because of access issues. + discriminator: + propertyName: description + DataIngestAffectedTracker: + type: object + properties: + eventType: + type: string + description: Event type. + discriminator: + propertyName: eventType + S3CollectionErrorTracker: + type: object + properties: + eventType: + type: string + description: Event type. + discriminator: + propertyName: eventType + FileCollectionErrorTracker: + type: object + properties: + eventType: + type: string + description: Event type. + discriminator: + propertyName: eventType + AwsCloudWatchCollectionErrorTracker: + type: object + properties: + eventType: + type: string + description: Event type. + discriminator: + propertyName: eventType + AwsInventoryCollectionErrorTracker: + type: object + properties: + eventType: + type: string + description: Event type. + discriminator: + propertyName: eventType + CSEWindowsErrorTracker: + type: object + properties: + eventType: + type: string + description: Event type. + discriminator: + propertyName: eventType + CSEWindowsAccessErrorTracker: + type: object + properties: + eventType: + type: string + description: Event type. + discriminator: + propertyName: eventType + CSEWindowsSensorOutOfStorageTracker: + type: object + properties: + eventType: + type: string + description: Event type. + discriminator: + propertyName: eventType + CSEWindowsParsingErrorTracker: + type: object + properties: + eventType: + type: string + description: Event type. + discriminator: + propertyName: eventType + CSEWindowsExcessiveBacklogTracker: + type: object + properties: + eventType: + type: string + description: Event type. + discriminator: + propertyName: eventType + MetricsMetadataKeyLengthLimitExceededTracker: + allOf: + - $ref: '#/components/schemas/TrackerIdentity' + - $ref: '#/components/schemas/MetricsMetadataLimitsExceededTracker' + MetricsMetadataLimitsExceededTracker: + type: object + properties: + eventType: + type: string + description: Event type. + discriminator: + propertyName: eventType + MetricsMetadataValueLengthLimitExceededTracker: + allOf: + - $ref: '#/components/schemas/TrackerIdentity' + - $ref: '#/components/schemas/MetricsMetadataLimitsExceededTracker' + MetricsMetadataKeyValuePairsLimitExceededTracker: + allOf: + - $ref: '#/components/schemas/TrackerIdentity' + - $ref: '#/components/schemas/MetricsMetadataLimitsExceededTracker' + MetricsMetadataTotalMetadataSizeLimitExceededTracker: + allOf: + - $ref: '#/components/schemas/TrackerIdentity' + - $ref: '#/components/schemas/MetricsMetadataLimitsExceededTracker' + MetricNameErrorTracker: + type: object + properties: + eventType: + type: string + description: Event type. + discriminator: + propertyName: eventType + OTCReceiverErrorTracker: + type: object + properties: + eventType: + type: string + description: Event type. + discriminator: + propertyName: eventType + OTCExporterErrorTracker: + type: object + properties: + eventType: + type: string + description: Event type. + discriminator: + propertyName: eventType + OTCProcessErrorTracker: + type: object + properties: + eventType: + type: string + description: Event type. + discriminator: + propertyName: eventType + Action: + required: + - connectionType + type: object + properties: + connectionType: + pattern: ^(Email|AWSLambda|AzureFunctions|Datadog|HipChat|Jira|NewRelic|Opsgenie|PagerDuty|Slack|MicrosoftTeams|ServiceNow|SumoCloudSOAR|Webhook)$ + type: string + description: |- + Connection type of the connection. Valid values: + 1. `Email` + 2. `AWSLambda` + 3. `AzureFunctions` + 4. `Datadog` + 5. `HipChat` + 6. `Jira` + 7. `NewRelic` + 8. `Opsgenie` + 9. `PagerDuty` + 10. `Slack` + 11. `MicrosoftTeams` + 12. `ServiceNow` + 13. `SumoCloudSOAR` + 14. `Webhook` + x-pattern-message: "should be one of the following: 'Email', 'AWSLambda',\ + \ 'AzureFunctions', 'Datadog', 'HipChat', 'Jira', 'NewRelic', 'Opsgenie',\ + \ 'PagerDuty', 'Slack', 'MicrosoftTeams', 'ServiceNow', 'SumoCloudSOAR'\ + \ and 'Webhook'" + description: The base class of all connection types. + discriminator: + propertyName: connectionType + StaticThreshold: + type: number + description: The data value for the condition. This defines the threshold for + when to trigger. Threshold value is not applicable for `MissingData` and `ResolvedMissingData` + triggerTypes and will be ignored if specified. + format: double + example: 50.0 + default: 0.0 + StaticThresholdType: + pattern: ^(LessThan|GreaterThan|LessThanOrEqual|GreaterThanOrEqual)$ + type: string + description: |- + The comparison type for the `threshold` evaluation. This defines how you want the data value compared. Valid values: + 1. `LessThan`: Less than than the configured threshold. + 2. `GreaterThan`: Greater than the configured threshold. + 3. `LessThanOrEqual`: Less than or equal to the configured threshold. + 4. `GreaterThanOrEqual`: Greater than or equal to the configured threshold. + ThresholdType value is not applicable for `MissingData` and `ResolvedMissingData` triggerTypes and will be ignored if specified. + example: GreaterThanOrEqual + default: GreaterThanOrEqual + x-pattern-message: "should be one of the following: 'LessThan', 'GreaterThan',\ + \ 'LessThanOrEqual', or 'GreaterThanOrEqual'" + OccurrenceType: + pattern: ^(AtLeastOnce|Always|ResultCount|MissingData)$ + type: string + description: |- + The criteria to evaluate the threshold and thresholdType in the given time range. Valid values: + 1. `AtLeastOnce`: Trigger if the threshold is met at least once. (NOTE: This is the only valid value if monitorType is `Metrics`.) + 2. `Always`: Trigger if the threshold is met continuously. (NOTE: This is the only valid value if monitorType is `Metrics`.) + 3. `ResultCount`: Trigger if the threshold is met against the count of results. (NOTE: This is the only valid value if monitorType is `Logs`.) + 4. `MissingData`: Trigger if the data is missing. (NOTE: This is valid for both `Logs` and `Metrics` monitorTypes) + example: ResultCount + x-pattern-message: "should be one of the following: 'AtLeastOnce', 'Always',\ + \ 'ResultCount' or 'MissingData'" + TriggerSource: + pattern: ^(AllTimeSeries|AnyTimeSeries|AllResults)$ + type: string + description: |- + Determines which time series from queries to use for Metrics MissingData and ResolvedMissingData triggers Valid values: + 1. `AllTimeSeries`: Evaluate the condition against all time series. (NOTE: This option is only valid if monitorType is `Metrics`) + 2. `AnyTimeSeries`: Evaluate the condition against any time series. (NOTE: This option is only valid if monitorType is `Metrics`) + 3. `AllResults`: Evaluate the condition against results from all queries. (NOTE: This option is only valid if monitorType is `Logs`) + example: AllResults + x-pattern-message: "should be one of the following: 'AllTimeSeries', 'AnyTimeSeries',\ + \ or 'AllResults'" + OutlierDirection_1: + pattern: ^(Both|Up|Down)$ + type: string + description: Specifies which direction should trigger violations. + example: Up + default: Both + x-pattern-message: "should be one of the following: 'Both', 'Up', 'Down'" + BurnRate: + required: + - burnRateThreshold + - timeRange + type: object + properties: + burnRateThreshold: + type: number + description: The error budget depletion percentage. + format: double + example: 90 + timeRange: + type: string + description: The relative time range for measuring error budget depletion. + example: -2h + description: Object containing error budget depletion and alert time range. + MonitorDependency: + required: + - endpointDetail + type: object + properties: + endpointDetail: + $ref: '#/components/schemas/ConnectionDefinition' + logs-data-forwarding-rule-management: + type: object + LogSearchScheduleSyncDefinition: + required: + - notification + - parseableTimeRange + - scheduleType + - timeZone + type: object + properties: + cronExpression: + type: string + description: "Cron-like expression specifying the search's schedule. Field\ + \ scheduleType must be set to \"Custom\", otherwise, scheduleType takes\ + \ precedence over cronExpression." + example: 0 0/15 * * * ? * + displayableTimeRange: + type: string + description: "A human-friendly text describing the query time range. For\ + \ e.g. \"-2h\", \"last three days\", \"team default time\". This value\ + \ can not be set via API." + example: -2h + parseableTimeRange: + $ref: '#/components/schemas/ResolvableTimeRange' + timeZone: + type: string + description: "Time zone identifier for time specification. Either an abbreviation\ + \ such as \"PST\", a full name such as \"America/Los_Angeles\", or a custom\ + \ ID such as \"GMT-8:00\". Note that the support of abbreviations is for\ + \ JDK 1.1.x compatibility only and full names should be used. The GMT\ + \ time zone is chosen if the given time zone cannot be identified." + threshold: + $ref: '#/components/schemas/LogSearchNotificationThresholdSyncDefinition' + notification: + $ref: '#/components/schemas/ScheduleNotificationSyncDefinition' + scheduleType: + pattern: ^(RealTime|15Minutes|1Hour|2Hours|4Hours|6Hours|8Hours|12Hours|1Day|1Week|Custom)$ + type: string + description: |- + Run schedule of the scheduled search. Set to "Custom" to specify the schedule with a CRON expression.Please note that with Custom, 1Day and 1Week schedule types you need to provide the corresponding cron expression to determine when to actually run the search. e.g. Sample Valid Cron for 1Day is "0 0 16 ? * 2-6 *". Possible schedule types are: + - `RealTime` + - `15Minutes` + - `1Hour` + - `2Hours` + - `4Hours` + - `6Hours` + - `8Hours` + - `12Hours` + - `1Day` + - `1Week` + - `Custom` + muteErrorEmails: + type: boolean + description: "If enabled, emails are not sent out in case of errors with\ + \ the search." + parameters: + maxLength: 50 + type: array + description: "A list of scheduled search template parameters to be used\ + \ while executing the query. This is different from the queryParameters\ + \ field in parent object as this field will be used for execution as\ + \ per the schedule. The parent object field is for search itself, not\ + \ part of execution. Learn more about the search templates here : https://help.sumologic.com/docs/search/get-started-with-search/build-search/search-templates/" + items: + $ref: '#/components/schemas/ScheduleSearchParameterSyncDefinition' + LogSearchNotificationThresholdSyncDefinition: + required: + - count + - operator + type: object + properties: + thresholdType: + pattern: ^(message|group)$ + type: string + description: |- + This property is deprecated. The system will automatically infer the value of this field from the query going forward, so the user-specified value will no longer be honored. + Threshold type. Possible values are: + 1. `message` + 2. `group` + + Use `group` as threshold type if the search query is of aggregate type. For non-aggregate queries, set it to `message`. + operator: + pattern: ^(eq|gt|ge|lt|le)$ + type: string + description: |- + Criterion to be applied when comparing actual result count with expected count. Possible values are: + 1. `eq` + 2. `gt` + 3. `ge` + 4. `lt` + 5. `le` + count: + type: integer + description: Expected result count. + Metadata: + required: + - createdAt + - createdBy + - modifiedAt + - modifiedBy + type: object + properties: + createdAt: + type: string + description: "Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339)\ + \ format." + format: dateTime + createdBy: + type: string + description: Identifier of the user who created the resource. + modifiedAt: + type: string + description: Last modification timestamp in UTC. + format: dateTime + modifiedBy: + type: string + description: Identifier of the user who last modified the resource. + TopologyLabelMap: + required: + - data + type: object + properties: + data: + maxProperties: 1000 + type: object + additionalProperties: + $ref: '#/components/schemas/TopologyLabelValuesList' + description: Map from topology labels to `TopologyLabelValuesList`. + description: | + Map of the topology labels. Each label has a key and a list of values. If a value is `*`, it means the label will match content for all values of its key. + example: + data: + service: + - kube-scheduler + - kube-dns + TopologyLabelValuesList: + type: array + description: List of values corresponding to a key of a label. + example: + - kube-scheduler + items: + type: string + description: Value of the label. + Iso8601TimeRange: + required: + - end + - start + type: object + properties: + start: + type: string + description: "Start time in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339)\ + \ format" + format: date-time + example: 2018-10-16T09:10:00Z + end: + type: string + description: "End time in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339)\ + \ format" + format: date-time + example: 2018-10-16T09:20:00Z + description: | + A simple time range class, where the start and end points are specified in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format + securitySchemes: + basicAuth: + type: http + scheme: basic +x-tagGroups: +- name: Archive Management + tags: + - archiveManagement +- name: Health Events + tags: + - healthEvents +- name: Infrequent Data Tier + tags: + - logSearchesEstimatedUsage +- name: Ingest Budgets Management V2 + tags: + - ingestBudgetManagementV2 +- name: Library Management + tags: + - appManagement + - appManagementV2 + - contentManagement + - dashboardManagement + - folderManagement + - lookupManagement + - contentPermissions + - logSearchesManagement + - parsersLibraryManagement +- name: Metrics + tags: + - metricsSearchesManagement + - transformationRuleManagement + - metricsQuery + - metricsSearchesManagementV2 +- name: Security Management + tags: + - accessKeyManagement + - oauthManagement + - accountManagement + - passwordPolicy + - policiesManagement + - samlConfigurationManagement + - serviceAllowlistManagement + - serviceAccountManagement + - scimUserManagement +- name: Organizations Management + tags: + - orgsManagement +- name: Settings Management + tags: + - connectionManagement + - dynamicParsingRuleManagement + - extractionRuleManagement + - fieldManagementV1 + - partitionManagement + - scheduledViewManagement + - logsDataForwardingManagement + - dataDeletionRules +- name: Tokens Management + tags: + - tokensLibraryManagement +- name: Tracing + tags: + - traces + - spanAnalytics + - serviceMap +- name: Users and Roles Management + tags: + - roleManagement + - roleManagementV2 + - userManagement +- name: Threat Intel Ingest Management + tags: + - threatIntelIngest + - threatIntelIngestProducer +- name: OpenTelemetry Collector Management + tags: + - otCollectorManagementExternal +- name: Source Template Management + tags: + - sourceTemplateManagementExternal +- name: Schema Base Management + tags: + - schemaBaseManagement +- name: Event Analytics Management + tags: + - eventAnalytics +- name: Budget Management + tags: + - budgetManagement +- name: Macro Management + tags: + - macroManagement +- name: Monitor Management + tags: + - monitorsLibraryManagement +- name: Muting Schedules Management + tags: + - mutingSchedulesLibraryManagement +- name: SLO Management + tags: + - slosLibraryManagement diff --git a/yarn.lock b/yarn.lock index 218024174d..0ec8da6928 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1343,6 +1343,11 @@ resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.28.4.tgz#a70226016fabe25c5783b2f22d3e1c9bc5ca3326" integrity sha512-Q/N6JNWvIvPnLDvjlE1OUBLPQHH6l3CltCEsHIujp45zQUSSh8K+gHnaEX45yAT1nyngnINhvWtzN+Nb9D8RAQ== +"@babel/runtime@^7.17.8": + version "7.29.2" + resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.29.2.tgz#9a6e2d05f4b6692e1801cd4fb176ad823930ed5e" + integrity sha512-JiDShH45zKHWyGe4ZNVRrCjBz8Nh9TMmZG1kh4QTK8hCBTWBi8Da+i7s1fJw7/lYpM4ccepSNfqzZ/QvABBi5g== + "@babel/runtime@^7.18.3", "@babel/runtime@^7.5.5", "@babel/runtime@^7.8.7": version "7.26.10" resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.26.10.tgz#a07b4d8fa27af131a633d7b3524db803eb4764c2" @@ -2431,6 +2436,13 @@ resolved "https://registry.yarnpkg.com/@emotion/hash/-/hash-0.9.2.tgz#ff9221b9f58b4dfe61e619a7788734bd63f6898b" integrity sha512-MyqliTZGuOm3+5ZRSaaBGP3USLw6+EGykkwZns2EPC5g8jJ4z9OrdZY9apkl3+UP9+sdz76YYkwCKP5gh8iY3g== +"@emotion/is-prop-valid@1.4.0": + version "1.4.0" + resolved "https://registry.yarnpkg.com/@emotion/is-prop-valid/-/is-prop-valid-1.4.0.tgz#e9ad47adff0b5c94c72db3669ce46de33edf28c0" + integrity sha512-QgD4fyscGcbbKwJmqNvUMSE02OsHUa+lAWKdEUIJKgqe5IwRSKd7+KhibEWdaKwgjLj0DRSHA9biAIqGBk05lw== + dependencies: + "@emotion/memoize" "^0.9.0" + "@emotion/is-prop-valid@^1.2.2": version "1.2.2" resolved "https://registry.yarnpkg.com/@emotion/is-prop-valid/-/is-prop-valid-1.2.2.tgz#d4175076679c6a26faa92b03bb786f9e52612337" @@ -2583,6 +2595,11 @@ resolved "https://registry.yarnpkg.com/@eslint/js/-/js-8.57.0.tgz#a5417ae8427873f1dd08b70b3574b453e67b5f7f" integrity sha512-Ys+3g2TaW7gADOJzPt83SJtCDhMjndcDMFVQ/Tj9iA1BfJzFKD9mAUXT3OenpuPHbI6P/myECxRJrofUsDx/5g== +"@exodus/schemasafe@^1.0.0-rc.2": + version "1.3.0" + resolved "https://registry.yarnpkg.com/@exodus/schemasafe/-/schemasafe-1.3.0.tgz#731656abe21e8e769a7f70a4d833e6312fe59b7f" + integrity sha512-5Aap/GaRupgNx/feGBwLLTVv8OQFfv3pq2lPRzPg9R+IOBnDgghTGW7l7EuVXOvg5cc/xSAlRW8rBrjIC3Nvqw== + "@floating-ui/core@^1.7.4": version "1.7.4" resolved "https://registry.yarnpkg.com/@floating-ui/core/-/core-1.7.4.tgz#4a006a6e01565c0f87ba222c317b056a2cffd2f4" @@ -3110,6 +3127,11 @@ resolved "https://registry.yarnpkg.com/@noble/hashes/-/hashes-1.4.0.tgz#45814aa329f30e4fe0ba49426f49dfccdd066426" integrity sha512-V1JJ1WTRUqHHrOSh597hURcMqVKVGL/ea3kv0gSnEdsEZ0/+VyPghM1lMNGc00z7CIQorSvbKpuJkxvuHbvdbg== +"@nodable/entities@^2.1.0": + version "2.1.0" + resolved "https://registry.yarnpkg.com/@nodable/entities/-/entities-2.1.0.tgz#f543e5c6446720d4cf9e498a83019dd159973bc2" + integrity sha512-nyT7T3nbMyBI/lvr6L5TyWbFJAI9FTgVRakNoBqCD+PmID8DzFrrNdLLtHMwMszOtqZa8PAOV24ZqDnQrhQINA== + "@nodelib/fs.scandir@2.1.5": version "2.1.5" resolved "https://registry.yarnpkg.com/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz#7619c2eb21b25483f6d167548b4cfd5a7488c3d5" @@ -3316,6 +3338,68 @@ unbzip2-stream "^1.4.3" yargs "^17.7.2" +"@redocly/ajv@8.11.2": + version "8.11.2" + resolved "https://registry.yarnpkg.com/@redocly/ajv/-/ajv-8.11.2.tgz#46e1bf321ec0ac1e0fd31dea41a3d1fcbdcda0b5" + integrity sha512-io1JpnwtIcvojV7QKDUSIuMN/ikdOUd1ReEnUnMKGfDVridQZ31J0MmIuqwuRjWDZfmvr+Q0MqCcfHM2gTivOg== + dependencies: + fast-deep-equal "^3.1.1" + json-schema-traverse "^1.0.0" + require-from-string "^2.0.2" + uri-js-replace "^1.0.1" + +"@redocly/ajv@^8.11.0": + version "8.18.3" + resolved "https://registry.yarnpkg.com/@redocly/ajv/-/ajv-8.18.3.tgz#a925753d9a33375219f1b2ba91aef320f9929577" + integrity sha512-l42u0of3hY98sN2A+M4qTX1O/KrpgGH32Hu9kP2GtHyD5Dfqq86PKFLe5dwaD8DEnNmlOlll2BAmeEtf0DaySg== + dependencies: + fast-deep-equal "^3.1.3" + fast-uri "^3.0.1" + json-schema-traverse "^1.0.0" + require-from-string "^2.0.2" + +"@redocly/config@0.22.0": + version "0.22.0" + resolved "https://registry.yarnpkg.com/@redocly/config/-/config-0.22.0.tgz#b2454f472f9d2b217d56f82e4f28d346901f3242" + integrity sha512-gAy93Ddo01Z3bHuVdPWfCwzgfaYgMdaZPcfL7JZ7hWJoK9V0lXDbigTWkhiPFAaLWzbOJ+kbUQG1+XwIm0KRGQ== + +"@redocly/config@^0.6.0": + version "0.6.3" + resolved "https://registry.yarnpkg.com/@redocly/config/-/config-0.6.3.tgz#0dab6278721abd5aae6b375deee97665005b0472" + integrity sha512-hGWJgCsXRw0Ow4rplqRlUQifZvoSwZipkYnt11e3SeH1Eb23VUIDBcRuaQOUqy1wn0eevXkU2GzzQ8fbKdQ7Mg== + +"@redocly/openapi-core@1.16.0": + version "1.16.0" + resolved "https://registry.yarnpkg.com/@redocly/openapi-core/-/openapi-core-1.16.0.tgz#95afcf822890af3fe8f1bde97018370b5cadb8ca" + integrity sha512-z06h+svyqbUcdAaePq8LPSwTPlm6Ig7j2VlL8skPBYnJvyaQ2IN7x/JkOvRL4ta+wcOCBdAex5JWnZbKaNktJg== + dependencies: + "@redocly/ajv" "^8.11.0" + "@redocly/config" "^0.6.0" + colorette "^1.2.0" + https-proxy-agent "^7.0.4" + js-levenshtein "^1.1.6" + js-yaml "^4.1.0" + lodash.isequal "^4.5.0" + minimatch "^5.0.1" + node-fetch "^2.6.1" + pluralize "^8.0.0" + yaml-ast-parser "0.0.43" + +"@redocly/openapi-core@^1.4.0": + version "1.34.14" + resolved "https://registry.yarnpkg.com/@redocly/openapi-core/-/openapi-core-1.34.14.tgz#3b3ba0a6febe65e6a4f108af37da9ca97df0d678" + integrity sha512-y+xFx+Zz54Xhr8jUdnLENYnt7Y7GEDL6Q03ga7rTtX8DVwefX9H+hQEPgJp1nda7vdH+wJ9/HBVvyfBuW9x6rA== + dependencies: + "@redocly/ajv" "8.11.2" + "@redocly/config" "0.22.0" + colorette "1.4.0" + https-proxy-agent "7.0.6" + js-levenshtein "1.1.6" + js-yaml "4.1.1" + minimatch "5.1.9" + pluralize "8.0.0" + yaml-ast-parser "0.0.43" + "@rspack/binding-darwin-arm64@1.5.8": version "1.5.8" resolved "https://registry.yarnpkg.com/@rspack/binding-darwin-arm64/-/binding-darwin-arm64-1.5.8.tgz#a50909f7bad21de27ea770a86e0e3c85006d95e9" @@ -4312,7 +4396,7 @@ dependencies: "@types/istanbul-lib-report" "*" -"@types/json-schema@*", "@types/json-schema@^7.0.15", "@types/json-schema@^7.0.8", "@types/json-schema@^7.0.9": +"@types/json-schema@*", "@types/json-schema@^7.0.15", "@types/json-schema@^7.0.7", "@types/json-schema@^7.0.8", "@types/json-schema@^7.0.9": version "7.0.15" resolved "https://registry.yarnpkg.com/@types/json-schema/-/json-schema-7.0.15.tgz#596a1747233694d50f6ad8a7869fcb6f56cf5841" integrity sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA== @@ -5507,6 +5591,11 @@ call-bound@^1.0.2, call-bound@^1.0.3: call-bind-apply-helpers "^1.0.2" get-intrinsic "^1.3.0" +call-me-maybe@^1.0.1: + version "1.0.2" + resolved "https://registry.yarnpkg.com/call-me-maybe/-/call-me-maybe-1.0.2.tgz#03f964f19522ba643b1b0693acb9152fe2074baa" + integrity sha512-HpX65o1Hnr9HH25ojC1YGs7HCQLq0GCOibSaWER0eNpgJ/Z1MZv2mTc7+xh6WOPxbRVcmgbv4hGU+uSQ/2xFZQ== + callsites@^3.0.0: version "3.1.0" resolved "https://registry.yarnpkg.com/callsites/-/callsites-3.1.0.tgz#b3630abd8943432f54b3f0519238e33cd7df2f73" @@ -5530,6 +5619,11 @@ camelcase@^7.0.1: resolved "https://registry.yarnpkg.com/camelcase/-/camelcase-7.0.1.tgz#f02e50af9fd7782bc8b88a3558c32fd3a388f048" integrity sha512-xlx1yCK2Oc1APsPXDL2LdlNP6+uu8OCDdhOBSVT279M/S+y75O30C2VuD8T2ogdePBBl7PfPF4504tnLgX3zfw== +camelize@^1.0.0: + version "1.0.1" + resolved "https://registry.yarnpkg.com/camelize/-/camelize-1.0.1.tgz#89b7e16884056331a35d6b5ad064332c91daa6c3" + integrity sha512-dU+Tx2fsypxTgtLoE36npi3UqcjSSMNYfkqgmoEhtZrraP5VWq0K7FkWVTYa8eMPtnU/G2txVsfdCJTn9uzpuQ== + caniuse-api@^3.0.0: version "3.0.0" resolved "https://registry.yarnpkg.com/caniuse-api/-/caniuse-api-3.0.0.tgz#5e4d90e2274961d46291997df599e3ed008ee4c0" @@ -5666,6 +5760,11 @@ ci-info@^3.2.0: resolved "https://registry.yarnpkg.com/ci-info/-/ci-info-3.9.0.tgz#4279a62028a7b1f262f3473fc9605f5e218c59b4" integrity sha512-NIxF55hv4nSqQswkAeiOi1r83xy8JldOFDTWiug55KBu9Jnblncd2U6ViHmYgHf01TPZS77NJBhBMKdWj9HQMQ== +classnames@^2.3.2: + version "2.5.1" + resolved "https://registry.yarnpkg.com/classnames/-/classnames-2.5.1.tgz#ba774c614be0f016da105c858e7159eae8e7687b" + integrity sha512-saHYOzhIQs6wy2sVxTM6bUDsQO4F50V9RQ22qBpEdCW+I+/Wmke2HOl6lS6dTpdxVhb88/I6+Hs+438c3lfUow== + clean-css@^5.2.2, clean-css@^5.3.3, clean-css@~5.3.2: version "5.3.3" resolved "https://registry.yarnpkg.com/clean-css/-/clean-css-5.3.3.tgz#b330653cd3bd6b75009cc25c714cae7b93351ccd" @@ -5732,7 +5831,7 @@ clone-response@^1.0.2: dependencies: mimic-response "^1.0.0" -clsx@^1.1.1: +clsx@^1.1.1, clsx@^1.2.1: version "1.2.1" resolved "https://registry.yarnpkg.com/clsx/-/clsx-1.2.1.tgz#0ddc4a20a549b59c93a4116bb26f5294ca17dc12" integrity sha512-EcR6r5a8bj6pu3ycsa/E/cKVGuTgZJZdsyUYHOksG/UHIiKfjxzRxYJpyVBwYaQeOvghal9fcc4PidlgzugAQg== @@ -5783,6 +5882,11 @@ colord@^2.9.3: resolved "https://registry.yarnpkg.com/colord/-/colord-2.9.3.tgz#4f8ce919de456f1d5c1c368c307fe20f3e59fb43" integrity sha512-jeC1axXpnb0/2nn/Y1LPuLdgXBLH7aDcHu4KEKfqw3CUhX7ZpfBSlPKyqXE6btIgEzfWtrX3/tyBCaCvXvMkOw== +colorette@1.4.0, colorette@^1.2.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/colorette/-/colorette-1.4.0.tgz#5190fbb87276259a86ad700bff2c6d6faa3fca40" + integrity sha512-Y2oEozpomLn7Q3HFP7dpww7AtMJplbM9lGZP6RDfHqmbeRjiwRg4n6VM6j4KLmRke85uWEI7JqF17f3pqdRA0g== + colorette@^2.0.10, colorette@^2.0.20: version "2.0.20" resolved "https://registry.yarnpkg.com/colorette/-/colorette-2.0.20.tgz#9eb793e6833067f7235902fcd3b09917a000a95a" @@ -6070,6 +6174,11 @@ css-blank-pseudo@^7.0.1: dependencies: postcss-selector-parser "^7.0.0" +css-color-keywords@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/css-color-keywords/-/css-color-keywords-1.0.0.tgz#fea2616dc676b2962686b3af8dbdbe180b244e05" + integrity sha512-FyyrDHZKEjXDpNJYvVsV960FiqQyXc/LlYmsxl2BcdMb2WPx0OGRVgTg55rPSyLSNMqP52R9r8geSp7apN3Ofg== + css-declaration-sorter@7.2.0: version "7.2.0" resolved "https://registry.yarnpkg.com/css-declaration-sorter/-/css-declaration-sorter-7.2.0.tgz#6dec1c9523bc4a643e088aab8f09e67a54961024" @@ -6142,6 +6251,15 @@ css-select@^5.1.0: domutils "^3.0.1" nth-check "^2.0.1" +css-to-react-native@3.2.0: + version "3.2.0" + resolved "https://registry.yarnpkg.com/css-to-react-native/-/css-to-react-native-3.2.0.tgz#cdd8099f71024e149e4f6fe17a7d46ecd55f1e32" + integrity sha512-e8RKaLXMOFii+02mOlqwjbD00KSEKqblnpO9e++1aXS1fPQOpS1YoqdVHBqPjHNoxeF2mimzVqawm2KCbEdtHQ== + dependencies: + camelize "^1.0.0" + css-color-keywords "^1.0.0" + postcss-value-parser "^4.0.2" + css-tree@2.3.1, css-tree@^2.3.1: version "2.3.1" resolved "https://registry.yarnpkg.com/css-tree/-/css-tree-2.3.1.tgz#10264ce1e5442e8572fc82fbe490644ff54b5c20" @@ -6247,7 +6365,7 @@ csso@5.0.5, csso@^5.0.5: dependencies: css-tree "~2.2.0" -csstype@^3.0.2, csstype@^3.1.3, csstype@^3.2.2: +csstype@3.2.3, csstype@^3.0.2, csstype@^3.1.3, csstype@^3.2.2: version "3.2.3" resolved "https://registry.yarnpkg.com/csstype/-/csstype-3.2.3.tgz#ec48c0f3e993e50648c86da559e2610995cf989a" integrity sha512-z1HGKcYy2xA8AGQfwrn0PAy+PB7X/GSj3UVJW9qKyn43xWa+gl5nXmU4qqLMRzWVLFC8KusUX8T/0kCiOYpAIQ== @@ -6620,6 +6738,11 @@ debug@^4.3.5, debug@^4.3.6: dependencies: ms "^2.1.3" +decko@^1.2.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/decko/-/decko-1.2.0.tgz#fd43c735e967b8013306884a56fbe665996b6817" + integrity sha512-m8FnyHXV1QX+S1cl+KPFDIl6NMkxtKsy6+U/aYyjrOqWMuwAwYWu7ePqrsUHtDR5Y8Yk2pi/KIDSgF+vT4cPOQ== + decode-named-character-reference@^1.0.0: version "1.2.0" resolved "https://registry.yarnpkg.com/decode-named-character-reference/-/decode-named-character-reference-1.2.0.tgz#25c32ae6dd5e21889549d40f676030e9514cc0ed" @@ -6794,6 +6917,14 @@ doctrine@^3.0.0: dependencies: esutils "^2.0.2" +docusaurus-plugin-redoc@2.5.0: + version "2.5.0" + resolved "https://registry.yarnpkg.com/docusaurus-plugin-redoc/-/docusaurus-plugin-redoc-2.5.0.tgz#d64756b2a8a794b2e9c635abc21b0a51a84a1bcc" + integrity sha512-44sDhuXvItHnUuPdKswF3cRhiN5UW3YZxmMBsQLSfCYKcYr9tgWF2qvDfQoZO9i1DwpaYbIZ/RKMrSgny/iWYA== + dependencies: + "@redocly/openapi-core" "1.16.0" + redoc "2.4.0" + docusaurus-plugin-sass@^0.2.1: version "0.2.5" resolved "https://registry.yarnpkg.com/docusaurus-plugin-sass/-/docusaurus-plugin-sass-0.2.5.tgz#6bfb8a227ac6265be685dcbc24ba1989e27b8005" @@ -6801,6 +6932,20 @@ docusaurus-plugin-sass@^0.2.1: dependencies: sass-loader "^10.1.1" +docusaurus-theme-redoc@2.5.0: + version "2.5.0" + resolved "https://registry.yarnpkg.com/docusaurus-theme-redoc/-/docusaurus-theme-redoc-2.5.0.tgz#b8d6f033a7d88485c0d86b3b28c0a98a5d7a8900" + integrity sha512-ykLmnnvE20Im3eABlIpUnXnT2gSHVAjgyy2fU2G8yecu7zqIE+G/SiBpBg/hrWMUycL31a8VSG7Ehkf3pg1u+A== + dependencies: + "@redocly/openapi-core" "1.16.0" + clsx "^1.2.1" + lodash "^4.17.21" + mobx "^6.12.4" + postcss "^8.4.45" + postcss-prefix-selector "^1.16.1" + redoc "2.4.0" + styled-components "^6.1.11" + docusaurus2-dotenv@^1.4.0: version "1.4.0" resolved "https://registry.yarnpkg.com/docusaurus2-dotenv/-/docusaurus2-dotenv-1.4.0.tgz#9ab900e29de9081f9f1f28f7224ff63760385641" @@ -6860,6 +7005,13 @@ domhandler@^5.0.2, domhandler@^5.0.3: dependencies: domelementtype "^2.3.0" +dompurify@^3.0.6: + version "3.4.5" + resolved "https://registry.yarnpkg.com/dompurify/-/dompurify-3.4.5.tgz#bedc7d30a6007ae9a8937b952be6adb76a28e871" + integrity sha512-OrwIBKsdNSVEeubdJ1HBv/wNENRM9ytAVCv7YXt//A3vPdVMNuACRqK9mXCGCBW2ln7BT/A4X0jXHo2Gu89miA== + optionalDependencies: + "@types/trusted-types" "^2.0.7" + dompurify@^3.3.1: version "3.4.2" resolved "https://registry.yarnpkg.com/dompurify/-/dompurify-3.4.2.tgz#f0ff81be682c485505097ba8195a058d8f575218" @@ -7164,6 +7316,11 @@ es-toolkit@^1.45.1: resolved "https://registry.yarnpkg.com/es-toolkit/-/es-toolkit-1.46.1.tgz#38ca27191a98a867fc544b81cf1477a68947fb06" integrity sha512-5eNtXOs3tbfxXOj04tjjseeWkRWaoCjdEI+96DgwzZoe6c9juL49pXlzAFTI72aWC9Y8p7168g6XIKjh7k6pyQ== +es6-promise@^3.2.1: + version "3.3.1" + resolved "https://registry.yarnpkg.com/es6-promise/-/es6-promise-3.3.1.tgz#a08cdde84ccdbf34d027a1451bc91d4bcd28a613" + integrity sha512-SOp9Phqvqn7jtEUxPWdWfWoLmyt2VaJ6MpvP9Comy1MceMXqE6bxvaTu4iaxpYYPzhny28Lc+M87/c2cPK6lDg== + esast-util-from-estree@^2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/esast-util-from-estree/-/esast-util-from-estree-2.0.0.tgz#8d1cfb51ad534d2f159dc250e604f3478a79f1ad" @@ -7664,11 +7821,35 @@ fast-levenshtein@^2.0.6: resolved "https://registry.yarnpkg.com/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz#3d8a5c66883a16a30ca8643e851f19baa7797917" integrity sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw== +fast-safe-stringify@^2.0.7: + version "2.1.1" + resolved "https://registry.yarnpkg.com/fast-safe-stringify/-/fast-safe-stringify-2.1.1.tgz#c406a83b6e70d9e35ce3b30a81141df30aeba884" + integrity sha512-W+KJc2dmILlPplD/H4K9l9LcAHAfPtP6BY84uVLXQ6Evcz9Lcg33Y2z1IVblT6xdY54PXYVHEv+0Wpq8Io6zkA== + fast-uri@^3.0.1: version "3.1.2" resolved "https://registry.yarnpkg.com/fast-uri/-/fast-uri-3.1.2.tgz#8af3d4fc9d3e71b11572cc2673b514a7d1a8c8ec" integrity sha512-rVjf7ArG3LTk+FS6Yw81V1DLuZl1bRbNrev6Tmd/9RaroeeRRJhAt7jg/6YFxbvAQXUCavSoZhPPj6oOx+5KjQ== +fast-xml-builder@^1.2.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/fast-xml-builder/-/fast-xml-builder-1.2.0.tgz#abd2363145a7625d9789ad96da375fabe3cff28c" + integrity sha512-00aAWieqff+ZJhsXA4g1g7M8k+7AYoMUUHF+/zFb5U6Uv/P0Vl4QZo84/IcufzYalLuEj9928bXN9PbbFzMF0Q== + dependencies: + path-expression-matcher "^1.5.0" + xml-naming "^0.1.0" + +fast-xml-parser@^5.5.1: + version "5.8.0" + resolved "https://registry.yarnpkg.com/fast-xml-parser/-/fast-xml-parser-5.8.0.tgz#64d71f0f8d4bf23621dffd762aef7e98c1884fc1" + integrity sha512-6bIM7fsJxeo3uXv7OncQYsBAMPJ7V16Slahl/6M98C/i2q+vB1+4a0MtrvYwDFEUrwDSbAmeLDRXsOBwrL7yAg== + dependencies: + "@nodable/entities" "^2.1.0" + fast-xml-builder "^1.2.0" + path-expression-matcher "^1.5.0" + strnum "^2.3.0" + xml-naming "^0.1.0" + fastq@^1.6.0: version "1.19.1" resolved "https://registry.yarnpkg.com/fastq/-/fastq-1.19.1.tgz#d50eaba803c8846a883c16492821ebcd2cda55f5" @@ -7836,6 +8017,11 @@ for-each@^0.3.3: dependencies: is-callable "^1.1.3" +foreach@^2.0.4: + version "2.0.6" + resolved "https://registry.yarnpkg.com/foreach/-/foreach-2.0.6.tgz#87bcc8a1a0e74000ff2bf9802110708cfb02eb6e" + integrity sha512-k6GAGDyqLe9JaebCsFCoudPPWfihKu8pylYXRlqP1J7ms39iPoTtk2fviNglIeQEwdh0bQeKJ01ZPyuyQvKzwg== + foreground-child@^3.1.0: version "3.2.1" resolved "https://registry.yarnpkg.com/foreground-child/-/foreground-child-3.2.1.tgz#767004ccf3a5b30df39bed90718bab43fe0a59f7" @@ -8625,6 +8811,11 @@ http-proxy@^1.18.1: follow-redirects "^1.0.0" requires-port "^1.0.0" +http2-client@^1.2.5: + version "1.3.5" + resolved "https://registry.yarnpkg.com/http2-client/-/http2-client-1.3.5.tgz#20c9dc909e3cc98284dd20af2432c524086df181" + integrity sha512-EC2utToWl4RKfs5zd36Mxq7nzHHBuomZboI0yYL6Y0RmBgT7Sgkq4rQ0ezFTYoIsSs7Tm9SJe+o2FcAg6GBhGA== + http2-wrapper@^1.0.0-beta.5.2: version "1.0.3" resolved "https://registry.yarnpkg.com/http2-wrapper/-/http2-wrapper-1.0.3.tgz#b8f55e0c1f25d4ebd08b3b0c2c079f9590800b3d" @@ -8641,7 +8832,7 @@ http2-wrapper@^2.1.10: quick-lru "^5.1.1" resolve-alpn "^1.2.0" -https-proxy-agent@^7.0.6: +https-proxy-agent@7.0.6, https-proxy-agent@^7.0.4, https-proxy-agent@^7.0.6: version "7.0.6" resolved "https://registry.yarnpkg.com/https-proxy-agent/-/https-proxy-agent-7.0.6.tgz#da8dfeac7da130b05c2ba4b59c9b6cd66611a6b9" integrity sha512-vK9P5/iUfdl95AI+JVyUuIcVtd4ofvtrOr3HNtM2yxC9bnMbEdp3x01OhQNnjb8IJYi38VlTE3mBXwcfvywuSw== @@ -9283,11 +9474,23 @@ joi@^17.9.2: "@sideway/formula" "^3.0.1" "@sideway/pinpoint" "^2.0.0" +js-levenshtein@1.1.6, js-levenshtein@^1.1.6: + version "1.1.6" + resolved "https://registry.yarnpkg.com/js-levenshtein/-/js-levenshtein-1.1.6.tgz#c6cee58eb3550372df8deb85fad5ce66ce01d59d" + integrity sha512-X2BB11YZtrRqY4EnQcLX5Rh373zbK4alC1FW7D7MBhL2gtcC17cTnr6DmfHZeS0s2rTHjUTMMHfG7gO8SSdw+g== + "js-tokens@^3.0.0 || ^4.0.0", js-tokens@^4.0.0: version "4.0.0" resolved "https://registry.yarnpkg.com/js-tokens/-/js-tokens-4.0.0.tgz#19203fb59991df98e3a287050d4647cdeaf32499" integrity sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ== +js-yaml@4.1.1: + version "4.1.1" + resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-4.1.1.tgz#854c292467705b699476e1a2decc0c8a3458806b" + integrity sha512-qQKT4zQxXl8lLwBtHMWwaTcGfFOZviOJet3Oy/xmGk2gZH677CJM9EvtfdSkgWcATZhj/55JZ0rmy3myCT5lsA== + dependencies: + argparse "^2.0.1" + js-yaml@^3.13.1: version "3.14.1" resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-3.14.1.tgz#dae812fdb3825fa306609a8717383c50c36a0537" @@ -9328,6 +9531,13 @@ json-parse-even-better-errors@^2.3.0, json-parse-even-better-errors@^2.3.1: resolved "https://registry.yarnpkg.com/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz#7c47805a94319928e05777405dc12e1f7a4ee02d" integrity sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w== +json-pointer@0.6.2, json-pointer@^0.6.2: + version "0.6.2" + resolved "https://registry.yarnpkg.com/json-pointer/-/json-pointer-0.6.2.tgz#f97bd7550be5e9ea901f8c9264c9d436a22a93cd" + integrity sha512-vLWcKbOaXlO+jvRy4qNd+TI1QUPZzfJj1tpJ3vAXDych5XJf93ftpUKe5pKCrzyIIwgBJcOcCVRUfqQP25afBw== + dependencies: + foreach "^2.0.4" + json-schema-traverse@^0.4.1: version "0.4.1" resolved "https://registry.yarnpkg.com/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz#69f6a87d9513ab8bb8fe63bdb0979c448e684660" @@ -9603,6 +9813,11 @@ lodash.debounce@^4.0.8: resolved "https://registry.yarnpkg.com/lodash.debounce/-/lodash.debounce-4.0.8.tgz#82d79bff30a67c4005ffd5e2515300ad9ca4d7af" integrity sha512-FT1yDzDYEoYWhnSGnpE/4Kj1fLZkDFyqRb7fNt6FdYOSxlUWAtp42Eh6Wb0rGIv/m9Bgo7x4GhQbm5Ys4SG5ow== +lodash.isequal@^4.5.0: + version "4.5.0" + resolved "https://registry.yarnpkg.com/lodash.isequal/-/lodash.isequal-4.5.0.tgz#415c4478f2bcc30120c22ce10ed3226f7d3e18e0" + integrity sha512-pDo3lu8Jhfjqls6GkMgpahsF9kCyayhgykjyLMNFTKWrpVdAQtYyB4muAMWozBB4ig/dtWAmsMxLEI8wuz+DYQ== + lodash.memoize@^4.1.2: version "4.1.2" resolved "https://registry.yarnpkg.com/lodash.memoize/-/lodash.memoize-4.1.2.tgz#bcc6c49a42a2840ed997f323eada5ecd182e0bfe" @@ -9688,6 +9903,16 @@ lru-cache@^7.14.1: resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-7.18.3.tgz#f793896e0fd0e954a59dfdd82f0773808df6aa89" integrity sha512-jumlc0BIUrS3qJGgIkWZsyfAM7NCWiBcCDhnd+3NNM5KbBmLTgHVfWBcg6W+rLUsIpzpERPsvwUP7CckAQSOoA== +lunr@^2.3.9: + version "2.3.9" + resolved "https://registry.yarnpkg.com/lunr/-/lunr-2.3.9.tgz#18b123142832337dd6e964df1a5a7707b25d35e1" + integrity sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow== + +mark.js@^8.11.1: + version "8.11.1" + resolved "https://registry.yarnpkg.com/mark.js/-/mark.js-8.11.1.tgz#180f1f9ebef8b0e638e4166ad52db879beb2ffc5" + integrity sha512-1I+1qpDt4idfgLQG+BNWmrqku+7/2bi5nLf4YwF8y8zXvmfiTBY3PV3ZibfrjBueCByROpuBjLLFCajqkgYoLQ== + markdown-extensions@^2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/markdown-extensions/-/markdown-extensions-2.0.0.tgz#34bebc83e9938cae16e0e017e4a9814a8330d3c4" @@ -9710,6 +9935,11 @@ marked@^16.3.0: resolved "https://registry.yarnpkg.com/marked/-/marked-16.4.2.tgz#4959a64be6c486f0db7467ead7ce288de54290a3" integrity sha512-TI3V8YYWvkVf3KJe1dRkpnjs68JUPyEa5vjKrp1XEEJUAOaQc+Qj+L1qWbPd0SJuAdQkFU0h73sXXqwDYxsiDA== +marked@^4.3.0: + version "4.3.0" + resolved "https://registry.yarnpkg.com/marked/-/marked-4.3.0.tgz#796362821b019f734054582038b116481b456cf3" + integrity sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A== + math-intrinsics@^1.1.0: version "1.1.0" resolved "https://registry.yarnpkg.com/math-intrinsics/-/math-intrinsics-1.1.0.tgz#a0dd74be81e2aa5c2f27e65ce283605ee4e2b7f9" @@ -10908,6 +11138,13 @@ minimatch@3.1.5: dependencies: brace-expansion "^1.1.7" +minimatch@5.1.9, minimatch@^5.0.1: + version "5.1.9" + resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-5.1.9.tgz#1293ef15db0098b394540e8f9f744f9fda8dee4b" + integrity sha512-7o1wEA2RyMP7Iu7GNba9vc0RWWGACJOCZBJX2GJWip0ikV+wcOsgVuY9uE8CPiyQhkGFSlhuSkZPavN7u1c2Fw== + dependencies: + brace-expansion "^2.0.1" + minimatch@^9.0.3: version "9.0.5" resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-9.0.5.tgz#d74f9dd6b57d83d8e98cfb82133b03978bc929e5" @@ -10937,6 +11174,25 @@ mitt@3.0.1: resolved "https://registry.yarnpkg.com/mitt/-/mitt-3.0.1.tgz#ea36cf0cc30403601ae074c8f77b7092cdab36d1" integrity sha512-vKivATfr97l2/QBCYAkXYDbrIWPM2IIKEl7YPhjCvKlG3kE2gm+uBo6nEXK3M5/Ffh/FLpKExzOQ3JJoJGFKBw== +mobx-react-lite@^4.1.1: + version "4.1.1" + resolved "https://registry.yarnpkg.com/mobx-react-lite/-/mobx-react-lite-4.1.1.tgz#725d74b025235f73dc2ab815766ffe010be2cf8a" + integrity sha512-iUxiMpsvNraCKXU+yPotsOncNNmyeS2B5DKL+TL6Tar/xm+wwNJAubJmtRSeAoYawdZqwv8Z/+5nPRHeQxTiXg== + dependencies: + use-sync-external-store "^1.4.0" + +mobx-react@^9.1.1: + version "9.2.1" + resolved "https://registry.yarnpkg.com/mobx-react/-/mobx-react-9.2.1.tgz#19b1036442d2515eeb6f5fbb2c9c770d81c32f80" + integrity sha512-WJNNm0FB2n0Z0u+jS1QHmmWyV8l2WiAj8V8I/96kbUEN2YbYCoKW+hbbqKKRUBqElu0llxM7nWKehvRIkhBVJw== + dependencies: + mobx-react-lite "^4.1.1" + +mobx@^6.12.4: + version "6.15.3" + resolved "https://registry.yarnpkg.com/mobx/-/mobx-6.15.3.tgz#9ba303d2220fcd4253e34f0702a2a266aa29871f" + integrity sha512-6+ZSYDs5zgH5CdGfEU2q2Lsa5PztVryL1ys7kAImTU25n2A9LAMj/yneVsQpd03MfwMLDQF+7kakJR9Z+cQxSw== + mri@^1.1.0: version "1.2.0" resolved "https://registry.yarnpkg.com/mri/-/mri-1.2.0.tgz#6721480fec2a11a4889861115a48b6cbe7cc8f0b" @@ -10984,6 +11240,11 @@ nanoid@^3.3.11, nanoid@^3.3.8: resolved "https://registry.yarnpkg.com/nanoid/-/nanoid-3.3.11.tgz#4f4f112cefbe303202f2199838128936266d185b" integrity sha512-N8SpfPUnUp1bK+PMYW8qSWdl9U+wwNWI4QKxOYDy9JAro3WMX7p2OeVRF9v+347pnakNevPmiHhNmZ2HbFA76w== +nanoid@^3.3.12: + version "3.3.12" + resolved "https://registry.yarnpkg.com/nanoid/-/nanoid-3.3.12.tgz#ab3d912e217a6d0a514f00a72a16543a28982c05" + integrity sha512-ZB9RH/39qpq5Vu6Y+NmUaFhQR6pp+M2Xt76XBnEwDaGcVAqhlvxrl3B2bKS5D3NH3QR76v3aSrKaF/Kiy7lEtQ== + natural-compare-lite@^1.4.0: version "1.4.0" resolved "https://registry.yarnpkg.com/natural-compare-lite/-/natural-compare-lite-1.4.0.tgz#17b09581988979fddafe0201e931ba933c96cbb4" @@ -11037,7 +11298,14 @@ node-emoji@^2.1.0: emojilib "^2.4.0" skin-tone "^2.0.0" -node-fetch@^2.6.7: +node-fetch-h2@^2.3.0: + version "2.3.0" + resolved "https://registry.yarnpkg.com/node-fetch-h2/-/node-fetch-h2-2.3.0.tgz#c6188325f9bd3d834020bf0f2d6dc17ced2241ac" + integrity sha512-ofRW94Ab0T4AOh5Fk8t0h8OBWrmjb0SSB20xh1H8YnPV9EJ+f5AMoYSUQ2zgJ4Iq2HAK0I2l5/Nequ8YzFS3Hg== + dependencies: + http2-client "^1.2.5" + +node-fetch@^2.6.1, node-fetch@^2.6.7: version "2.7.0" resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.7.0.tgz#d0f0fa6e3e2dc1d27efcd8ad99d550bda94d187d" integrity sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A== @@ -11049,6 +11317,13 @@ node-forge@^1.4.0: resolved "https://registry.yarnpkg.com/node-forge/-/node-forge-1.4.0.tgz#1c7b7d8bdc2d078739f58287d589d903a11b2fc2" integrity sha512-LarFH0+6VfriEhqMMcLX2F7SwSXeWwnEAJEsYm5QKWchiVYVvJyV9v7UDvUv+w5HO23ZpQTXDv/GxdDdMyOuoQ== +node-readfiles@^0.2.0: + version "0.2.0" + resolved "https://registry.yarnpkg.com/node-readfiles/-/node-readfiles-0.2.0.tgz#dbbd4af12134e2e635c245ef93ffcf6f60673a5d" + integrity sha512-SU00ZarexNlE4Rjdm83vglt5Y9yiQ+XI1XpflWlb7q7UTN1JUItm69xMeiQCTxtTfnzt+83T8Cx+vI2ED++VDA== + dependencies: + es6-promise "^3.2.1" + node-releases@^2.0.27: version "2.0.27" resolved "https://registry.yarnpkg.com/node-releases/-/node-releases-2.0.27.tgz#eedca519205cf20f650f61d56b070db111231e4e" @@ -11115,6 +11390,52 @@ null-loader@^4.0.1: loader-utils "^2.0.0" schema-utils "^3.0.0" +oas-kit-common@^1.0.8: + version "1.0.8" + resolved "https://registry.yarnpkg.com/oas-kit-common/-/oas-kit-common-1.0.8.tgz#6d8cacf6e9097967a4c7ea8bcbcbd77018e1f535" + integrity sha512-pJTS2+T0oGIwgjGpw7sIRU8RQMcUoKCDWFLdBqKB2BNmGpbBMH2sdqAaOXUg8OzonZHU0L7vfJu1mJFEiYDWOQ== + dependencies: + fast-safe-stringify "^2.0.7" + +oas-linter@^3.2.2: + version "3.2.2" + resolved "https://registry.yarnpkg.com/oas-linter/-/oas-linter-3.2.2.tgz#ab6a33736313490659035ca6802dc4b35d48aa1e" + integrity sha512-KEGjPDVoU5K6swgo9hJVA/qYGlwfbFx+Kg2QB/kd7rzV5N8N5Mg6PlsoCMohVnQmo+pzJap/F610qTodKzecGQ== + dependencies: + "@exodus/schemasafe" "^1.0.0-rc.2" + should "^13.2.1" + yaml "^1.10.0" + +oas-resolver@^2.5.6: + version "2.5.6" + resolved "https://registry.yarnpkg.com/oas-resolver/-/oas-resolver-2.5.6.tgz#10430569cb7daca56115c915e611ebc5515c561b" + integrity sha512-Yx5PWQNZomfEhPPOphFbZKi9W93CocQj18NlD2Pa4GWZzdZpSJvYwoiuurRI7m3SpcChrnO08hkuQDL3FGsVFQ== + dependencies: + node-fetch-h2 "^2.3.0" + oas-kit-common "^1.0.8" + reftools "^1.1.9" + yaml "^1.10.0" + yargs "^17.0.1" + +oas-schema-walker@^1.1.5: + version "1.1.5" + resolved "https://registry.yarnpkg.com/oas-schema-walker/-/oas-schema-walker-1.1.5.tgz#74c3cd47b70ff8e0b19adada14455b5d3ac38a22" + integrity sha512-2yucenq1a9YPmeNExoUa9Qwrt9RFkjqaMAA1X+U7sbb0AqBeTIdMHky9SQQ6iN94bO5NW0W4TRYXerG+BdAvAQ== + +oas-validator@^5.0.8: + version "5.0.8" + resolved "https://registry.yarnpkg.com/oas-validator/-/oas-validator-5.0.8.tgz#387e90df7cafa2d3ffc83b5fb976052b87e73c28" + integrity sha512-cu20/HE5N5HKqVygs3dt94eYJfBi0TsZvPVXDhbXQHiEityDN+RROTleefoKRKKJ9dFAF2JBkDHgvWj0sjKGmw== + dependencies: + call-me-maybe "^1.0.1" + oas-kit-common "^1.0.8" + oas-linter "^3.2.2" + oas-resolver "^2.5.6" + oas-schema-walker "^1.1.5" + reftools "^1.1.9" + should "^13.2.1" + yaml "^1.10.0" + object-assign@^4.0.1, object-assign@^4.1.1: version "4.1.1" resolved "https://registry.yarnpkg.com/object-assign/-/object-assign-4.1.1.tgz#2109adc7965887cfc05cbbd442cac8bfbb360863" @@ -11251,6 +11572,15 @@ open@^8.4.0: is-docker "^2.1.1" is-wsl "^2.2.0" +openapi-sampler@^1.5.0: + version "1.7.3" + resolved "https://registry.yarnpkg.com/openapi-sampler/-/openapi-sampler-1.7.3.tgz#55c630d22e3ebe4cb4f9fc61b22951caeb3846bf" + integrity sha512-Qgy2+Z7xR3l7kXurtzi1PCtzAINkFKhBADBe/8cidC2fQrLUQTudLiJjQDnqJXoisWAR6zaHhC0hP6Hn5vja+g== + dependencies: + "@types/json-schema" "^7.0.7" + fast-xml-parser "^5.5.1" + json-pointer "0.6.2" + opener@^1.5.2: version "1.5.2" resolved "https://registry.yarnpkg.com/opener/-/opener-1.5.2.tgz#5d37e1f35077b9dcac4301372271afdeb2a13598" @@ -11462,6 +11792,11 @@ pascal-case@^3.1.2: no-case "^3.0.4" tslib "^2.0.3" +path-browserify@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/path-browserify/-/path-browserify-1.0.1.tgz#d98454a9c3753d5790860f16f68867b9e46be1fd" + integrity sha512-b7uo2UCUOYZcnF/3ID0lulOJi/bafxa1xPe7ZPsammBSpjSWQkjNxlt635YGS2MiR9GjvuXCtz2emr3jbsz98g== + path-data-parser@0.1.0, path-data-parser@^0.1.0: version "0.1.0" resolved "https://registry.yarnpkg.com/path-data-parser/-/path-data-parser-0.1.0.tgz#8f5ba5cc70fc7becb3dcefaea08e2659aba60b8c" @@ -11477,6 +11812,11 @@ path-exists@^5.0.0: resolved "https://registry.yarnpkg.com/path-exists/-/path-exists-5.0.0.tgz#a6aad9489200b21fab31e49cf09277e5116fb9e7" integrity sha512-RjhtfwJOxzcFmNOi6ltcbcu4Iu+FL3zEj83dk4kAS+fVpTxXLO1b38RvJgT/0QwvV/L3aY9TAnyv0EOqW4GoMQ== +path-expression-matcher@^1.5.0: + version "1.5.0" + resolved "https://registry.yarnpkg.com/path-expression-matcher/-/path-expression-matcher-1.5.0.tgz#3b98545dc88ffebb593e2d8458d0929da9275f4a" + integrity sha512-cbrerZV+6rvdQrrD+iGMcZFEiiSrbv9Tfdkvnusy6y0x0GKBXREFg/Y65GhIfm0tnLntThhzCnfKwp1WRjeCyQ== + path-is-absolute@^1.0.0: version "1.0.1" resolved "https://registry.yarnpkg.com/path-is-absolute/-/path-is-absolute-1.0.1.tgz#174b9268735534ffbc7ace6bf53a5a9e1b5c5f5f" @@ -11547,6 +11887,11 @@ pend@~1.2.0: resolved "https://registry.yarnpkg.com/pend/-/pend-1.2.0.tgz#7a57eb550a6783f9115331fcf4663d5c8e007a50" integrity sha512-F3asv42UuXchdzt+xXqfW1OGlVBe+mxa2mqI0pg5yAHZPvFmY3Y6drSf/GQ1A86WgWEN9Kzh/WrgKa6iGcHXLg== +perfect-scrollbar@^1.5.5: + version "1.5.6" + resolved "https://registry.yarnpkg.com/perfect-scrollbar/-/perfect-scrollbar-1.5.6.tgz#f1aead2588ba896435ee41b246812b2080573b7c" + integrity sha512-rixgxw3SxyJbCaSpo1n35A/fwI1r2rdwMKOTCg/AcG+xOEyZcE8UHVjpZMFCVImzsFoCZeJTT+M/rdEIQYO2nw== + picocolors@^1.0.0, picocolors@^1.1.1: version "1.1.1" resolved "https://registry.yarnpkg.com/picocolors/-/picocolors-1.1.1.tgz#3d321af3eab939b083c8f929a1d12cda81c26b6b" @@ -11591,6 +11936,11 @@ pkijs@^3.3.3: pvutils "^1.1.3" tslib "^2.8.1" +pluralize@8.0.0, pluralize@^8.0.0: + version "8.0.0" + resolved "https://registry.yarnpkg.com/pluralize/-/pluralize-8.0.0.tgz#1a6fa16a38d12a1901e0320fa017051c539ce3b1" + integrity sha512-Nc3IT5yHzflTfbjgqWcCPpo7DaKy4FnpB0l/zCAW0Tc7jxAiuqSxHasntB3D7887LSrA93kDJ9IXovxJYxyLCA== + points-on-curve@0.2.0, points-on-curve@^0.2.0: version "0.2.0" resolved "https://registry.yarnpkg.com/points-on-curve/-/points-on-curve-0.2.0.tgz#7dbb98c43791859434284761330fa893cb81b4d1" @@ -11604,6 +11954,13 @@ points-on-path@^0.2.1: path-data-parser "0.1.0" points-on-curve "0.2.0" +polished@^4.2.2: + version "4.3.1" + resolved "https://registry.yarnpkg.com/polished/-/polished-4.3.1.tgz#5a00ae32715609f83d89f6f31d0f0261c6170548" + integrity sha512-OBatVyC/N7SCW/FaDHrSd+vn0o5cS855TOmYi4OkdWUMSJCET/xip//ch8xGUvtr3i44X9LVyWwQlRMTN3pwSA== + dependencies: + "@babel/runtime" "^7.17.8" + possible-typed-array-names@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/possible-typed-array-names/-/possible-typed-array-names-1.0.0.tgz#89bb63c6fada2c3e90adc4a647beeeb39cc7bf8f" @@ -11998,6 +12355,11 @@ postcss-place@^10.0.0: dependencies: postcss-value-parser "^4.2.0" +postcss-prefix-selector@^1.16.1: + version "1.16.1" + resolved "https://registry.yarnpkg.com/postcss-prefix-selector/-/postcss-prefix-selector-1.16.1.tgz#87a77523838b79c0e8aec29f173234b2987cdc04" + integrity sha512-Umxu+FvKMwlY6TyDzGFoSUnzW+NOfMBLyC1tAkIjgX+Z/qGspJeRjVC903D7mx7TuBpJlwti2ibXtWuA7fKMeQ== + postcss-preset-env@^10.2.1: version "10.4.0" resolved "https://registry.yarnpkg.com/postcss-preset-env/-/postcss-preset-env-10.4.0.tgz#fa6167a307f337b2bcdd1d125604ff97cdeb5142" @@ -12150,7 +12512,7 @@ postcss-unique-selectors@6.0.4, postcss-unique-selectors@^6.0.4: dependencies: postcss-selector-parser "^6.0.16" -postcss-value-parser@^4.1.0, postcss-value-parser@^4.2.0: +postcss-value-parser@^4.0.2, postcss-value-parser@^4.1.0, postcss-value-parser@^4.2.0: version "4.2.0" resolved "https://registry.yarnpkg.com/postcss-value-parser/-/postcss-value-parser-4.2.0.tgz#723c09920836ba6d3e5af019f92bc0971c02e514" integrity sha512-1NNCs6uurfkVbeXG4S8JFT9t19m45ICnif8zWLd5oPSZ50QnwMfK+H3jv408d4jw/7Bttv5axS5IiHoLaVNHeQ== @@ -12169,6 +12531,15 @@ postcss@^8.4.21, postcss@^8.4.24, postcss@^8.4.33, postcss@^8.5.10, postcss@^8.5 picocolors "^1.1.1" source-map-js "^1.2.1" +postcss@^8.4.45: + version "8.5.15" + resolved "https://registry.yarnpkg.com/postcss/-/postcss-8.5.15.tgz#d1eaf677a324e9ec02196da2d3fecf4a0b9a735c" + integrity sha512-FfR8sjd4em2T6fb3I2MwAJU7HWVMr9zba+enmQeeWFfCbm+UOC/0X4DS8XtpUTMwWMGbjKYP7xjfNekzyGmB3A== + dependencies: + nanoid "^3.3.12" + picocolors "^1.1.1" + source-map-js "^1.2.1" + prelude-ls@^1.2.1: version "1.2.1" resolved "https://registry.yarnpkg.com/prelude-ls/-/prelude-ls-1.2.1.tgz#debc6489d7a6e6b0e7611888cec880337d316396" @@ -12231,7 +12602,7 @@ prompts@^2.4.2: kleur "^3.0.3" sisteransi "^1.0.5" -prop-types@^15.6.2, prop-types@^15.7.2, prop-types@^15.8.1: +prop-types@^15.5.0, prop-types@^15.6.2, prop-types@^15.7.2, prop-types@^15.8.1: version "15.8.1" resolved "https://registry.yarnpkg.com/prop-types/-/prop-types-15.8.1.tgz#67d87bf1a694f48435cf332c24af10214a3140b5" integrity sha512-oj87CgZICdulUohogVAR7AjlC0327U4el4L6eAvOqCeudMDVU0NThNaV+b9Df4dXgSP1gXMTnPdhfe/2qDH5cg== @@ -12502,6 +12873,14 @@ react-router@5.3.4, react-router@^5.3.4: tiny-invariant "^1.0.2" tiny-warning "^1.0.0" +react-tabs@^6.0.2: + version "6.1.1" + resolved "https://registry.yarnpkg.com/react-tabs/-/react-tabs-6.1.1.tgz#c56ff0f4e3efb09caa98e0ff456aee6cf87bf2b0" + integrity sha512-CPiuKoMFf89B7QlbFfdBD9XmUWiE3qudQputMVZB8GQvPJZRX/gqjDaDWOPDwGinEfpJKEuBCkGt83Tt4efeyA== + dependencies: + clsx "^2.0.0" + prop-types "^15.5.0" + react-transition-group@^4.4.5: version "4.4.5" resolved "https://registry.yarnpkg.com/react-transition-group/-/react-transition-group-4.4.5.tgz#e53d4e3f3344da8521489fbef8f2581d42becdd1" @@ -12600,6 +12979,41 @@ recma-stringify@^1.0.0: unified "^11.0.0" vfile "^6.0.0" +redoc@2.4.0: + version "2.4.0" + resolved "https://registry.yarnpkg.com/redoc/-/redoc-2.4.0.tgz#4a978c91bfec426038001b8b6c26d1ebb7c60bb4" + integrity sha512-rFlfzFVWS9XJ6aYAs/bHnLhHP5FQEhwAHDBVgwb9L2FqDQ8Hu8rQ1G84iwaWXxZfPP9UWn7JdWkxI6MXr2ZDjw== + dependencies: + "@redocly/openapi-core" "^1.4.0" + classnames "^2.3.2" + decko "^1.2.0" + dompurify "^3.0.6" + eventemitter3 "^5.0.1" + json-pointer "^0.6.2" + lunr "^2.3.9" + mark.js "^8.11.1" + marked "^4.3.0" + mobx-react "^9.1.1" + openapi-sampler "^1.5.0" + path-browserify "^1.0.1" + perfect-scrollbar "^1.5.5" + polished "^4.2.2" + prismjs "^1.29.0" + prop-types "^15.8.1" + react-tabs "^6.0.2" + slugify "~1.4.7" + stickyfill "^1.1.1" + swagger2openapi "^7.0.8" + url-template "^2.0.8" + +redocusaurus@^2.5.0: + version "2.5.0" + resolved "https://registry.yarnpkg.com/redocusaurus/-/redocusaurus-2.5.0.tgz#295b3c9a306a441668e78a0c55120ed05457c950" + integrity sha512-QWJX2hgnEfSDb7fZzS4iZe6aqdAvm/XLCsNv6RkgDw6Pl/lsTZKipP2n1r5QS1CC5hY8eAwsjVXeF7B03vkz2g== + dependencies: + docusaurus-plugin-redoc "2.5.0" + docusaurus-theme-redoc "2.5.0" + reflect-metadata@^0.2.2: version "0.2.2" resolved "https://registry.yarnpkg.com/reflect-metadata/-/reflect-metadata-0.2.2.tgz#400c845b6cba87a21f2c65c4aeb158f4fa4d9c5b" @@ -12618,6 +13032,11 @@ reflect.getprototypeof@^1.0.4: globalthis "^1.0.3" which-builtin-type "^1.1.3" +reftools@^1.1.9: + version "1.1.9" + resolved "https://registry.yarnpkg.com/reftools/-/reftools-1.1.9.tgz#e16e19f662ccd4648605312c06d34e5da3a2b77e" + integrity sha512-OVede/NQE13xBQ+ob5CKd5KyeJYU2YInb1bmV4nRoOfquZPkAkxuOXicSe1PvqIuZZ4kD13sPKBbR7UFDmli6w== + regenerate-unicode-properties@^10.2.2: version "10.2.2" resolved "https://registry.yarnpkg.com/regenerate-unicode-properties/-/regenerate-unicode-properties-10.2.2.tgz#aa113812ba899b630658c7623466be71e1f86f66" @@ -13317,6 +13736,50 @@ shelljs@^0.9.0: interpret "^1.0.0" rechoir "^0.6.2" +should-equal@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/should-equal/-/should-equal-2.0.0.tgz#6072cf83047360867e68e98b09d71143d04ee0c3" + integrity sha512-ZP36TMrK9euEuWQYBig9W55WPC7uo37qzAEmbjHz4gfyuXrEUgF8cUvQVO+w+d3OMfPvSRQJ22lSm8MQJ43LTA== + dependencies: + should-type "^1.4.0" + +should-format@^3.0.3: + version "3.0.3" + resolved "https://registry.yarnpkg.com/should-format/-/should-format-3.0.3.tgz#9bfc8f74fa39205c53d38c34d717303e277124f1" + integrity sha512-hZ58adtulAk0gKtua7QxevgUaXTTXxIi8t41L3zo9AHvjXO1/7sdLECuHeIN2SRtYXpNkmhoUP2pdeWgricQ+Q== + dependencies: + should-type "^1.3.0" + should-type-adaptors "^1.0.1" + +should-type-adaptors@^1.0.1: + version "1.1.0" + resolved "https://registry.yarnpkg.com/should-type-adaptors/-/should-type-adaptors-1.1.0.tgz#401e7f33b5533033944d5cd8bf2b65027792e27a" + integrity sha512-JA4hdoLnN+kebEp2Vs8eBe9g7uy0zbRo+RMcU0EsNy+R+k049Ki+N5tT5Jagst2g7EAja+euFuoXFCa8vIklfA== + dependencies: + should-type "^1.3.0" + should-util "^1.0.0" + +should-type@^1.3.0, should-type@^1.4.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/should-type/-/should-type-1.4.0.tgz#0756d8ce846dfd09843a6947719dfa0d4cff5cf3" + integrity sha512-MdAsTu3n25yDbIe1NeN69G4n6mUnJGtSJHygX3+oN0ZbO3DTiATnf7XnYJdGT42JCXurTb1JI0qOBR65shvhPQ== + +should-util@^1.0.0: + version "1.0.1" + resolved "https://registry.yarnpkg.com/should-util/-/should-util-1.0.1.tgz#fb0d71338f532a3a149213639e2d32cbea8bcb28" + integrity sha512-oXF8tfxx5cDk8r2kYqlkUJzZpDBqVY/II2WhvU0n9Y3XYvAYRmeaf1PvvIvTgPnv4KJ+ES5M0PyDq5Jp+Ygy2g== + +should@^13.2.1: + version "13.2.3" + resolved "https://registry.yarnpkg.com/should/-/should-13.2.3.tgz#96d8e5acf3e97b49d89b51feaa5ae8d07ef58f10" + integrity sha512-ggLesLtu2xp+ZxI+ysJTmNjh2U0TsC+rQ/pfED9bUZZ4DKefP27D+7YJVVTvKsmjLpIi9jAa7itwDGkDDmt1GQ== + dependencies: + should-equal "^2.0.0" + should-format "^3.0.3" + should-type "^1.4.0" + should-type-adaptors "^1.0.1" + should-util "^1.0.0" + side-channel-list@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/side-channel-list/-/side-channel-list-1.0.0.tgz#10cb5984263115d3b7a0e336591e290a830af8ad" @@ -13434,6 +13897,11 @@ slice-ansi@^7.0.0: ansi-styles "^6.2.1" is-fullwidth-code-point "^5.0.0" +slugify@~1.4.7: + version "1.4.7" + resolved "https://registry.yarnpkg.com/slugify/-/slugify-1.4.7.tgz#e42359d505afd84a44513280868e31202a79a628" + integrity sha512-tf+h5W1IrjNm/9rKKj0JU2MDMruiopx0jjVA5zCdBtcGjfp0+c5rHw/zADLC3IeKlGHtVbHtpfzvYA0OYT+HKg== + smart-buffer@^4.2.0: version "4.2.0" resolved "https://registry.yarnpkg.com/smart-buffer/-/smart-buffer-4.2.0.tgz#6e1d71fa4f18c05f7d0ff216dd16a481d0e8d9ae" @@ -13601,6 +14069,11 @@ std-env@^3.7.0: resolved "https://registry.yarnpkg.com/std-env/-/std-env-3.9.0.tgz#1a6f7243b339dca4c9fd55e1c7504c77ef23e8f1" integrity sha512-UGvjygr6F6tpH7o2qyqR6QYpwraIjKSdtzyBdyytFOHmPZY917kwdwLG0RbOjWOnKmnm3PeHjaoLLMie7kPLQw== +stickyfill@^1.1.1: + version "1.1.1" + resolved "https://registry.yarnpkg.com/stickyfill/-/stickyfill-1.1.1.tgz#39413fee9d025c74a7e59ceecb23784cc0f17f02" + integrity sha512-GCp7vHAfpao+Qh/3Flh9DXEJ/qSi0KJwJw6zYlZOtRYXWUIpMM6mC2rIep/dK8RQqwW0KxGJIllmjPIBOGN8AA== + streamx@^2.15.0, streamx@^2.21.0: version "2.22.0" resolved "https://registry.yarnpkg.com/streamx/-/streamx-2.22.0.tgz#cd7b5e57c95aaef0ff9b2aef7905afa62ec6e4a7" @@ -13799,6 +14272,11 @@ strip-outer@^2.0.0: resolved "https://registry.yarnpkg.com/strip-outer/-/strip-outer-2.0.0.tgz#c45c724ed9b1ff6be5f660503791404f4714084b" integrity sha512-A21Xsm1XzUkK0qK1ZrytDUvqsQWict2Cykhvi0fBQntGG5JSprESasEyV1EZ/4CiR5WB5KjzLTrP/bO37B0wPg== +strnum@^2.3.0: + version "2.3.0" + resolved "https://registry.yarnpkg.com/strnum/-/strnum-2.3.0.tgz#81bfbfef53db8c3217ea62a98c026886ec4a2761" + integrity sha512-ums3KNd42PGyx5xaoVTO1mjU1bH3NpY4vsrVlnv9PNGqQj8wd7rJ6nEypLrJ7z5vxK5RP0yMLo6J/Gsm62DI5Q== + strtok3@^7.0.0-alpha.9: version "7.1.1" resolved "https://registry.yarnpkg.com/strtok3/-/strtok3-7.1.1.tgz#f548fd9dc59d0a76d5567ff8c16be31221f29dfc" @@ -13828,6 +14306,16 @@ style-to-object@^0.4.1: dependencies: inline-style-parser "0.1.1" +styled-components@^6.1.11: + version "6.4.2" + resolved "https://registry.yarnpkg.com/styled-components/-/styled-components-6.4.2.tgz#2e92f7b8a1e49f5791c80c864eddf215dd1046c6" + integrity sha512-xZBhBJsMtGqb+aKcwKgaT+BtuFums9VynX2JRvXJGTx5UfZzN12rk5r4nVdhXYvRw+hE7yiYxVrOqJZaK2+Txg== + dependencies: + "@emotion/is-prop-valid" "1.4.0" + css-to-react-native "3.2.0" + csstype "3.2.3" + stylis "4.3.6" + stylehacks@6.1.1, stylehacks@^6.1.1: version "6.1.1" resolved "https://registry.yarnpkg.com/stylehacks/-/stylehacks-6.1.1.tgz#543f91c10d17d00a440430362d419f79c25545a6" @@ -13841,7 +14329,7 @@ stylis@4.2.0: resolved "https://registry.yarnpkg.com/stylis/-/stylis-4.2.0.tgz#79daee0208964c8fe695a42fcffcac633a211a51" integrity sha512-Orov6g6BB1sDfYgzWfTHDOxamtX1bE/zo104Dh9e6fqJ3PooipYyfJ0pUmrZO2wAvO8YbEyeFrkV91XTsGMSrw== -stylis@^4.3.6: +stylis@4.3.6, stylis@^4.3.6: version "4.3.6" resolved "https://registry.yarnpkg.com/stylis/-/stylis-4.3.6.tgz#7c7b97191cb4f195f03ecab7d52f7902ed378320" integrity sha512-yQ3rwFWRfwNUY7H5vpU0wfdkNSnvnJinhF9830Swlaxl03zsOjCfmX0ugac+3LtK0lYSgwL/KXc8oYL3mG4YFQ== @@ -13903,6 +14391,23 @@ svgo@3.3.3, svgo@^3.0.2, svgo@^3.2.0: picocolors "^1.0.0" sax "^1.5.0" +swagger2openapi@^7.0.8: + version "7.0.8" + resolved "https://registry.yarnpkg.com/swagger2openapi/-/swagger2openapi-7.0.8.tgz#12c88d5de776cb1cbba758994930f40ad0afac59" + integrity sha512-upi/0ZGkYgEcLeGieoz8gT74oWHA0E7JivX7aN9mAf+Tc7BQoRBvnIGHoPDw+f9TXTW4s6kGYCZJtauP6OYp7g== + dependencies: + call-me-maybe "^1.0.1" + node-fetch "^2.6.1" + node-fetch-h2 "^2.3.0" + node-readfiles "^0.2.0" + oas-kit-common "^1.0.8" + oas-resolver "^2.5.6" + oas-schema-walker "^1.1.5" + oas-validator "^5.0.8" + reftools "^1.1.9" + yaml "^1.10.0" + yargs "^17.0.1" + swc-loader@^0.2.3, swc-loader@^0.2.6: version "0.2.6" resolved "https://registry.yarnpkg.com/swc-loader/-/swc-loader-0.2.6.tgz#bf0cba8eeff34bb19620ead81d1277fefaec6bc8" @@ -14481,6 +14986,11 @@ update-notifier@^6.0.2: semver-diff "^4.0.0" xdg-basedir "^5.1.0" +uri-js-replace@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/uri-js-replace/-/uri-js-replace-1.0.1.tgz#c285bb352b701c9dfdaeffc4da5be77f936c9048" + integrity sha512-W+C9NWNLFOoBI2QWDp4UT9pv65r2w5Cx+3sTYFvtMdDBxkKt1syCqsUdSFAChbEe1uK5TfS04wt/nGwmaeIQ0g== + uri-js@^4.2.2: version "4.4.1" resolved "https://registry.yarnpkg.com/uri-js/-/uri-js-4.4.1.tgz#9b1a52595225859e55f669d928f88c6c57f2a77e" @@ -14497,6 +15007,11 @@ url-loader@^4.1.1: mime-types "^2.1.27" schema-utils "^3.0.0" +url-template@^2.0.8: + version "2.0.8" + resolved "https://registry.yarnpkg.com/url-template/-/url-template-2.0.8.tgz#fc565a3cccbff7730c775f5641f9555791439f21" + integrity sha512-XdVKMF4SJ0nP/O7XIPB0JwAEuT9lDIYnNsK8yGVe43y0AWoKeJNdv3ZNWh7ksJ6KqQFjOO6ox/VEitLnaVNufw== + urlpattern-polyfill@10.0.0: version "10.0.0" resolved "https://registry.yarnpkg.com/urlpattern-polyfill/-/urlpattern-polyfill-10.0.0.tgz#f0a03a97bfb03cdf33553e5e79a2aadd22cac8ec" @@ -14971,6 +15486,11 @@ xml-js@^1.6.11: dependencies: sax "^1.2.4" +xml-naming@^0.1.0: + version "0.1.0" + resolved "https://registry.yarnpkg.com/xml-naming/-/xml-naming-0.1.0.tgz#8ab7106c5b8d23caa2fabac1cadf17136379fbd8" + integrity sha512-k8KO9hrMyNk6tUWqUfkTEZbezRRpONVOzUTnc97VnCvyj6Tf9lyUR9EDAIeiVLv56jsMcoXEwjW8Kv5yPY52lw== + y18n@^5.0.5: version "5.0.8" resolved "https://registry.yarnpkg.com/y18n/-/y18n-5.0.8.tgz#7f4934d0f7ca8c56f95314939ddcd2dd91ce1d55" @@ -14986,6 +15506,11 @@ yallist@^3.0.2: resolved "https://registry.yarnpkg.com/yallist/-/yallist-3.1.1.tgz#dbb7daf9bfd8bac9ab45ebf602b8cbad0d5d08fd" integrity sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g== +yaml-ast-parser@0.0.43: + version "0.0.43" + resolved "https://registry.yarnpkg.com/yaml-ast-parser/-/yaml-ast-parser-0.0.43.tgz#e8a23e6fb4c38076ab92995c5dca33f3d3d7c9bb" + integrity sha512-2PTINUwsRqSd+s8XxKaJWQlUuEMHJQyEuh2edBbW8KNJz0SJPwUSD2zRWqezFEdN7IzAgeuYHFUCF7o8zRdZ0A== + yaml@^1.10.0: version "1.10.2" resolved "https://registry.yarnpkg.com/yaml/-/yaml-1.10.2.tgz#2301c5ffbf12b467de8da2333a459e29e7920e4b" @@ -15006,7 +15531,7 @@ yargs-parser@^21.1.1: resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-21.1.1.tgz#9096bceebf990d21bb31fa9516e0ede294a77d35" integrity sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw== -yargs@>=10.0.3, yargs@^17.7.2: +yargs@>=10.0.3, yargs@^17.0.1, yargs@^17.7.2: version "17.7.2" resolved "https://registry.yarnpkg.com/yargs/-/yargs-17.7.2.tgz#991df39aca675a192b816e1e0363f9d75d2aa269" integrity sha512-7dSzzRQ++CKnNI/krKnYRV7JKKPUXMEh61soaHKg9mrWEhzFWhFnxPxGl+69cD1Ou63C13NUPCnmIcrvqCuM6w==