diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-06-20 13:43:29 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-06-20 13:43:29 +0300 |
commit | 3b1af5cc7ed2666ff18b718ce5d30fa5a2756674 (patch) | |
tree | 3bc4a40e0ee51ec27eabf917c537033c0c5b14d4 /vendor/gems/error_tracking_open_api/docs | |
parent | 9bba14be3f2c211bf79e15769cd9b77bc73a13bc (diff) |
Add latest changes from gitlab-org/gitlab@16-1-stable-eev16.1.0-rc42
Diffstat (limited to 'vendor/gems/error_tracking_open_api/docs')
10 files changed, 476 insertions, 2 deletions
diff --git a/vendor/gems/error_tracking_open_api/docs/Error.md b/vendor/gems/error_tracking_open_api/docs/Error.md index 45aa4cf6b8a..55a013ebfb7 100644 --- a/vendor/gems/error_tracking_open_api/docs/Error.md +++ b/vendor/gems/error_tracking_open_api/docs/Error.md @@ -14,6 +14,7 @@ | **last_seen_at** | **Time** | | [optional] | | **first_seen_at** | **Time** | | [optional] | | **status** | **String** | Status of the error | [optional] | +| **stats** | [**ErrorStats**](ErrorStats.md) | | [optional] | ## Example @@ -30,7 +31,8 @@ instance = ErrorTrackingOpenAPI::Error.new( approximated_user_count: null, last_seen_at: null, first_seen_at: null, - status: null + status: null, + stats: null ) ``` diff --git a/vendor/gems/error_tracking_open_api/docs/ErrorStats.md b/vendor/gems/error_tracking_open_api/docs/ErrorStats.md new file mode 100644 index 00000000000..3b8ab24b54b --- /dev/null +++ b/vendor/gems/error_tracking_open_api/docs/ErrorStats.md @@ -0,0 +1,18 @@ +# ErrorTrackingOpenAPI::ErrorStats + +## Properties + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **frequency** | **Object** | | [optional] | + +## Example + +```ruby +require 'error_tracking_open_api' + +instance = ErrorTrackingOpenAPI::ErrorStats.new( + frequency: null +) +``` + diff --git a/vendor/gems/error_tracking_open_api/docs/ErrorV2.md b/vendor/gems/error_tracking_open_api/docs/ErrorV2.md new file mode 100644 index 00000000000..77aa58e601c --- /dev/null +++ b/vendor/gems/error_tracking_open_api/docs/ErrorV2.md @@ -0,0 +1,34 @@ +# ErrorTrackingOpenAPI::ErrorV2 + +## Properties + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **id** | **String** | | [optional] | +| **project** | [**Project**](Project.md) | | [optional] | +| **title** | **String** | | [optional] | +| **actor** | **String** | | [optional] | +| **count** | **String** | | [optional] | +| **user_count** | **Integer** | | [optional] | +| **last_seen** | **Time** | | [optional] | +| **first_seen** | **Time** | | [optional] | +| **status** | **String** | Status of the error | [optional] | + +## Example + +```ruby +require 'error_tracking_open_api' + +instance = ErrorTrackingOpenAPI::ErrorV2.new( + id: null, + project: null, + title: ActionView::MissingTemplate, + actor: PostsController#edit, + count: null, + user_count: null, + last_seen: null, + first_seen: null, + status: null +) +``` + diff --git a/vendor/gems/error_tracking_open_api/docs/ErrorsApi.md b/vendor/gems/error_tracking_open_api/docs/ErrorsApi.md index b9b7d2f6421..fc7f35e8d03 100644 --- a/vendor/gems/error_tracking_open_api/docs/ErrorsApi.md +++ b/vendor/gems/error_tracking_open_api/docs/ErrorsApi.md @@ -107,7 +107,9 @@ opts = { status: 'unresolved', # String | query: 'query_example', # String | cursor: 'cursor_example', # String | Base64 encoded information for pagination - limit: 56 # Integer | Number of entries to return + limit: 56, # Integer | Number of entries to return + stats_period: '15m', # String | + query_period: '15m' # String | } begin @@ -147,6 +149,8 @@ end | **query** | **String** | | [optional] | | **cursor** | **String** | Base64 encoded information for pagination | [optional] | | **limit** | **Integer** | Number of entries to return | [optional][default to 20] | +| **stats_period** | **String** | | [optional][default to '24h'] | +| **query_period** | **String** | | [optional][default to '30d'] | ### Return type diff --git a/vendor/gems/error_tracking_open_api/docs/ErrorsV2Api.md b/vendor/gems/error_tracking_open_api/docs/ErrorsV2Api.md new file mode 100644 index 00000000000..23f3e43bdf8 --- /dev/null +++ b/vendor/gems/error_tracking_open_api/docs/ErrorsV2Api.md @@ -0,0 +1,235 @@ +# ErrorTrackingOpenAPI::ErrorsV2Api + +All URIs are relative to *https://localhost/errortracking/api/v1* + +| Method | HTTP request | Description | +| ------ | ------------ | ----------- | +| [**get_stats_v2**](ErrorsV2Api.md#get_stats_v2) | **GET** /api/0/organizations/{groupId}/stats_v2 | Stats of events received for the group | +| [**list_errors_v2**](ErrorsV2Api.md#list_errors_v2) | **GET** /api/0/organizations/{groupId}/issues/ | List of errors(V2) | +| [**list_projects**](ErrorsV2Api.md#list_projects) | **GET** /api/0/organizations/{groupId}/projects/ | List of projects | + + +## get_stats_v2 + +> <Array<StatsObject>> get_stats_v2(group_id) + +Stats of events received for the group + +### Examples + +```ruby +require 'time' +require 'error_tracking_open_api' +# setup authorization +ErrorTrackingOpenAPI.configure do |config| + # Configure API key authorization: internalToken + config.api_key['internalToken'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + # config.api_key_prefix['internalToken'] = 'Bearer' +end + +api_instance = ErrorTrackingOpenAPI::ErrorsV2Api.new +group_id = 56 # Integer | ID of the group + +begin + # Stats of events received for the group + result = api_instance.get_stats_v2(group_id) + p result +rescue ErrorTrackingOpenAPI::ApiError => e + puts "Error when calling ErrorsV2Api->get_stats_v2: #{e}" +end +``` + +#### Using the get_stats_v2_with_http_info variant + +This returns an Array which contains the response data, status code and headers. + +> <Array(<Array<StatsObject>>, Integer, Hash)> get_stats_v2_with_http_info(group_id) + +```ruby +begin + # Stats of events received for the group + data, status_code, headers = api_instance.get_stats_v2_with_http_info(group_id) + p status_code # => 2xx + p headers # => { ... } + p data # => <Array<StatsObject>> +rescue ErrorTrackingOpenAPI::ApiError => e + puts "Error when calling ErrorsV2Api->get_stats_v2_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **group_id** | **Integer** | ID of the group | | + +### Return type + +[**Array<StatsObject>**](StatsObject.md) + +### Authorization + +[internalToken](../README.md#internalToken) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: */* + + +## list_errors_v2 + +> <Array<ErrorV2>> list_errors_v2(project, group_id, opts) + +List of errors(V2) + +### Examples + +```ruby +require 'time' +require 'error_tracking_open_api' +# setup authorization +ErrorTrackingOpenAPI.configure do |config| + # Configure API key authorization: internalToken + config.api_key['internalToken'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + # config.api_key_prefix['internalToken'] = 'Bearer' +end + +api_instance = ErrorTrackingOpenAPI::ErrorsV2Api.new +project = [37] # Array<Integer> | ID of the project where the error was created +group_id = 56 # Integer | ID of the group +opts = { + status: 'unresolved', # String | + query: 'query_example', # String | + start: 'start_example', # String | Optional start of the stat period in format 2006-01-02T15:04:05 + _end: '_end_example', # String | Optional end of the stat period in format 2006-01-02T15:04:05 + environment: 'environment_example', # String | + limit: 56, # Integer | Number of entries to return + sort: 'date' # String | Optional sorting column of the entries +} + +begin + # List of errors(V2) + result = api_instance.list_errors_v2(project, group_id, opts) + p result +rescue ErrorTrackingOpenAPI::ApiError => e + puts "Error when calling ErrorsV2Api->list_errors_v2: #{e}" +end +``` + +#### Using the list_errors_v2_with_http_info variant + +This returns an Array which contains the response data, status code and headers. + +> <Array(<Array<ErrorV2>>, Integer, Hash)> list_errors_v2_with_http_info(project, group_id, opts) + +```ruby +begin + # List of errors(V2) + data, status_code, headers = api_instance.list_errors_v2_with_http_info(project, group_id, opts) + p status_code # => 2xx + p headers # => { ... } + p data # => <Array<ErrorV2>> +rescue ErrorTrackingOpenAPI::ApiError => e + puts "Error when calling ErrorsV2Api->list_errors_v2_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **project** | [**Array<Integer>**](Integer.md) | ID of the project where the error was created | | +| **group_id** | **Integer** | ID of the group | | +| **status** | **String** | | [optional][default to 'unresolved'] | +| **query** | **String** | | [optional] | +| **start** | **String** | Optional start of the stat period in format 2006-01-02T15:04:05 | [optional] | +| **_end** | **String** | Optional end of the stat period in format 2006-01-02T15:04:05 | [optional] | +| **environment** | **String** | | [optional] | +| **limit** | **Integer** | Number of entries to return | [optional][default to 20] | +| **sort** | **String** | Optional sorting column of the entries | [optional][default to 'date'] | + +### Return type + +[**Array<ErrorV2>**](ErrorV2.md) + +### Authorization + +[internalToken](../README.md#internalToken) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: */* + + +## list_projects + +> <Array<Project>> list_projects(group_id) + +List of projects + +### Examples + +```ruby +require 'time' +require 'error_tracking_open_api' +# setup authorization +ErrorTrackingOpenAPI.configure do |config| + # Configure API key authorization: internalToken + config.api_key['internalToken'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + # config.api_key_prefix['internalToken'] = 'Bearer' +end + +api_instance = ErrorTrackingOpenAPI::ErrorsV2Api.new +group_id = 56 # Integer | ID of the group + +begin + # List of projects + result = api_instance.list_projects(group_id) + p result +rescue ErrorTrackingOpenAPI::ApiError => e + puts "Error when calling ErrorsV2Api->list_projects: #{e}" +end +``` + +#### Using the list_projects_with_http_info variant + +This returns an Array which contains the response data, status code and headers. + +> <Array(<Array<Project>>, Integer, Hash)> list_projects_with_http_info(group_id) + +```ruby +begin + # List of projects + data, status_code, headers = api_instance.list_projects_with_http_info(group_id) + p status_code # => 2xx + p headers # => { ... } + p data # => <Array<Project>> +rescue ErrorTrackingOpenAPI::ApiError => e + puts "Error when calling ErrorsV2Api->list_projects_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **group_id** | **Integer** | ID of the group | | + +### Return type + +[**Array<Project>**](Project.md) + +### Authorization + +[internalToken](../README.md#internalToken) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: */* + diff --git a/vendor/gems/error_tracking_open_api/docs/MessageEvent.md b/vendor/gems/error_tracking_open_api/docs/MessageEvent.md new file mode 100644 index 00000000000..d96974b150e --- /dev/null +++ b/vendor/gems/error_tracking_open_api/docs/MessageEvent.md @@ -0,0 +1,32 @@ +# ErrorTrackingOpenAPI::MessageEvent + +## Properties + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **project_id** | **Integer** | | [optional] | +| **event_id** | **String** | | [optional] | +| **timestamp** | **Time** | | [optional] | +| **level** | **String** | | [optional] | +| **message** | **String** | | [optional] | +| **release** | **String** | | [optional] | +| **environment** | **String** | | [optional] | +| **platform** | **String** | | [optional] | + +## Example + +```ruby +require 'error_tracking_open_api' + +instance = ErrorTrackingOpenAPI::MessageEvent.new( + project_id: null, + event_id: null, + timestamp: null, + level: info, + message: some message from the SDK, + release: v1.0.0, + environment: production, + platform: ruby +) +``` + diff --git a/vendor/gems/error_tracking_open_api/docs/MessagesApi.md b/vendor/gems/error_tracking_open_api/docs/MessagesApi.md new file mode 100644 index 00000000000..abaf2f9dbe6 --- /dev/null +++ b/vendor/gems/error_tracking_open_api/docs/MessagesApi.md @@ -0,0 +1,81 @@ +# ErrorTrackingOpenAPI::MessagesApi + +All URIs are relative to *https://localhost/errortracking/api/v1* + +| Method | HTTP request | Description | +| ------ | ------------ | ----------- | +| [**list_messages**](MessagesApi.md#list_messages) | **GET** /projects/{projectId}/messages | List of messages | + + +## list_messages + +> <Array<MessageEvent>> list_messages(project_id, opts) + +List of messages + +### Examples + +```ruby +require 'time' +require 'error_tracking_open_api' +# setup authorization +ErrorTrackingOpenAPI.configure do |config| + # Configure API key authorization: internalToken + config.api_key['internalToken'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + # config.api_key_prefix['internalToken'] = 'Bearer' +end + +api_instance = ErrorTrackingOpenAPI::MessagesApi.new +project_id = 56 # Integer | ID of the project where the message was created +opts = { + limit: 56 # Integer | Number of entries to return +} + +begin + # List of messages + result = api_instance.list_messages(project_id, opts) + p result +rescue ErrorTrackingOpenAPI::ApiError => e + puts "Error when calling MessagesApi->list_messages: #{e}" +end +``` + +#### Using the list_messages_with_http_info variant + +This returns an Array which contains the response data, status code and headers. + +> <Array(<Array<MessageEvent>>, Integer, Hash)> list_messages_with_http_info(project_id, opts) + +```ruby +begin + # List of messages + data, status_code, headers = api_instance.list_messages_with_http_info(project_id, opts) + p status_code # => 2xx + p headers # => { ... } + p data # => <Array<MessageEvent>> +rescue ErrorTrackingOpenAPI::ApiError => e + puts "Error when calling MessagesApi->list_messages_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **project_id** | **Integer** | ID of the project where the message was created | | +| **limit** | **Integer** | Number of entries to return | [optional][default to 20] | + +### Return type + +[**Array<MessageEvent>**](MessageEvent.md) + +### Authorization + +[internalToken](../README.md#internalToken) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: */* + diff --git a/vendor/gems/error_tracking_open_api/docs/Project.md b/vendor/gems/error_tracking_open_api/docs/Project.md new file mode 100644 index 00000000000..fbaeb7e6986 --- /dev/null +++ b/vendor/gems/error_tracking_open_api/docs/Project.md @@ -0,0 +1,22 @@ +# ErrorTrackingOpenAPI::Project + +## Properties + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **id** | **String** | ID of the project | [optional] | +| **name** | **String** | Name of the project | [optional] | +| **slug** | **String** | Slug of the project | [optional] | + +## Example + +```ruby +require 'error_tracking_open_api' + +instance = ErrorTrackingOpenAPI::Project.new( + id: null, + name: null, + slug: null +) +``` + diff --git a/vendor/gems/error_tracking_open_api/docs/StatsObject.md b/vendor/gems/error_tracking_open_api/docs/StatsObject.md new file mode 100644 index 00000000000..ef3007aecd0 --- /dev/null +++ b/vendor/gems/error_tracking_open_api/docs/StatsObject.md @@ -0,0 +1,24 @@ +# ErrorTrackingOpenAPI::StatsObject + +## Properties + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **start** | **String** | ID of the project | [optional] | +| **_end** | **String** | Name of the project | [optional] | +| **interval** | **Array<String>** | Slug of the project | [optional] | +| **group** | [**Array<StatsObjectGroupInner>**](StatsObjectGroupInner.md) | | [optional] | + +## Example + +```ruby +require 'error_tracking_open_api' + +instance = ErrorTrackingOpenAPI::StatsObject.new( + start: null, + _end: null, + interval: null, + group: null +) +``` + diff --git a/vendor/gems/error_tracking_open_api/docs/StatsObjectGroupInner.md b/vendor/gems/error_tracking_open_api/docs/StatsObjectGroupInner.md new file mode 100644 index 00000000000..c72da9c6616 --- /dev/null +++ b/vendor/gems/error_tracking_open_api/docs/StatsObjectGroupInner.md @@ -0,0 +1,22 @@ +# ErrorTrackingOpenAPI::StatsObjectGroupInner + +## Properties + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **by** | **Hash<String, Object>** | | [optional] | +| **totals** | **Hash<String, Object>** | | [optional] | +| **series** | **Hash<String, Object>** | | [optional] | + +## Example + +```ruby +require 'error_tracking_open_api' + +instance = ErrorTrackingOpenAPI::StatsObjectGroupInner.new( + by: null, + totals: null, + series: null +) +``` + |