Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: 2025-01-27 swagger updates #45

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
7 changes: 7 additions & 0 deletions .openapi-generator/templates/README.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Ready to bring some fun to your cybersecurity game with Ruby and Crimson Falcon?
- [Getting Started](#getting-started)
- [Contribute to Crimson Falcon](#contribute-to-crimson-falcon)
- [Crimson Falcon API Docs](#crimson-falcon-api-docs)
- [Support](#support)

## Installation

Expand Down Expand Up @@ -122,3 +123,9 @@ We appreciate your interest in our project and look forward to collaborating wit

---
{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}

## Support

Crimson Falcon is a community-driven, open source project designed to bring together the robust capabilities of CrowdStrike Falcon with the friendly charm of Ruby. While not a formal CrowdStrike product, Crimson Falcon is maintained by CrowdStrike and supported in partnership with the open source developer community.

For additional support, please see the [SUPPORT.md](SUPPORT.md) file.
528 changes: 411 additions & 117 deletions README.md

Large diffs are not rendered by default.

13 changes: 13 additions & 0 deletions SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Crimson Falcon Support

Crimson Falcon is a community-driven, open source project designed to bring together the robust capabilities of CrowdStrike Falcon with the friendly charm of Ruby. While not a formal CrowdStrike product, Crimson Falcon is maintained by CrowdStrike and supported in partnership with the open source developer community.

## Issue Reporting and Questions

Issues may be reported [here](https://github.com/CrowdStrike/crimson-falcon/issues/new) and are used to track bugs, documentation and link updates, enhancement requests and security concerns.

## Support Escalation

Generally, we endeavor to provide support for using Crimson Falcon here within the repository. This expands our online knowledge base, enables self-help for our community, and can reduce the amount of time for you to receive answers.

If you are a CrowdStrike customer and you would prefer to have your questions or issues handled directly with CrowdStrike Support, you are welcome to [contact the CrowdStrike technical support team](https://supportportal.crowdstrike.com/).
190 changes: 188 additions & 2 deletions docs/ASPM.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ All URIs are relative to *https://api.us-2.crowdstrike.com*
| [**delete_tags**](ASPM.md#delete_tags) | **POST** /aspm-api-gateway/api/v1/tags | Remove existing tags |
| [**execute_query**](ASPM.md#execute_query) | **POST** /aspm-api-gateway/api/v1/query | Execute a query. The syntax used is identical to that of the query page. |
| [**get_executor_nodes**](ASPM.md#get_executor_nodes) | **GET** /aspm-api-gateway/api/v1/executor_nodes | Get all the relay nodes |
| [**get_executor_nodes_metadata**](ASPM.md#get_executor_nodes_metadata) | **GET** /aspm-api-gateway/api/v1/executor_nodes/metadata | Get metadata about all executor nodes |
| [**get_integration_tasks**](ASPM.md#get_integration_tasks) | **GET** /aspm-api-gateway/api/v1/integration_tasks | Get all the integration tasks |
| [**get_integration_tasks_metadata**](ASPM.md#get_integration_tasks_metadata) | **GET** /aspm-api-gateway/api/v1/integration_tasks/metadata | Get metadata about all integration tasks |
| [**get_integration_types**](ASPM.md#get_integration_types) | **GET** /aspm-api-gateway/api/v1/integration_types | Get all the integration types |
| [**get_integrations**](ASPM.md#get_integrations) | **GET** /aspm-api-gateway/api/v1/integrations | Get a list of all the integrations |
| [**get_service_violation_types**](ASPM.md#get_service_violation_types) | **GET** /aspm-api-gateway/api/v1/services/violations/types | Get the different types of violation |
Expand Down Expand Up @@ -599,7 +601,15 @@ end
api_instance = Falcon::ASPM.new
node_type = 'node_type_example' # String |
opts = {
integration_type: 56 # Integer |
integration_type: 56, # Integer |
offset: 56, # Integer |
limit: 56, # Integer |
order_by: 'name', # String |
direction: 'asc', # String |
executor_node_ids: ['inner_example'], # Array<String> | executor node ids
executor_node_names: ['inner_example'], # Array<String> | executor node names
executor_node_states: [37], # Array<Integer> | executor node states
executor_node_types: ['inner_example'] # Array<String> | executor node types
}

begin
Expand Down Expand Up @@ -635,6 +645,14 @@ end
| ---- | ---- | ----------- | ----- |
| **node_type** | **String** | | |
| **integration_type** | **Integer** | | [optional] |
| **offset** | **Integer** | | [optional] |
| **limit** | **Integer** | | [optional] |
| **order_by** | **String** | | [optional] |
| **direction** | **String** | | [optional] |
| **executor_node_ids** | [**Array&lt;String&gt;**](String.md) | executor node ids | [optional] |
| **executor_node_names** | [**Array&lt;String&gt;**](String.md) | executor node names | [optional] |
| **executor_node_states** | [**Array&lt;Integer&gt;**](Integer.md) | executor node states | [optional] |
| **executor_node_types** | [**Array&lt;String&gt;**](String.md) | executor node types | [optional] |

### Return type

Expand All @@ -650,6 +668,83 @@ end
- **Accept**: application/json


## get_executor_nodes_metadata

> <TypesGetExecutorNodesMetadataResponse> get_executor_nodes_metadata(opts)

Get metadata about all executor nodes

### Examples

```ruby
require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
config.client_id = "Your_Client_ID"
config.client_secret = "Your_Client_Secret"
config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::ASPM.new
opts = {
executor_node_ids: ['inner_example'], # Array<String> | executor node ids
executor_node_names: ['inner_example'], # Array<String> | executor node names
executor_node_states: [37], # Array<Integer> | executor node states
executor_node_types: ['inner_example'] # Array<String> | executor node types
}

begin
# Get metadata about all executor nodes
result = api_instance.get_executor_nodes_metadata(opts)
p result
rescue Falcon::ApiError => e
puts "Error when calling ASPM->get_executor_nodes_metadata: #{e}"
end
```

#### Using the get_executor_nodes_metadata_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<TypesGetExecutorNodesMetadataResponse>, Integer, Hash)> get_executor_nodes_metadata_with_http_info(opts)

```ruby
begin
# Get metadata about all executor nodes
data, status_code, headers = api_instance.get_executor_nodes_metadata_with_http_info(opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <TypesGetExecutorNodesMetadataResponse>
rescue Falcon::ApiError => e
puts "Error when calling ASPM->get_executor_nodes_metadata_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **executor_node_ids** | [**Array&lt;String&gt;**](String.md) | executor node ids | [optional] |
| **executor_node_names** | [**Array&lt;String&gt;**](String.md) | executor node names | [optional] |
| **executor_node_states** | [**Array&lt;Integer&gt;**](Integer.md) | executor node states | [optional] |
| **executor_node_types** | [**Array&lt;String&gt;**](String.md) | executor node types | [optional] |

### Return type

[**TypesGetExecutorNodesMetadataResponse**](TypesGetExecutorNodesMetadataResponse.md)

### Authorization

**oauth2**

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


## get_integration_tasks

> <TypesListIntegrationTasksResponse> get_integration_tasks(opts)
Expand All @@ -672,7 +767,14 @@ end
api_instance = Falcon::ASPM.new
opts = {
integration_task_type: 56, # Integer |
category: 'category_example' # String |
category: 'category_example', # String |
offset: 56, # Integer |
limit: 56, # Integer |
order_by: 'name', # String |
direction: 'asc', # String |
integration_task_types: 56, # Integer |
ids: 56, # Integer |
names: 'names_example' # String |
}

begin
Expand Down Expand Up @@ -708,6 +810,13 @@ end
| ---- | ---- | ----------- | ----- |
| **integration_task_type** | **Integer** | | [optional] |
| **category** | **String** | | [optional] |
| **offset** | **Integer** | | [optional] |
| **limit** | **Integer** | | [optional] |
| **order_by** | **String** | | [optional] |
| **direction** | **String** | | [optional] |
| **integration_task_types** | **Integer** | | [optional] |
| **ids** | **Integer** | | [optional] |
| **names** | **String** | | [optional] |

### Return type

Expand All @@ -723,6 +832,83 @@ end
- **Accept**: application/json


## get_integration_tasks_metadata

> <TypesGetIntegrationTasksMetadataResponse> get_integration_tasks_metadata(opts)

Get metadata about all integration tasks

### Examples

```ruby
require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
config.client_id = "Your_Client_ID"
config.client_secret = "Your_Client_Secret"
config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::ASPM.new
opts = {
category: 'collecting', # String |
integration_task_types: 56, # Integer |
ids: 56, # Integer |
names: 'names_example' # String |
}

begin
# Get metadata about all integration tasks
result = api_instance.get_integration_tasks_metadata(opts)
p result
rescue Falcon::ApiError => e
puts "Error when calling ASPM->get_integration_tasks_metadata: #{e}"
end
```

#### Using the get_integration_tasks_metadata_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<TypesGetIntegrationTasksMetadataResponse>, Integer, Hash)> get_integration_tasks_metadata_with_http_info(opts)

```ruby
begin
# Get metadata about all integration tasks
data, status_code, headers = api_instance.get_integration_tasks_metadata_with_http_info(opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <TypesGetIntegrationTasksMetadataResponse>
rescue Falcon::ApiError => e
puts "Error when calling ASPM->get_integration_tasks_metadata_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **category** | **String** | | [optional] |
| **integration_task_types** | **Integer** | | [optional] |
| **ids** | **Integer** | | [optional] |
| **names** | **String** | | [optional] |

### Return type

[**TypesGetIntegrationTasksMetadataResponse**](TypesGetIntegrationTasksMetadataResponse.md)

### Authorization

**oauth2**

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


## get_integration_types

> <TypesListIntegrationTypesResponse> get_integration_types
Expand Down
Loading
Loading