diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index 74982502f18d1..beee5846367ab 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -2413,6 +2413,32 @@ menu: url: /api/latest/security-monitoring/ identifier: security-monitoring generated: true + - name: Returns list of Secrets rules + url: '#returns-list-of-secrets-rules' + identifier: security-monitoring-returns-list-of-secrets-rules + parent: security-monitoring + generated: true + params: + versions: + - v2 + operationids: + - GetSecretsRules + unstable: + - v2 + order: 28 + - name: Ruleset get multiple + url: '#ruleset-get-multiple' + identifier: security-monitoring-ruleset-get-multiple + parent: security-monitoring + generated: true + params: + versions: + - v2 + operationids: + - ListMultipleRulesets + unstable: + - v2 + order: 28 - name: Get a job's hist signals url: '#get-a-jobs-hist-signals' identifier: security-monitoring-get-a-jobs-hist-signals diff --git a/content/en/api/v2/security-monitoring/examples.json b/content/en/api/v2/security-monitoring/examples.json index 17f4f4797ce00..8cd24256f8323 100644 --- a/content/en/api/v2/security-monitoring/examples.json +++ b/content/en/api/v2/security-monitoring/examples.json @@ -7155,5 +7155,161 @@ "json": {}, "html": "" } + }, + "ListMultipleRulesets": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "rulesets": [ + { + "data": { + "id": "string", + "type": "rulesets" + }, + "description": "string", + "name": "string", + "rules": [ + { + "arguments": [ + { + "description": "string", + "name": "string" + } + ], + "category": "string", + "checksum": "string", + "code": "string", + "created_at": "2019-09-19T10:00:00.000Z", + "created_by": "string", + "cve": "string", + "cwe": "string", + "data": { + "id": "string", + "type": "rules" + }, + "description": "string", + "documentation_url": "string", + "entity_checked": "string", + "is_published": false, + "is_testing": false, + "language": "string", + "last_updated_at": "2019-09-19T10:00:00.000Z", + "last_updated_by": "string", + "name": "string", + "regex": "string", + "severity": "string", + "short_description": "string", + "should_use_ai_fix": false, + "tests": [ + { + "annotation_count": "integer", + "code": "string", + "filename": "string" + } + ], + "tree_sitter_query": "string", + "type": "string" + } + ], + "short_description": "string" + } + ] + }, + "id": "string", + "type": "get_multiple_rulesets_response" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of GetMultipleRulesetsResponseData object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of GetMultipleRulesetsResponseDataAttributes object.

\n
\n
\n
\n
\n
\n

rulesets

\n
\n

[object]

\n

The attributes rulesets.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The definition of GetMultipleRulesetsResponseDataAttributesRulesetsItemsData object.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The data id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Rulesets resource type. \nAllowed enum values: rulesets

default: rulesets

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The items description.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The items name.

\n
\n \n
\n
\n
\n
\n
\n

rules

\n
\n

[object]

\n

The items rules.

\n
\n
\n
\n
\n
\n

arguments

\n
\n

[object]

\n

The items arguments.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The items description.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The items name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

category

\n
\n

string

\n

The items category.

\n
\n \n
\n
\n
\n
\n
\n

checksum

\n
\n

string

\n

The items checksum.

\n
\n \n
\n
\n
\n
\n
\n

code

\n
\n

string

\n

The items code.

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The items created_at.

\n
\n \n
\n
\n
\n
\n
\n

created_by

\n
\n

string

\n

The items created_by.

\n
\n \n
\n
\n
\n
\n
\n

cve

\n
\n

string

\n

The items cve.

\n
\n \n
\n
\n
\n
\n
\n

cwe

\n
\n

string

\n

The items cwe.

\n
\n \n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The definition of GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData object.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The data id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Rules resource type. \nAllowed enum values: rules

default: rules

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The items description.

\n
\n \n
\n
\n
\n
\n
\n

documentation_url

\n
\n

string

\n

The items documentation_url.

\n
\n \n
\n
\n
\n
\n
\n

entity_checked

\n
\n

string

\n

The items entity_checked.

\n
\n \n
\n
\n
\n
\n
\n

is_published

\n
\n

boolean

\n

The items is_published.

\n
\n \n
\n
\n
\n
\n
\n

is_testing

\n
\n

boolean

\n

The items is_testing.

\n
\n \n
\n
\n
\n
\n
\n

language

\n
\n

string

\n

The items language.

\n
\n \n
\n
\n
\n
\n
\n

last_updated_at

\n
\n

date-time

\n

The items last_updated_at.

\n
\n \n
\n
\n
\n
\n
\n

last_updated_by

\n
\n

string

\n

The items last_updated_by.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The items name.

\n
\n \n
\n
\n
\n
\n
\n

regex

\n
\n

string

\n

The items regex.

\n
\n \n
\n
\n
\n
\n
\n

severity

\n
\n

string

\n

The items severity.

\n
\n \n
\n
\n
\n
\n
\n

short_description

\n
\n

string

\n

The items short_description.

\n
\n \n
\n
\n
\n
\n
\n

should_use_ai_fix

\n
\n

boolean

\n

The items should_use_ai_fix.

\n
\n \n
\n
\n
\n
\n
\n

tests

\n
\n

[object]

\n

The items tests.

\n
\n
\n
\n
\n
\n

annotation_count

\n
\n

int64

\n

The items annotation_count.

\n
\n \n
\n
\n
\n
\n
\n

code

\n
\n

string

\n

The items code.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

The items filename.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tree_sitter_query

\n
\n

string

\n

The items tree_sitter_query.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

The items type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

short_description

\n
\n

string

\n

The items short_description.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The GetMultipleRulesetsResponseData id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Get multiple rulesets response resource type. \nAllowed enum values: get_multiple_rulesets_response

default: get_multiple_rulesets_response

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "type": "get_multiple_rulesets_request" + } + }, + "json": { + "data": { + "attributes": { + "include_testing_rules": false, + "include_tests": false, + "rulesets": [] + }, + "id": "string", + "type": "get_multiple_rulesets_request" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of GetMultipleRulesetsRequestData object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of GetMultipleRulesetsRequestDataAttributes object.

\n
\n
\n
\n
\n
\n

include_testing_rules

\n
\n

boolean

\n

The attributes include_testing_rules.

\n
\n \n
\n
\n
\n
\n
\n

include_tests

\n
\n

boolean

\n

The attributes include_tests.

\n
\n \n
\n
\n
\n
\n
\n

rulesets

\n
\n

[string]

\n

The attributes rulesets.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The GetMultipleRulesetsRequestData id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Get multiple rulesets request resource type. \nAllowed enum values: get_multiple_rulesets_request

default: get_multiple_rulesets_request

\n
\n \n
\n
\n
\n
" + } + }, + "GetSecretsRules": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "default_included_keywords": [], + "description": "string", + "license": "string", + "match_validation": { + "endpoint": "string", + "hosts": [], + "http_method": "string", + "invalid_http_status_code": [ + { + "end": "integer", + "start": "integer" + } + ], + "request_headers": { + "": "string" + }, + "timeout_seconds": "integer", + "type": "string", + "valid_http_status_code": [ + { + "end": "integer", + "start": "integer" + } + ] + }, + "name": "string", + "pattern": "string", + "priority": "string", + "sds_id": "string", + "validators": [] + }, + "id": "string", + "type": "secret_rule" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

The SecretRuleArray data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of SecretRuleDataAttributes object.

\n
\n
\n
\n
\n
\n

default_included_keywords

\n
\n

[string]

\n

The attributes default_included_keywords.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The attributes description.

\n
\n \n
\n
\n
\n
\n
\n

license

\n
\n

string

\n

The attributes license.

\n
\n \n
\n
\n
\n
\n
\n

match_validation

\n
\n

object

\n

The definition of SecretRuleDataAttributesMatchValidation object.

\n
\n
\n
\n
\n
\n

endpoint

\n
\n

string

\n

The match_validation endpoint.

\n
\n \n
\n
\n
\n
\n
\n

hosts

\n
\n

[string]

\n

The match_validation hosts.

\n
\n \n
\n
\n
\n
\n
\n

http_method

\n
\n

string

\n

The match_validation http_method.

\n
\n \n
\n
\n
\n
\n
\n

invalid_http_status_code

\n
\n

[object]

\n

The match_validation invalid_http_status_code.

\n
\n
\n
\n
\n
\n

end

\n
\n

int64

\n

The items end.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

int64

\n

The items start.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request_headers

\n
\n

object

\n

The match_validation request_headers.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timeout_seconds

\n
\n

int64

\n

The match_validation timeout_seconds.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

The match_validation type.

\n
\n \n
\n
\n
\n
\n
\n

valid_http_status_code

\n
\n

[object]

\n

The match_validation valid_http_status_code.

\n
\n
\n
\n
\n
\n

end

\n
\n

int64

\n

The items end.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

int64

\n

The items start.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The attributes name.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

The attributes pattern.

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

string

\n

The attributes priority.

\n
\n \n
\n
\n
\n
\n
\n

sds_id

\n
\n

string

\n

The attributes sds_id.

\n
\n \n
\n
\n
\n
\n
\n

validators

\n
\n

[string]

\n

The attributes validators.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The SecretRuleData id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Secret rule resource type. \nAllowed enum values: secret_rule

default: secret_rule

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } } } \ No newline at end of file diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index bd1b35cf52ff9..114a561f52d8b 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -20500,6 +20500,266 @@ components: - ASSIGNEE - CASE - TEAM_OWNERS + GetMultipleRulesetsRequest: + description: The definition of `GetMultipleRulesetsRequest` object. + properties: + data: + $ref: '#/components/schemas/GetMultipleRulesetsRequestData' + type: object + GetMultipleRulesetsRequestData: + description: The definition of `GetMultipleRulesetsRequestData` object. + properties: + attributes: + $ref: '#/components/schemas/GetMultipleRulesetsRequestDataAttributes' + id: + description: The `GetMultipleRulesetsRequestData` `id`. + type: string + type: + $ref: '#/components/schemas/GetMultipleRulesetsRequestDataType' + required: + - type + type: object + GetMultipleRulesetsRequestDataAttributes: + description: The definition of `GetMultipleRulesetsRequestDataAttributes` object. + properties: + include_testing_rules: + description: The `attributes` `include_testing_rules`. + type: boolean + include_tests: + description: The `attributes` `include_tests`. + type: boolean + rulesets: + description: The `attributes` `rulesets`. + items: + type: string + type: array + type: object + GetMultipleRulesetsRequestDataType: + default: get_multiple_rulesets_request + description: Get multiple rulesets request resource type. + enum: + - get_multiple_rulesets_request + example: get_multiple_rulesets_request + type: string + x-enum-varnames: + - GET_MULTIPLE_RULESETS_REQUEST + GetMultipleRulesetsResponse: + description: The definition of `GetMultipleRulesetsResponse` object. + properties: + data: + $ref: '#/components/schemas/GetMultipleRulesetsResponseData' + type: object + GetMultipleRulesetsResponseData: + description: The definition of `GetMultipleRulesetsResponseData` object. + properties: + attributes: + $ref: '#/components/schemas/GetMultipleRulesetsResponseDataAttributes' + id: + description: The `GetMultipleRulesetsResponseData` `id`. + type: string + type: + $ref: '#/components/schemas/GetMultipleRulesetsResponseDataType' + required: + - type + type: object + GetMultipleRulesetsResponseDataAttributes: + description: The definition of `GetMultipleRulesetsResponseDataAttributes` object. + properties: + rulesets: + description: The `attributes` `rulesets`. + items: + $ref: '#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItems' + type: array + type: object + GetMultipleRulesetsResponseDataAttributesRulesetsItems: + description: The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItems` + object. + properties: + data: + $ref: '#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsData' + description: + description: The `items` `description`. + type: string + name: + description: The `items` `name`. + type: string + rules: + description: The `items` `rules`. + items: + $ref: '#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems' + type: array + short_description: + description: The `items` `short_description`. + type: string + required: + - data + type: object + GetMultipleRulesetsResponseDataAttributesRulesetsItemsData: + description: The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsData` + object. + properties: + id: + description: The `data` `id`. + type: string + type: + $ref: '#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsDataType' + required: + - type + type: object + GetMultipleRulesetsResponseDataAttributesRulesetsItemsDataType: + default: rulesets + description: Rulesets resource type. + enum: + - rulesets + example: rulesets + type: string + x-enum-varnames: + - RULESETS + GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems: + description: The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems` + object. + properties: + arguments: + description: The `items` `arguments`. + items: + $ref: '#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems' + type: array + category: + description: The `items` `category`. + type: string + checksum: + description: The `items` `checksum`. + type: string + code: + description: The `items` `code`. + type: string + created_at: + description: The `items` `created_at`. + format: date-time + type: string + created_by: + description: The `items` `created_by`. + type: string + cve: + description: The `items` `cve`. + type: string + cwe: + description: The `items` `cwe`. + type: string + data: + $ref: '#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData' + description: + description: The `items` `description`. + type: string + documentation_url: + description: The `items` `documentation_url`. + type: string + entity_checked: + description: The `items` `entity_checked`. + type: string + is_published: + description: The `items` `is_published`. + type: boolean + is_testing: + description: The `items` `is_testing`. + type: boolean + language: + description: The `items` `language`. + type: string + last_updated_at: + description: The `items` `last_updated_at`. + format: date-time + type: string + last_updated_by: + description: The `items` `last_updated_by`. + type: string + name: + description: The `items` `name`. + type: string + regex: + description: The `items` `regex`. + type: string + severity: + description: The `items` `severity`. + type: string + short_description: + description: The `items` `short_description`. + type: string + should_use_ai_fix: + description: The `items` `should_use_ai_fix`. + type: boolean + tests: + description: The `items` `tests`. + items: + $ref: '#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems' + type: array + tree_sitter_query: + description: The `items` `tree_sitter_query`. + type: string + type: + description: The `items` `type`. + type: string + required: + - data + type: object + GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems: + description: The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems` + object. + properties: + description: + description: The `items` `description`. + type: string + name: + description: The `items` `name`. + type: string + type: object + GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData: + description: The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData` + object. + properties: + id: + description: The `data` `id`. + type: string + type: + $ref: '#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsDataType' + required: + - type + type: object + GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsDataType: + default: rules + description: Rules resource type. + enum: + - rules + example: rules + type: string + x-enum-varnames: + - RULES + GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems: + description: The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems` + object. + properties: + annotation_count: + description: The `items` `annotation_count`. + format: int64 + maximum: 65535 + minimum: 0 + type: integer + code: + description: The `items` `code`. + type: string + filename: + description: The `items` `filename`. + type: string + type: object + GetMultipleRulesetsResponseDataType: + default: get_multiple_rulesets_response + description: Get multiple rulesets response resource type. + enum: + - get_multiple_rulesets_response + example: get_multiple_rulesets_response + type: string + x-enum-varnames: + - GET_MULTIPLE_RULESETS_RESPONSE GetResourceEvaluationFiltersResponse: description: The definition of `GetResourceEvaluationFiltersResponse` object. properties: @@ -41670,6 +41930,146 @@ components: - ISSUE_ASSIGNEE - ISSUE_CASE - ISSUE_TEAM_OWNERS + SecretRuleArray: + description: The definition of `SecretRuleArray` object. + properties: + data: + description: The `SecretRuleArray` `data`. + items: + $ref: '#/components/schemas/SecretRuleData' + type: array + required: + - data + type: object + SecretRuleData: + description: The definition of `SecretRuleData` object. + properties: + attributes: + $ref: '#/components/schemas/SecretRuleDataAttributes' + id: + description: The `SecretRuleData` `id`. + type: string + type: + $ref: '#/components/schemas/SecretRuleDataType' + required: + - type + type: object + SecretRuleDataAttributes: + description: The definition of `SecretRuleDataAttributes` object. + properties: + default_included_keywords: + description: The `attributes` `default_included_keywords`. + items: + type: string + type: array + description: + description: The `attributes` `description`. + type: string + license: + description: The `attributes` `license`. + type: string + match_validation: + $ref: '#/components/schemas/SecretRuleDataAttributesMatchValidation' + name: + description: The `attributes` `name`. + type: string + pattern: + description: The `attributes` `pattern`. + type: string + priority: + description: The `attributes` `priority`. + type: string + sds_id: + description: The `attributes` `sds_id`. + type: string + validators: + description: The `attributes` `validators`. + items: + type: string + type: array + type: object + SecretRuleDataAttributesMatchValidation: + description: The definition of `SecretRuleDataAttributesMatchValidation` object. + properties: + endpoint: + description: The `match_validation` `endpoint`. + type: string + hosts: + description: The `match_validation` `hosts`. + items: + type: string + type: array + http_method: + description: The `match_validation` `http_method`. + type: string + invalid_http_status_code: + description: The `match_validation` `invalid_http_status_code`. + items: + $ref: '#/components/schemas/SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems' + type: array + request_headers: + additionalProperties: + type: string + description: The `match_validation` `request_headers`. + type: object + timeout_seconds: + description: The `match_validation` `timeout_seconds`. + format: int64 + maximum: 1.8446744073709552e+19 + minimum: 0 + type: integer + type: + description: The `match_validation` `type`. + type: string + valid_http_status_code: + description: The `match_validation` `valid_http_status_code`. + items: + $ref: '#/components/schemas/SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems' + type: array + type: object + SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems: + description: The definition of `SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems` + object. + properties: + end: + description: The `items` `end`. + format: int64 + maximum: 1.8446744073709552e+19 + minimum: 0 + type: integer + start: + description: The `items` `start`. + format: int64 + maximum: 1.8446744073709552e+19 + minimum: 0 + type: integer + type: object + SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems: + description: The definition of `SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems` + object. + properties: + end: + description: The `items` `end`. + format: int64 + maximum: 1.8446744073709552e+19 + minimum: 0 + type: integer + start: + description: The `items` `start`. + format: int64 + maximum: 1.8446744073709552e+19 + minimum: 0 + type: integer + type: object + SecretRuleDataType: + default: secret_rule + description: Secret rule resource type. + enum: + - secret_rule + example: secret_rule + type: string + x-enum-varnames: + - SECRET_RULE SecurityFilter: description: The security filter's properties. properties: @@ -78028,6 +78428,65 @@ paths: resultsPath: data x-undo: type: safe + /api/v2/static-analysis/rulesets: + post: + description: Get rules for multiple rulesets in batch. + operationId: ListMultipleRulesets + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetMultipleRulesetsRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GetMultipleRulesetsResponse' + description: OK + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - AuthZ: + - code_analysis_read + - apiKeyAuth: [] + appKeyAuth: [] + summary: Ruleset get multiple + tags: + - Security Monitoring + x-menu-order: 28 + x-undo: + operationId: TODO + parameters: [] + type: unsafe + x-unstable: '**Note**: This endpoint may be subject to changes.' + /api/v2/static-analysis/secrets/rules: + get: + description: Returns list of Secrets rules with ID, Pattern, Description, Priority, + and SDS ID + operationId: GetSecretsRules + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SecretRuleArray' + description: OK + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - AuthZ: + - code_analysis_read + - apiKeyAuth: [] + appKeyAuth: [] + summary: Returns list of Secrets rules + tags: + - Security Monitoring + x-menu-order: 28 + x-undo: + type: safe + x-unstable: '**Note**: This endpoint may be subject to changes.' /api/v2/synthetics/settings/on_demand_concurrency_cap: get: description: Get the on-demand concurrency cap. diff --git a/data/api/v2/full_spec_deref.json b/data/api/v2/full_spec_deref.json index 9d326ebb0795a..c134c4adcf015 100644 --- a/data/api/v2/full_spec_deref.json +++ b/data/api/v2/full_spec_deref.json @@ -128599,6 +128599,1379 @@ "TEAM_OWNERS" ] }, + "GetMultipleRulesetsRequest": { + "description": "The definition of `GetMultipleRulesetsRequest` object.", + "properties": { + "data": { + "description": "The definition of `GetMultipleRulesetsRequestData` object.", + "properties": { + "attributes": { + "description": "The definition of `GetMultipleRulesetsRequestDataAttributes` object.", + "properties": { + "include_testing_rules": { + "description": "The `attributes` `include_testing_rules`.", + "type": "boolean" + }, + "include_tests": { + "description": "The `attributes` `include_tests`.", + "type": "boolean" + }, + "rulesets": { + "description": "The `attributes` `rulesets`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "description": "The `GetMultipleRulesetsRequestData` `id`.", + "type": "string" + }, + "type": { + "default": "get_multiple_rulesets_request", + "description": "Get multiple rulesets request resource type.", + "enum": [ + "get_multiple_rulesets_request" + ], + "example": "get_multiple_rulesets_request", + "type": "string", + "x-enum-varnames": [ + "GET_MULTIPLE_RULESETS_REQUEST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "GetMultipleRulesetsRequestData": { + "description": "The definition of `GetMultipleRulesetsRequestData` object.", + "properties": { + "attributes": { + "description": "The definition of `GetMultipleRulesetsRequestDataAttributes` object.", + "properties": { + "include_testing_rules": { + "description": "The `attributes` `include_testing_rules`.", + "type": "boolean" + }, + "include_tests": { + "description": "The `attributes` `include_tests`.", + "type": "boolean" + }, + "rulesets": { + "description": "The `attributes` `rulesets`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "description": "The `GetMultipleRulesetsRequestData` `id`.", + "type": "string" + }, + "type": { + "default": "get_multiple_rulesets_request", + "description": "Get multiple rulesets request resource type.", + "enum": [ + "get_multiple_rulesets_request" + ], + "example": "get_multiple_rulesets_request", + "type": "string", + "x-enum-varnames": [ + "GET_MULTIPLE_RULESETS_REQUEST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "GetMultipleRulesetsRequestDataAttributes": { + "description": "The definition of `GetMultipleRulesetsRequestDataAttributes` object.", + "properties": { + "include_testing_rules": { + "description": "The `attributes` `include_testing_rules`.", + "type": "boolean" + }, + "include_tests": { + "description": "The `attributes` `include_tests`.", + "type": "boolean" + }, + "rulesets": { + "description": "The `attributes` `rulesets`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GetMultipleRulesetsRequestDataType": { + "default": "get_multiple_rulesets_request", + "description": "Get multiple rulesets request resource type.", + "enum": [ + "get_multiple_rulesets_request" + ], + "example": "get_multiple_rulesets_request", + "type": "string", + "x-enum-varnames": [ + "GET_MULTIPLE_RULESETS_REQUEST" + ] + }, + "GetMultipleRulesetsResponse": { + "description": "The definition of `GetMultipleRulesetsResponse` object.", + "properties": { + "data": { + "description": "The definition of `GetMultipleRulesetsResponseData` object.", + "properties": { + "attributes": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributes` object.", + "properties": { + "rulesets": { + "description": "The `attributes` `rulesets`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItems` object.", + "properties": { + "data": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsData` object.", + "properties": { + "id": { + "description": "The `data` `id`.", + "type": "string" + }, + "type": { + "default": "rulesets", + "description": "Rulesets resource type.", + "enum": [ + "rulesets" + ], + "example": "rulesets", + "type": "string", + "x-enum-varnames": [ + "RULESETS" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + }, + "rules": { + "description": "The `items` `rules`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems` object.", + "properties": { + "arguments": { + "description": "The `items` `arguments`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems` object.", + "properties": { + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "category": { + "description": "The `items` `category`.", + "type": "string" + }, + "checksum": { + "description": "The `items` `checksum`.", + "type": "string" + }, + "code": { + "description": "The `items` `code`.", + "type": "string" + }, + "created_at": { + "description": "The `items` `created_at`.", + "format": "date-time", + "type": "string" + }, + "created_by": { + "description": "The `items` `created_by`.", + "type": "string" + }, + "cve": { + "description": "The `items` `cve`.", + "type": "string" + }, + "cwe": { + "description": "The `items` `cwe`.", + "type": "string" + }, + "data": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData` object.", + "properties": { + "id": { + "description": "The `data` `id`.", + "type": "string" + }, + "type": { + "default": "rules", + "description": "Rules resource type.", + "enum": [ + "rules" + ], + "example": "rules", + "type": "string", + "x-enum-varnames": [ + "RULES" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "documentation_url": { + "description": "The `items` `documentation_url`.", + "type": "string" + }, + "entity_checked": { + "description": "The `items` `entity_checked`.", + "type": "string" + }, + "is_published": { + "description": "The `items` `is_published`.", + "type": "boolean" + }, + "is_testing": { + "description": "The `items` `is_testing`.", + "type": "boolean" + }, + "language": { + "description": "The `items` `language`.", + "type": "string" + }, + "last_updated_at": { + "description": "The `items` `last_updated_at`.", + "format": "date-time", + "type": "string" + }, + "last_updated_by": { + "description": "The `items` `last_updated_by`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + }, + "regex": { + "description": "The `items` `regex`.", + "type": "string" + }, + "severity": { + "description": "The `items` `severity`.", + "type": "string" + }, + "short_description": { + "description": "The `items` `short_description`.", + "type": "string" + }, + "should_use_ai_fix": { + "description": "The `items` `should_use_ai_fix`.", + "type": "boolean" + }, + "tests": { + "description": "The `items` `tests`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems` object.", + "properties": { + "annotation_count": { + "description": "The `items` `annotation_count`.", + "format": "int64", + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "code": { + "description": "The `items` `code`.", + "type": "string" + }, + "filename": { + "description": "The `items` `filename`.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "tree_sitter_query": { + "description": "The `items` `tree_sitter_query`.", + "type": "string" + }, + "type": { + "description": "The `items` `type`.", + "type": "string" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "type": "array" + }, + "short_description": { + "description": "The `items` `short_description`.", + "type": "string" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "description": "The `GetMultipleRulesetsResponseData` `id`.", + "type": "string" + }, + "type": { + "default": "get_multiple_rulesets_response", + "description": "Get multiple rulesets response resource type.", + "enum": [ + "get_multiple_rulesets_response" + ], + "example": "get_multiple_rulesets_response", + "type": "string", + "x-enum-varnames": [ + "GET_MULTIPLE_RULESETS_RESPONSE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "GetMultipleRulesetsResponseData": { + "description": "The definition of `GetMultipleRulesetsResponseData` object.", + "properties": { + "attributes": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributes` object.", + "properties": { + "rulesets": { + "description": "The `attributes` `rulesets`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItems` object.", + "properties": { + "data": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsData` object.", + "properties": { + "id": { + "description": "The `data` `id`.", + "type": "string" + }, + "type": { + "default": "rulesets", + "description": "Rulesets resource type.", + "enum": [ + "rulesets" + ], + "example": "rulesets", + "type": "string", + "x-enum-varnames": [ + "RULESETS" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + }, + "rules": { + "description": "The `items` `rules`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems` object.", + "properties": { + "arguments": { + "description": "The `items` `arguments`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems` object.", + "properties": { + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "category": { + "description": "The `items` `category`.", + "type": "string" + }, + "checksum": { + "description": "The `items` `checksum`.", + "type": "string" + }, + "code": { + "description": "The `items` `code`.", + "type": "string" + }, + "created_at": { + "description": "The `items` `created_at`.", + "format": "date-time", + "type": "string" + }, + "created_by": { + "description": "The `items` `created_by`.", + "type": "string" + }, + "cve": { + "description": "The `items` `cve`.", + "type": "string" + }, + "cwe": { + "description": "The `items` `cwe`.", + "type": "string" + }, + "data": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData` object.", + "properties": { + "id": { + "description": "The `data` `id`.", + "type": "string" + }, + "type": { + "default": "rules", + "description": "Rules resource type.", + "enum": [ + "rules" + ], + "example": "rules", + "type": "string", + "x-enum-varnames": [ + "RULES" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "documentation_url": { + "description": "The `items` `documentation_url`.", + "type": "string" + }, + "entity_checked": { + "description": "The `items` `entity_checked`.", + "type": "string" + }, + "is_published": { + "description": "The `items` `is_published`.", + "type": "boolean" + }, + "is_testing": { + "description": "The `items` `is_testing`.", + "type": "boolean" + }, + "language": { + "description": "The `items` `language`.", + "type": "string" + }, + "last_updated_at": { + "description": "The `items` `last_updated_at`.", + "format": "date-time", + "type": "string" + }, + "last_updated_by": { + "description": "The `items` `last_updated_by`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + }, + "regex": { + "description": "The `items` `regex`.", + "type": "string" + }, + "severity": { + "description": "The `items` `severity`.", + "type": "string" + }, + "short_description": { + "description": "The `items` `short_description`.", + "type": "string" + }, + "should_use_ai_fix": { + "description": "The `items` `should_use_ai_fix`.", + "type": "boolean" + }, + "tests": { + "description": "The `items` `tests`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems` object.", + "properties": { + "annotation_count": { + "description": "The `items` `annotation_count`.", + "format": "int64", + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "code": { + "description": "The `items` `code`.", + "type": "string" + }, + "filename": { + "description": "The `items` `filename`.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "tree_sitter_query": { + "description": "The `items` `tree_sitter_query`.", + "type": "string" + }, + "type": { + "description": "The `items` `type`.", + "type": "string" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "type": "array" + }, + "short_description": { + "description": "The `items` `short_description`.", + "type": "string" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "description": "The `GetMultipleRulesetsResponseData` `id`.", + "type": "string" + }, + "type": { + "default": "get_multiple_rulesets_response", + "description": "Get multiple rulesets response resource type.", + "enum": [ + "get_multiple_rulesets_response" + ], + "example": "get_multiple_rulesets_response", + "type": "string", + "x-enum-varnames": [ + "GET_MULTIPLE_RULESETS_RESPONSE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "GetMultipleRulesetsResponseDataAttributes": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributes` object.", + "properties": { + "rulesets": { + "description": "The `attributes` `rulesets`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItems` object.", + "properties": { + "data": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsData` object.", + "properties": { + "id": { + "description": "The `data` `id`.", + "type": "string" + }, + "type": { + "default": "rulesets", + "description": "Rulesets resource type.", + "enum": [ + "rulesets" + ], + "example": "rulesets", + "type": "string", + "x-enum-varnames": [ + "RULESETS" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + }, + "rules": { + "description": "The `items` `rules`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems` object.", + "properties": { + "arguments": { + "description": "The `items` `arguments`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems` object.", + "properties": { + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "category": { + "description": "The `items` `category`.", + "type": "string" + }, + "checksum": { + "description": "The `items` `checksum`.", + "type": "string" + }, + "code": { + "description": "The `items` `code`.", + "type": "string" + }, + "created_at": { + "description": "The `items` `created_at`.", + "format": "date-time", + "type": "string" + }, + "created_by": { + "description": "The `items` `created_by`.", + "type": "string" + }, + "cve": { + "description": "The `items` `cve`.", + "type": "string" + }, + "cwe": { + "description": "The `items` `cwe`.", + "type": "string" + }, + "data": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData` object.", + "properties": { + "id": { + "description": "The `data` `id`.", + "type": "string" + }, + "type": { + "default": "rules", + "description": "Rules resource type.", + "enum": [ + "rules" + ], + "example": "rules", + "type": "string", + "x-enum-varnames": [ + "RULES" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "documentation_url": { + "description": "The `items` `documentation_url`.", + "type": "string" + }, + "entity_checked": { + "description": "The `items` `entity_checked`.", + "type": "string" + }, + "is_published": { + "description": "The `items` `is_published`.", + "type": "boolean" + }, + "is_testing": { + "description": "The `items` `is_testing`.", + "type": "boolean" + }, + "language": { + "description": "The `items` `language`.", + "type": "string" + }, + "last_updated_at": { + "description": "The `items` `last_updated_at`.", + "format": "date-time", + "type": "string" + }, + "last_updated_by": { + "description": "The `items` `last_updated_by`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + }, + "regex": { + "description": "The `items` `regex`.", + "type": "string" + }, + "severity": { + "description": "The `items` `severity`.", + "type": "string" + }, + "short_description": { + "description": "The `items` `short_description`.", + "type": "string" + }, + "should_use_ai_fix": { + "description": "The `items` `should_use_ai_fix`.", + "type": "boolean" + }, + "tests": { + "description": "The `items` `tests`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems` object.", + "properties": { + "annotation_count": { + "description": "The `items` `annotation_count`.", + "format": "int64", + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "code": { + "description": "The `items` `code`.", + "type": "string" + }, + "filename": { + "description": "The `items` `filename`.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "tree_sitter_query": { + "description": "The `items` `tree_sitter_query`.", + "type": "string" + }, + "type": { + "description": "The `items` `type`.", + "type": "string" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "type": "array" + }, + "short_description": { + "description": "The `items` `short_description`.", + "type": "string" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "GetMultipleRulesetsResponseDataAttributesRulesetsItems": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItems` object.", + "properties": { + "data": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsData` object.", + "properties": { + "id": { + "description": "The `data` `id`.", + "type": "string" + }, + "type": { + "default": "rulesets", + "description": "Rulesets resource type.", + "enum": [ + "rulesets" + ], + "example": "rulesets", + "type": "string", + "x-enum-varnames": [ + "RULESETS" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + }, + "rules": { + "description": "The `items` `rules`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems` object.", + "properties": { + "arguments": { + "description": "The `items` `arguments`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems` object.", + "properties": { + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "category": { + "description": "The `items` `category`.", + "type": "string" + }, + "checksum": { + "description": "The `items` `checksum`.", + "type": "string" + }, + "code": { + "description": "The `items` `code`.", + "type": "string" + }, + "created_at": { + "description": "The `items` `created_at`.", + "format": "date-time", + "type": "string" + }, + "created_by": { + "description": "The `items` `created_by`.", + "type": "string" + }, + "cve": { + "description": "The `items` `cve`.", + "type": "string" + }, + "cwe": { + "description": "The `items` `cwe`.", + "type": "string" + }, + "data": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData` object.", + "properties": { + "id": { + "description": "The `data` `id`.", + "type": "string" + }, + "type": { + "default": "rules", + "description": "Rules resource type.", + "enum": [ + "rules" + ], + "example": "rules", + "type": "string", + "x-enum-varnames": [ + "RULES" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "documentation_url": { + "description": "The `items` `documentation_url`.", + "type": "string" + }, + "entity_checked": { + "description": "The `items` `entity_checked`.", + "type": "string" + }, + "is_published": { + "description": "The `items` `is_published`.", + "type": "boolean" + }, + "is_testing": { + "description": "The `items` `is_testing`.", + "type": "boolean" + }, + "language": { + "description": "The `items` `language`.", + "type": "string" + }, + "last_updated_at": { + "description": "The `items` `last_updated_at`.", + "format": "date-time", + "type": "string" + }, + "last_updated_by": { + "description": "The `items` `last_updated_by`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + }, + "regex": { + "description": "The `items` `regex`.", + "type": "string" + }, + "severity": { + "description": "The `items` `severity`.", + "type": "string" + }, + "short_description": { + "description": "The `items` `short_description`.", + "type": "string" + }, + "should_use_ai_fix": { + "description": "The `items` `should_use_ai_fix`.", + "type": "boolean" + }, + "tests": { + "description": "The `items` `tests`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems` object.", + "properties": { + "annotation_count": { + "description": "The `items` `annotation_count`.", + "format": "int64", + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "code": { + "description": "The `items` `code`.", + "type": "string" + }, + "filename": { + "description": "The `items` `filename`.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "tree_sitter_query": { + "description": "The `items` `tree_sitter_query`.", + "type": "string" + }, + "type": { + "description": "The `items` `type`.", + "type": "string" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "type": "array" + }, + "short_description": { + "description": "The `items` `short_description`.", + "type": "string" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "GetMultipleRulesetsResponseDataAttributesRulesetsItemsData": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsData` object.", + "properties": { + "id": { + "description": "The `data` `id`.", + "type": "string" + }, + "type": { + "default": "rulesets", + "description": "Rulesets resource type.", + "enum": [ + "rulesets" + ], + "example": "rulesets", + "type": "string", + "x-enum-varnames": [ + "RULESETS" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "GetMultipleRulesetsResponseDataAttributesRulesetsItemsDataType": { + "default": "rulesets", + "description": "Rulesets resource type.", + "enum": [ + "rulesets" + ], + "example": "rulesets", + "type": "string", + "x-enum-varnames": [ + "RULESETS" + ] + }, + "GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems` object.", + "properties": { + "arguments": { + "description": "The `items` `arguments`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems` object.", + "properties": { + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "category": { + "description": "The `items` `category`.", + "type": "string" + }, + "checksum": { + "description": "The `items` `checksum`.", + "type": "string" + }, + "code": { + "description": "The `items` `code`.", + "type": "string" + }, + "created_at": { + "description": "The `items` `created_at`.", + "format": "date-time", + "type": "string" + }, + "created_by": { + "description": "The `items` `created_by`.", + "type": "string" + }, + "cve": { + "description": "The `items` `cve`.", + "type": "string" + }, + "cwe": { + "description": "The `items` `cwe`.", + "type": "string" + }, + "data": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData` object.", + "properties": { + "id": { + "description": "The `data` `id`.", + "type": "string" + }, + "type": { + "default": "rules", + "description": "Rules resource type.", + "enum": [ + "rules" + ], + "example": "rules", + "type": "string", + "x-enum-varnames": [ + "RULES" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "documentation_url": { + "description": "The `items` `documentation_url`.", + "type": "string" + }, + "entity_checked": { + "description": "The `items` `entity_checked`.", + "type": "string" + }, + "is_published": { + "description": "The `items` `is_published`.", + "type": "boolean" + }, + "is_testing": { + "description": "The `items` `is_testing`.", + "type": "boolean" + }, + "language": { + "description": "The `items` `language`.", + "type": "string" + }, + "last_updated_at": { + "description": "The `items` `last_updated_at`.", + "format": "date-time", + "type": "string" + }, + "last_updated_by": { + "description": "The `items` `last_updated_by`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + }, + "regex": { + "description": "The `items` `regex`.", + "type": "string" + }, + "severity": { + "description": "The `items` `severity`.", + "type": "string" + }, + "short_description": { + "description": "The `items` `short_description`.", + "type": "string" + }, + "should_use_ai_fix": { + "description": "The `items` `should_use_ai_fix`.", + "type": "boolean" + }, + "tests": { + "description": "The `items` `tests`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems` object.", + "properties": { + "annotation_count": { + "description": "The `items` `annotation_count`.", + "format": "int64", + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "code": { + "description": "The `items` `code`.", + "type": "string" + }, + "filename": { + "description": "The `items` `filename`.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "tree_sitter_query": { + "description": "The `items` `tree_sitter_query`.", + "type": "string" + }, + "type": { + "description": "The `items` `type`.", + "type": "string" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems` object.", + "properties": { + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + } + }, + "type": "object" + }, + "GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData` object.", + "properties": { + "id": { + "description": "The `data` `id`.", + "type": "string" + }, + "type": { + "default": "rules", + "description": "Rules resource type.", + "enum": [ + "rules" + ], + "example": "rules", + "type": "string", + "x-enum-varnames": [ + "RULES" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsDataType": { + "default": "rules", + "description": "Rules resource type.", + "enum": [ + "rules" + ], + "example": "rules", + "type": "string", + "x-enum-varnames": [ + "RULES" + ] + }, + "GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems` object.", + "properties": { + "annotation_count": { + "description": "The `items` `annotation_count`.", + "format": "int64", + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "code": { + "description": "The `items` `code`.", + "type": "string" + }, + "filename": { + "description": "The `items` `filename`.", + "type": "string" + } + }, + "type": "object" + }, + "GetMultipleRulesetsResponseDataType": { + "default": "get_multiple_rulesets_response", + "description": "Get multiple rulesets response resource type.", + "enum": [ + "get_multiple_rulesets_response" + ], + "example": "get_multiple_rulesets_response", + "type": "string", + "x-enum-varnames": [ + "GET_MULTIPLE_RULESETS_RESPONSE" + ] + }, "GetResourceEvaluationFiltersResponse": { "description": "The definition of `GetResourceEvaluationFiltersResponse` object.", "properties": { @@ -300417,6 +301790,601 @@ "ISSUE_TEAM_OWNERS" ] }, + "SecretRuleArray": { + "description": "The definition of `SecretRuleArray` object.", + "properties": { + "data": { + "description": "The `SecretRuleArray` `data`.", + "items": { + "description": "The definition of `SecretRuleData` object.", + "properties": { + "attributes": { + "description": "The definition of `SecretRuleDataAttributes` object.", + "properties": { + "default_included_keywords": { + "description": "The `attributes` `default_included_keywords`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "description": { + "description": "The `attributes` `description`.", + "type": "string" + }, + "license": { + "description": "The `attributes` `license`.", + "type": "string" + }, + "match_validation": { + "description": "The definition of `SecretRuleDataAttributesMatchValidation` object.", + "properties": { + "endpoint": { + "description": "The `match_validation` `endpoint`.", + "type": "string" + }, + "hosts": { + "description": "The `match_validation` `hosts`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "http_method": { + "description": "The `match_validation` `http_method`.", + "type": "string" + }, + "invalid_http_status_code": { + "description": "The `match_validation` `invalid_http_status_code`.", + "items": { + "description": "The definition of `SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems` object.", + "properties": { + "end": { + "description": "The `items` `end`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "start": { + "description": "The `items` `start`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + }, + "request_headers": { + "additionalProperties": { + "type": "string" + }, + "description": "The `match_validation` `request_headers`.", + "type": "object" + }, + "timeout_seconds": { + "description": "The `match_validation` `timeout_seconds`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "type": { + "description": "The `match_validation` `type`.", + "type": "string" + }, + "valid_http_status_code": { + "description": "The `match_validation` `valid_http_status_code`.", + "items": { + "description": "The definition of `SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems` object.", + "properties": { + "end": { + "description": "The `items` `end`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "start": { + "description": "The `items` `start`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "name": { + "description": "The `attributes` `name`.", + "type": "string" + }, + "pattern": { + "description": "The `attributes` `pattern`.", + "type": "string" + }, + "priority": { + "description": "The `attributes` `priority`.", + "type": "string" + }, + "sds_id": { + "description": "The `attributes` `sds_id`.", + "type": "string" + }, + "validators": { + "description": "The `attributes` `validators`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "description": "The `SecretRuleData` `id`.", + "type": "string" + }, + "type": { + "default": "secret_rule", + "description": "Secret rule resource type.", + "enum": [ + "secret_rule" + ], + "example": "secret_rule", + "type": "string", + "x-enum-varnames": [ + "SECRET_RULE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "SecretRuleData": { + "description": "The definition of `SecretRuleData` object.", + "properties": { + "attributes": { + "description": "The definition of `SecretRuleDataAttributes` object.", + "properties": { + "default_included_keywords": { + "description": "The `attributes` `default_included_keywords`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "description": { + "description": "The `attributes` `description`.", + "type": "string" + }, + "license": { + "description": "The `attributes` `license`.", + "type": "string" + }, + "match_validation": { + "description": "The definition of `SecretRuleDataAttributesMatchValidation` object.", + "properties": { + "endpoint": { + "description": "The `match_validation` `endpoint`.", + "type": "string" + }, + "hosts": { + "description": "The `match_validation` `hosts`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "http_method": { + "description": "The `match_validation` `http_method`.", + "type": "string" + }, + "invalid_http_status_code": { + "description": "The `match_validation` `invalid_http_status_code`.", + "items": { + "description": "The definition of `SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems` object.", + "properties": { + "end": { + "description": "The `items` `end`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "start": { + "description": "The `items` `start`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + }, + "request_headers": { + "additionalProperties": { + "type": "string" + }, + "description": "The `match_validation` `request_headers`.", + "type": "object" + }, + "timeout_seconds": { + "description": "The `match_validation` `timeout_seconds`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "type": { + "description": "The `match_validation` `type`.", + "type": "string" + }, + "valid_http_status_code": { + "description": "The `match_validation` `valid_http_status_code`.", + "items": { + "description": "The definition of `SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems` object.", + "properties": { + "end": { + "description": "The `items` `end`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "start": { + "description": "The `items` `start`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "name": { + "description": "The `attributes` `name`.", + "type": "string" + }, + "pattern": { + "description": "The `attributes` `pattern`.", + "type": "string" + }, + "priority": { + "description": "The `attributes` `priority`.", + "type": "string" + }, + "sds_id": { + "description": "The `attributes` `sds_id`.", + "type": "string" + }, + "validators": { + "description": "The `attributes` `validators`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "description": "The `SecretRuleData` `id`.", + "type": "string" + }, + "type": { + "default": "secret_rule", + "description": "Secret rule resource type.", + "enum": [ + "secret_rule" + ], + "example": "secret_rule", + "type": "string", + "x-enum-varnames": [ + "SECRET_RULE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "SecretRuleDataAttributes": { + "description": "The definition of `SecretRuleDataAttributes` object.", + "properties": { + "default_included_keywords": { + "description": "The `attributes` `default_included_keywords`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "description": { + "description": "The `attributes` `description`.", + "type": "string" + }, + "license": { + "description": "The `attributes` `license`.", + "type": "string" + }, + "match_validation": { + "description": "The definition of `SecretRuleDataAttributesMatchValidation` object.", + "properties": { + "endpoint": { + "description": "The `match_validation` `endpoint`.", + "type": "string" + }, + "hosts": { + "description": "The `match_validation` `hosts`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "http_method": { + "description": "The `match_validation` `http_method`.", + "type": "string" + }, + "invalid_http_status_code": { + "description": "The `match_validation` `invalid_http_status_code`.", + "items": { + "description": "The definition of `SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems` object.", + "properties": { + "end": { + "description": "The `items` `end`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "start": { + "description": "The `items` `start`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + }, + "request_headers": { + "additionalProperties": { + "type": "string" + }, + "description": "The `match_validation` `request_headers`.", + "type": "object" + }, + "timeout_seconds": { + "description": "The `match_validation` `timeout_seconds`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "type": { + "description": "The `match_validation` `type`.", + "type": "string" + }, + "valid_http_status_code": { + "description": "The `match_validation` `valid_http_status_code`.", + "items": { + "description": "The definition of `SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems` object.", + "properties": { + "end": { + "description": "The `items` `end`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "start": { + "description": "The `items` `start`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "name": { + "description": "The `attributes` `name`.", + "type": "string" + }, + "pattern": { + "description": "The `attributes` `pattern`.", + "type": "string" + }, + "priority": { + "description": "The `attributes` `priority`.", + "type": "string" + }, + "sds_id": { + "description": "The `attributes` `sds_id`.", + "type": "string" + }, + "validators": { + "description": "The `attributes` `validators`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "SecretRuleDataAttributesMatchValidation": { + "description": "The definition of `SecretRuleDataAttributesMatchValidation` object.", + "properties": { + "endpoint": { + "description": "The `match_validation` `endpoint`.", + "type": "string" + }, + "hosts": { + "description": "The `match_validation` `hosts`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "http_method": { + "description": "The `match_validation` `http_method`.", + "type": "string" + }, + "invalid_http_status_code": { + "description": "The `match_validation` `invalid_http_status_code`.", + "items": { + "description": "The definition of `SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems` object.", + "properties": { + "end": { + "description": "The `items` `end`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "start": { + "description": "The `items` `start`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + }, + "request_headers": { + "additionalProperties": { + "type": "string" + }, + "description": "The `match_validation` `request_headers`.", + "type": "object" + }, + "timeout_seconds": { + "description": "The `match_validation` `timeout_seconds`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "type": { + "description": "The `match_validation` `type`.", + "type": "string" + }, + "valid_http_status_code": { + "description": "The `match_validation` `valid_http_status_code`.", + "items": { + "description": "The definition of `SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems` object.", + "properties": { + "end": { + "description": "The `items` `end`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "start": { + "description": "The `items` `start`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems": { + "description": "The definition of `SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems` object.", + "properties": { + "end": { + "description": "The `items` `end`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "start": { + "description": "The `items` `start`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems": { + "description": "The definition of `SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems` object.", + "properties": { + "end": { + "description": "The `items` `end`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "start": { + "description": "The `items` `start`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "SecretRuleDataType": { + "default": "secret_rule", + "description": "Secret rule resource type.", + "enum": [ + "secret_rule" + ], + "example": "secret_rule", + "type": "string", + "x-enum-varnames": [ + "SECRET_RULE" + ] + }, "SecurityFilter": { "description": "The security filter's properties.", "properties": { @@ -686810,6 +688778,620 @@ } } }, + "/api/v2/static-analysis/rulesets": { + "post": { + "description": "Get rules for multiple rulesets in batch.", + "operationId": "ListMultipleRulesets", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "The definition of `GetMultipleRulesetsRequest` object.", + "properties": { + "data": { + "description": "The definition of `GetMultipleRulesetsRequestData` object.", + "properties": { + "attributes": { + "description": "The definition of `GetMultipleRulesetsRequestDataAttributes` object.", + "properties": { + "include_testing_rules": { + "description": "The `attributes` `include_testing_rules`.", + "type": "boolean" + }, + "include_tests": { + "description": "The `attributes` `include_tests`.", + "type": "boolean" + }, + "rulesets": { + "description": "The `attributes` `rulesets`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "description": "The `GetMultipleRulesetsRequestData` `id`.", + "type": "string" + }, + "type": { + "default": "get_multiple_rulesets_request", + "description": "Get multiple rulesets request resource type.", + "enum": [ + "get_multiple_rulesets_request" + ], + "example": "get_multiple_rulesets_request", + "type": "string", + "x-enum-varnames": [ + "GET_MULTIPLE_RULESETS_REQUEST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "The definition of `GetMultipleRulesetsResponse` object.", + "properties": { + "data": { + "description": "The definition of `GetMultipleRulesetsResponseData` object.", + "properties": { + "attributes": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributes` object.", + "properties": { + "rulesets": { + "description": "The `attributes` `rulesets`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItems` object.", + "properties": { + "data": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsData` object.", + "properties": { + "id": { + "description": "The `data` `id`.", + "type": "string" + }, + "type": { + "default": "rulesets", + "description": "Rulesets resource type.", + "enum": [ + "rulesets" + ], + "example": "rulesets", + "type": "string", + "x-enum-varnames": [ + "RULESETS" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + }, + "rules": { + "description": "The `items` `rules`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems` object.", + "properties": { + "arguments": { + "description": "The `items` `arguments`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems` object.", + "properties": { + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "category": { + "description": "The `items` `category`.", + "type": "string" + }, + "checksum": { + "description": "The `items` `checksum`.", + "type": "string" + }, + "code": { + "description": "The `items` `code`.", + "type": "string" + }, + "created_at": { + "description": "The `items` `created_at`.", + "format": "date-time", + "type": "string" + }, + "created_by": { + "description": "The `items` `created_by`.", + "type": "string" + }, + "cve": { + "description": "The `items` `cve`.", + "type": "string" + }, + "cwe": { + "description": "The `items` `cwe`.", + "type": "string" + }, + "data": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData` object.", + "properties": { + "id": { + "description": "The `data` `id`.", + "type": "string" + }, + "type": { + "default": "rules", + "description": "Rules resource type.", + "enum": [ + "rules" + ], + "example": "rules", + "type": "string", + "x-enum-varnames": [ + "RULES" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "documentation_url": { + "description": "The `items` `documentation_url`.", + "type": "string" + }, + "entity_checked": { + "description": "The `items` `entity_checked`.", + "type": "string" + }, + "is_published": { + "description": "The `items` `is_published`.", + "type": "boolean" + }, + "is_testing": { + "description": "The `items` `is_testing`.", + "type": "boolean" + }, + "language": { + "description": "The `items` `language`.", + "type": "string" + }, + "last_updated_at": { + "description": "The `items` `last_updated_at`.", + "format": "date-time", + "type": "string" + }, + "last_updated_by": { + "description": "The `items` `last_updated_by`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + }, + "regex": { + "description": "The `items` `regex`.", + "type": "string" + }, + "severity": { + "description": "The `items` `severity`.", + "type": "string" + }, + "short_description": { + "description": "The `items` `short_description`.", + "type": "string" + }, + "should_use_ai_fix": { + "description": "The `items` `should_use_ai_fix`.", + "type": "boolean" + }, + "tests": { + "description": "The `items` `tests`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems` object.", + "properties": { + "annotation_count": { + "description": "The `items` `annotation_count`.", + "format": "int64", + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "code": { + "description": "The `items` `code`.", + "type": "string" + }, + "filename": { + "description": "The `items` `filename`.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "tree_sitter_query": { + "description": "The `items` `tree_sitter_query`.", + "type": "string" + }, + "type": { + "description": "The `items` `type`.", + "type": "string" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "type": "array" + }, + "short_description": { + "description": "The `items` `short_description`.", + "type": "string" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "description": "The `GetMultipleRulesetsResponseData` `id`.", + "type": "string" + }, + "type": { + "default": "get_multiple_rulesets_response", + "description": "Get multiple rulesets response resource type.", + "enum": [ + "get_multiple_rulesets_response" + ], + "example": "get_multiple_rulesets_response", + "type": "string", + "x-enum-varnames": [ + "GET_MULTIPLE_RULESETS_RESPONSE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "AuthZ": [ + "code_analysis_read" + ] + }, + { + "apiKeyAuth": [], + "appKeyAuth": [] + } + ], + "summary": "Ruleset get multiple", + "tags": [ + "Security Monitoring" + ], + "x-menu-order": 28, + "x-undo": { + "operationId": "TODO", + "parameters": [], + "type": "unsafe" + }, + "x-unstable": "**Note**: This endpoint may be subject to changes." + } + }, + "/api/v2/static-analysis/secrets/rules": { + "get": { + "description": "Returns list of Secrets rules with ID, Pattern, Description, Priority, and SDS ID", + "operationId": "GetSecretsRules", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "The definition of `SecretRuleArray` object.", + "properties": { + "data": { + "description": "The `SecretRuleArray` `data`.", + "items": { + "description": "The definition of `SecretRuleData` object.", + "properties": { + "attributes": { + "description": "The definition of `SecretRuleDataAttributes` object.", + "properties": { + "default_included_keywords": { + "description": "The `attributes` `default_included_keywords`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "description": { + "description": "The `attributes` `description`.", + "type": "string" + }, + "license": { + "description": "The `attributes` `license`.", + "type": "string" + }, + "match_validation": { + "description": "The definition of `SecretRuleDataAttributesMatchValidation` object.", + "properties": { + "endpoint": { + "description": "The `match_validation` `endpoint`.", + "type": "string" + }, + "hosts": { + "description": "The `match_validation` `hosts`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "http_method": { + "description": "The `match_validation` `http_method`.", + "type": "string" + }, + "invalid_http_status_code": { + "description": "The `match_validation` `invalid_http_status_code`.", + "items": { + "description": "The definition of `SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems` object.", + "properties": { + "end": { + "description": "The `items` `end`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "start": { + "description": "The `items` `start`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + }, + "request_headers": { + "additionalProperties": { + "type": "string" + }, + "description": "The `match_validation` `request_headers`.", + "type": "object" + }, + "timeout_seconds": { + "description": "The `match_validation` `timeout_seconds`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "type": { + "description": "The `match_validation` `type`.", + "type": "string" + }, + "valid_http_status_code": { + "description": "The `match_validation` `valid_http_status_code`.", + "items": { + "description": "The definition of `SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems` object.", + "properties": { + "end": { + "description": "The `items` `end`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "start": { + "description": "The `items` `start`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "name": { + "description": "The `attributes` `name`.", + "type": "string" + }, + "pattern": { + "description": "The `attributes` `pattern`.", + "type": "string" + }, + "priority": { + "description": "The `attributes` `priority`.", + "type": "string" + }, + "sds_id": { + "description": "The `attributes` `sds_id`.", + "type": "string" + }, + "validators": { + "description": "The `attributes` `validators`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "description": "The `SecretRuleData` `id`.", + "type": "string" + }, + "type": { + "default": "secret_rule", + "description": "Secret rule resource type.", + "enum": [ + "secret_rule" + ], + "example": "secret_rule", + "type": "string", + "x-enum-varnames": [ + "SECRET_RULE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "OK" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "AuthZ": [ + "code_analysis_read" + ] + }, + { + "apiKeyAuth": [], + "appKeyAuth": [] + } + ], + "summary": "Returns list of Secrets rules", + "tags": [ + "Security Monitoring" + ], + "x-menu-order": 28, + "x-undo": { + "type": "safe" + }, + "x-unstable": "**Note**: This endpoint may be subject to changes." + } + }, "/api/v2/synthetics/settings/on_demand_concurrency_cap": { "get": { "description": "Get the on-demand concurrency cap.", diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index 7e1a543d1c750..29db78947c832 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -2729,6 +2729,16 @@ "request_description": "", "request_schema_description": "The request for a spans list." }, + "ListMultipleRulesets": { + "description": "Get rules for multiple rulesets in batch.", + "summary": "Ruleset get multiple", + "request_description": "", + "request_schema_description": "The definition of `GetMultipleRulesetsRequest` object." + }, + "GetSecretsRules": { + "description": "Returns list of Secrets rules with ID, Pattern, Description, Priority, and SDS ID", + "summary": "Returns list of Secrets rules" + }, "GetOnDemandConcurrencyCap": { "description": "Get the on-demand concurrency cap.", "summary": "Get the on-demand concurrency cap" diff --git a/static/resources/json/full_spec_v2.json b/static/resources/json/full_spec_v2.json index 9d326ebb0795a..c134c4adcf015 100644 --- a/static/resources/json/full_spec_v2.json +++ b/static/resources/json/full_spec_v2.json @@ -128599,6 +128599,1379 @@ "TEAM_OWNERS" ] }, + "GetMultipleRulesetsRequest": { + "description": "The definition of `GetMultipleRulesetsRequest` object.", + "properties": { + "data": { + "description": "The definition of `GetMultipleRulesetsRequestData` object.", + "properties": { + "attributes": { + "description": "The definition of `GetMultipleRulesetsRequestDataAttributes` object.", + "properties": { + "include_testing_rules": { + "description": "The `attributes` `include_testing_rules`.", + "type": "boolean" + }, + "include_tests": { + "description": "The `attributes` `include_tests`.", + "type": "boolean" + }, + "rulesets": { + "description": "The `attributes` `rulesets`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "description": "The `GetMultipleRulesetsRequestData` `id`.", + "type": "string" + }, + "type": { + "default": "get_multiple_rulesets_request", + "description": "Get multiple rulesets request resource type.", + "enum": [ + "get_multiple_rulesets_request" + ], + "example": "get_multiple_rulesets_request", + "type": "string", + "x-enum-varnames": [ + "GET_MULTIPLE_RULESETS_REQUEST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "GetMultipleRulesetsRequestData": { + "description": "The definition of `GetMultipleRulesetsRequestData` object.", + "properties": { + "attributes": { + "description": "The definition of `GetMultipleRulesetsRequestDataAttributes` object.", + "properties": { + "include_testing_rules": { + "description": "The `attributes` `include_testing_rules`.", + "type": "boolean" + }, + "include_tests": { + "description": "The `attributes` `include_tests`.", + "type": "boolean" + }, + "rulesets": { + "description": "The `attributes` `rulesets`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "description": "The `GetMultipleRulesetsRequestData` `id`.", + "type": "string" + }, + "type": { + "default": "get_multiple_rulesets_request", + "description": "Get multiple rulesets request resource type.", + "enum": [ + "get_multiple_rulesets_request" + ], + "example": "get_multiple_rulesets_request", + "type": "string", + "x-enum-varnames": [ + "GET_MULTIPLE_RULESETS_REQUEST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "GetMultipleRulesetsRequestDataAttributes": { + "description": "The definition of `GetMultipleRulesetsRequestDataAttributes` object.", + "properties": { + "include_testing_rules": { + "description": "The `attributes` `include_testing_rules`.", + "type": "boolean" + }, + "include_tests": { + "description": "The `attributes` `include_tests`.", + "type": "boolean" + }, + "rulesets": { + "description": "The `attributes` `rulesets`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GetMultipleRulesetsRequestDataType": { + "default": "get_multiple_rulesets_request", + "description": "Get multiple rulesets request resource type.", + "enum": [ + "get_multiple_rulesets_request" + ], + "example": "get_multiple_rulesets_request", + "type": "string", + "x-enum-varnames": [ + "GET_MULTIPLE_RULESETS_REQUEST" + ] + }, + "GetMultipleRulesetsResponse": { + "description": "The definition of `GetMultipleRulesetsResponse` object.", + "properties": { + "data": { + "description": "The definition of `GetMultipleRulesetsResponseData` object.", + "properties": { + "attributes": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributes` object.", + "properties": { + "rulesets": { + "description": "The `attributes` `rulesets`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItems` object.", + "properties": { + "data": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsData` object.", + "properties": { + "id": { + "description": "The `data` `id`.", + "type": "string" + }, + "type": { + "default": "rulesets", + "description": "Rulesets resource type.", + "enum": [ + "rulesets" + ], + "example": "rulesets", + "type": "string", + "x-enum-varnames": [ + "RULESETS" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + }, + "rules": { + "description": "The `items` `rules`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems` object.", + "properties": { + "arguments": { + "description": "The `items` `arguments`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems` object.", + "properties": { + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "category": { + "description": "The `items` `category`.", + "type": "string" + }, + "checksum": { + "description": "The `items` `checksum`.", + "type": "string" + }, + "code": { + "description": "The `items` `code`.", + "type": "string" + }, + "created_at": { + "description": "The `items` `created_at`.", + "format": "date-time", + "type": "string" + }, + "created_by": { + "description": "The `items` `created_by`.", + "type": "string" + }, + "cve": { + "description": "The `items` `cve`.", + "type": "string" + }, + "cwe": { + "description": "The `items` `cwe`.", + "type": "string" + }, + "data": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData` object.", + "properties": { + "id": { + "description": "The `data` `id`.", + "type": "string" + }, + "type": { + "default": "rules", + "description": "Rules resource type.", + "enum": [ + "rules" + ], + "example": "rules", + "type": "string", + "x-enum-varnames": [ + "RULES" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "documentation_url": { + "description": "The `items` `documentation_url`.", + "type": "string" + }, + "entity_checked": { + "description": "The `items` `entity_checked`.", + "type": "string" + }, + "is_published": { + "description": "The `items` `is_published`.", + "type": "boolean" + }, + "is_testing": { + "description": "The `items` `is_testing`.", + "type": "boolean" + }, + "language": { + "description": "The `items` `language`.", + "type": "string" + }, + "last_updated_at": { + "description": "The `items` `last_updated_at`.", + "format": "date-time", + "type": "string" + }, + "last_updated_by": { + "description": "The `items` `last_updated_by`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + }, + "regex": { + "description": "The `items` `regex`.", + "type": "string" + }, + "severity": { + "description": "The `items` `severity`.", + "type": "string" + }, + "short_description": { + "description": "The `items` `short_description`.", + "type": "string" + }, + "should_use_ai_fix": { + "description": "The `items` `should_use_ai_fix`.", + "type": "boolean" + }, + "tests": { + "description": "The `items` `tests`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems` object.", + "properties": { + "annotation_count": { + "description": "The `items` `annotation_count`.", + "format": "int64", + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "code": { + "description": "The `items` `code`.", + "type": "string" + }, + "filename": { + "description": "The `items` `filename`.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "tree_sitter_query": { + "description": "The `items` `tree_sitter_query`.", + "type": "string" + }, + "type": { + "description": "The `items` `type`.", + "type": "string" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "type": "array" + }, + "short_description": { + "description": "The `items` `short_description`.", + "type": "string" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "description": "The `GetMultipleRulesetsResponseData` `id`.", + "type": "string" + }, + "type": { + "default": "get_multiple_rulesets_response", + "description": "Get multiple rulesets response resource type.", + "enum": [ + "get_multiple_rulesets_response" + ], + "example": "get_multiple_rulesets_response", + "type": "string", + "x-enum-varnames": [ + "GET_MULTIPLE_RULESETS_RESPONSE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "GetMultipleRulesetsResponseData": { + "description": "The definition of `GetMultipleRulesetsResponseData` object.", + "properties": { + "attributes": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributes` object.", + "properties": { + "rulesets": { + "description": "The `attributes` `rulesets`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItems` object.", + "properties": { + "data": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsData` object.", + "properties": { + "id": { + "description": "The `data` `id`.", + "type": "string" + }, + "type": { + "default": "rulesets", + "description": "Rulesets resource type.", + "enum": [ + "rulesets" + ], + "example": "rulesets", + "type": "string", + "x-enum-varnames": [ + "RULESETS" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + }, + "rules": { + "description": "The `items` `rules`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems` object.", + "properties": { + "arguments": { + "description": "The `items` `arguments`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems` object.", + "properties": { + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "category": { + "description": "The `items` `category`.", + "type": "string" + }, + "checksum": { + "description": "The `items` `checksum`.", + "type": "string" + }, + "code": { + "description": "The `items` `code`.", + "type": "string" + }, + "created_at": { + "description": "The `items` `created_at`.", + "format": "date-time", + "type": "string" + }, + "created_by": { + "description": "The `items` `created_by`.", + "type": "string" + }, + "cve": { + "description": "The `items` `cve`.", + "type": "string" + }, + "cwe": { + "description": "The `items` `cwe`.", + "type": "string" + }, + "data": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData` object.", + "properties": { + "id": { + "description": "The `data` `id`.", + "type": "string" + }, + "type": { + "default": "rules", + "description": "Rules resource type.", + "enum": [ + "rules" + ], + "example": "rules", + "type": "string", + "x-enum-varnames": [ + "RULES" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "documentation_url": { + "description": "The `items` `documentation_url`.", + "type": "string" + }, + "entity_checked": { + "description": "The `items` `entity_checked`.", + "type": "string" + }, + "is_published": { + "description": "The `items` `is_published`.", + "type": "boolean" + }, + "is_testing": { + "description": "The `items` `is_testing`.", + "type": "boolean" + }, + "language": { + "description": "The `items` `language`.", + "type": "string" + }, + "last_updated_at": { + "description": "The `items` `last_updated_at`.", + "format": "date-time", + "type": "string" + }, + "last_updated_by": { + "description": "The `items` `last_updated_by`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + }, + "regex": { + "description": "The `items` `regex`.", + "type": "string" + }, + "severity": { + "description": "The `items` `severity`.", + "type": "string" + }, + "short_description": { + "description": "The `items` `short_description`.", + "type": "string" + }, + "should_use_ai_fix": { + "description": "The `items` `should_use_ai_fix`.", + "type": "boolean" + }, + "tests": { + "description": "The `items` `tests`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems` object.", + "properties": { + "annotation_count": { + "description": "The `items` `annotation_count`.", + "format": "int64", + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "code": { + "description": "The `items` `code`.", + "type": "string" + }, + "filename": { + "description": "The `items` `filename`.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "tree_sitter_query": { + "description": "The `items` `tree_sitter_query`.", + "type": "string" + }, + "type": { + "description": "The `items` `type`.", + "type": "string" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "type": "array" + }, + "short_description": { + "description": "The `items` `short_description`.", + "type": "string" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "description": "The `GetMultipleRulesetsResponseData` `id`.", + "type": "string" + }, + "type": { + "default": "get_multiple_rulesets_response", + "description": "Get multiple rulesets response resource type.", + "enum": [ + "get_multiple_rulesets_response" + ], + "example": "get_multiple_rulesets_response", + "type": "string", + "x-enum-varnames": [ + "GET_MULTIPLE_RULESETS_RESPONSE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "GetMultipleRulesetsResponseDataAttributes": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributes` object.", + "properties": { + "rulesets": { + "description": "The `attributes` `rulesets`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItems` object.", + "properties": { + "data": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsData` object.", + "properties": { + "id": { + "description": "The `data` `id`.", + "type": "string" + }, + "type": { + "default": "rulesets", + "description": "Rulesets resource type.", + "enum": [ + "rulesets" + ], + "example": "rulesets", + "type": "string", + "x-enum-varnames": [ + "RULESETS" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + }, + "rules": { + "description": "The `items` `rules`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems` object.", + "properties": { + "arguments": { + "description": "The `items` `arguments`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems` object.", + "properties": { + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "category": { + "description": "The `items` `category`.", + "type": "string" + }, + "checksum": { + "description": "The `items` `checksum`.", + "type": "string" + }, + "code": { + "description": "The `items` `code`.", + "type": "string" + }, + "created_at": { + "description": "The `items` `created_at`.", + "format": "date-time", + "type": "string" + }, + "created_by": { + "description": "The `items` `created_by`.", + "type": "string" + }, + "cve": { + "description": "The `items` `cve`.", + "type": "string" + }, + "cwe": { + "description": "The `items` `cwe`.", + "type": "string" + }, + "data": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData` object.", + "properties": { + "id": { + "description": "The `data` `id`.", + "type": "string" + }, + "type": { + "default": "rules", + "description": "Rules resource type.", + "enum": [ + "rules" + ], + "example": "rules", + "type": "string", + "x-enum-varnames": [ + "RULES" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "documentation_url": { + "description": "The `items` `documentation_url`.", + "type": "string" + }, + "entity_checked": { + "description": "The `items` `entity_checked`.", + "type": "string" + }, + "is_published": { + "description": "The `items` `is_published`.", + "type": "boolean" + }, + "is_testing": { + "description": "The `items` `is_testing`.", + "type": "boolean" + }, + "language": { + "description": "The `items` `language`.", + "type": "string" + }, + "last_updated_at": { + "description": "The `items` `last_updated_at`.", + "format": "date-time", + "type": "string" + }, + "last_updated_by": { + "description": "The `items` `last_updated_by`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + }, + "regex": { + "description": "The `items` `regex`.", + "type": "string" + }, + "severity": { + "description": "The `items` `severity`.", + "type": "string" + }, + "short_description": { + "description": "The `items` `short_description`.", + "type": "string" + }, + "should_use_ai_fix": { + "description": "The `items` `should_use_ai_fix`.", + "type": "boolean" + }, + "tests": { + "description": "The `items` `tests`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems` object.", + "properties": { + "annotation_count": { + "description": "The `items` `annotation_count`.", + "format": "int64", + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "code": { + "description": "The `items` `code`.", + "type": "string" + }, + "filename": { + "description": "The `items` `filename`.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "tree_sitter_query": { + "description": "The `items` `tree_sitter_query`.", + "type": "string" + }, + "type": { + "description": "The `items` `type`.", + "type": "string" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "type": "array" + }, + "short_description": { + "description": "The `items` `short_description`.", + "type": "string" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "GetMultipleRulesetsResponseDataAttributesRulesetsItems": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItems` object.", + "properties": { + "data": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsData` object.", + "properties": { + "id": { + "description": "The `data` `id`.", + "type": "string" + }, + "type": { + "default": "rulesets", + "description": "Rulesets resource type.", + "enum": [ + "rulesets" + ], + "example": "rulesets", + "type": "string", + "x-enum-varnames": [ + "RULESETS" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + }, + "rules": { + "description": "The `items` `rules`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems` object.", + "properties": { + "arguments": { + "description": "The `items` `arguments`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems` object.", + "properties": { + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "category": { + "description": "The `items` `category`.", + "type": "string" + }, + "checksum": { + "description": "The `items` `checksum`.", + "type": "string" + }, + "code": { + "description": "The `items` `code`.", + "type": "string" + }, + "created_at": { + "description": "The `items` `created_at`.", + "format": "date-time", + "type": "string" + }, + "created_by": { + "description": "The `items` `created_by`.", + "type": "string" + }, + "cve": { + "description": "The `items` `cve`.", + "type": "string" + }, + "cwe": { + "description": "The `items` `cwe`.", + "type": "string" + }, + "data": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData` object.", + "properties": { + "id": { + "description": "The `data` `id`.", + "type": "string" + }, + "type": { + "default": "rules", + "description": "Rules resource type.", + "enum": [ + "rules" + ], + "example": "rules", + "type": "string", + "x-enum-varnames": [ + "RULES" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "documentation_url": { + "description": "The `items` `documentation_url`.", + "type": "string" + }, + "entity_checked": { + "description": "The `items` `entity_checked`.", + "type": "string" + }, + "is_published": { + "description": "The `items` `is_published`.", + "type": "boolean" + }, + "is_testing": { + "description": "The `items` `is_testing`.", + "type": "boolean" + }, + "language": { + "description": "The `items` `language`.", + "type": "string" + }, + "last_updated_at": { + "description": "The `items` `last_updated_at`.", + "format": "date-time", + "type": "string" + }, + "last_updated_by": { + "description": "The `items` `last_updated_by`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + }, + "regex": { + "description": "The `items` `regex`.", + "type": "string" + }, + "severity": { + "description": "The `items` `severity`.", + "type": "string" + }, + "short_description": { + "description": "The `items` `short_description`.", + "type": "string" + }, + "should_use_ai_fix": { + "description": "The `items` `should_use_ai_fix`.", + "type": "boolean" + }, + "tests": { + "description": "The `items` `tests`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems` object.", + "properties": { + "annotation_count": { + "description": "The `items` `annotation_count`.", + "format": "int64", + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "code": { + "description": "The `items` `code`.", + "type": "string" + }, + "filename": { + "description": "The `items` `filename`.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "tree_sitter_query": { + "description": "The `items` `tree_sitter_query`.", + "type": "string" + }, + "type": { + "description": "The `items` `type`.", + "type": "string" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "type": "array" + }, + "short_description": { + "description": "The `items` `short_description`.", + "type": "string" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "GetMultipleRulesetsResponseDataAttributesRulesetsItemsData": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsData` object.", + "properties": { + "id": { + "description": "The `data` `id`.", + "type": "string" + }, + "type": { + "default": "rulesets", + "description": "Rulesets resource type.", + "enum": [ + "rulesets" + ], + "example": "rulesets", + "type": "string", + "x-enum-varnames": [ + "RULESETS" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "GetMultipleRulesetsResponseDataAttributesRulesetsItemsDataType": { + "default": "rulesets", + "description": "Rulesets resource type.", + "enum": [ + "rulesets" + ], + "example": "rulesets", + "type": "string", + "x-enum-varnames": [ + "RULESETS" + ] + }, + "GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems` object.", + "properties": { + "arguments": { + "description": "The `items` `arguments`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems` object.", + "properties": { + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "category": { + "description": "The `items` `category`.", + "type": "string" + }, + "checksum": { + "description": "The `items` `checksum`.", + "type": "string" + }, + "code": { + "description": "The `items` `code`.", + "type": "string" + }, + "created_at": { + "description": "The `items` `created_at`.", + "format": "date-time", + "type": "string" + }, + "created_by": { + "description": "The `items` `created_by`.", + "type": "string" + }, + "cve": { + "description": "The `items` `cve`.", + "type": "string" + }, + "cwe": { + "description": "The `items` `cwe`.", + "type": "string" + }, + "data": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData` object.", + "properties": { + "id": { + "description": "The `data` `id`.", + "type": "string" + }, + "type": { + "default": "rules", + "description": "Rules resource type.", + "enum": [ + "rules" + ], + "example": "rules", + "type": "string", + "x-enum-varnames": [ + "RULES" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "documentation_url": { + "description": "The `items` `documentation_url`.", + "type": "string" + }, + "entity_checked": { + "description": "The `items` `entity_checked`.", + "type": "string" + }, + "is_published": { + "description": "The `items` `is_published`.", + "type": "boolean" + }, + "is_testing": { + "description": "The `items` `is_testing`.", + "type": "boolean" + }, + "language": { + "description": "The `items` `language`.", + "type": "string" + }, + "last_updated_at": { + "description": "The `items` `last_updated_at`.", + "format": "date-time", + "type": "string" + }, + "last_updated_by": { + "description": "The `items` `last_updated_by`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + }, + "regex": { + "description": "The `items` `regex`.", + "type": "string" + }, + "severity": { + "description": "The `items` `severity`.", + "type": "string" + }, + "short_description": { + "description": "The `items` `short_description`.", + "type": "string" + }, + "should_use_ai_fix": { + "description": "The `items` `should_use_ai_fix`.", + "type": "boolean" + }, + "tests": { + "description": "The `items` `tests`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems` object.", + "properties": { + "annotation_count": { + "description": "The `items` `annotation_count`.", + "format": "int64", + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "code": { + "description": "The `items` `code`.", + "type": "string" + }, + "filename": { + "description": "The `items` `filename`.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "tree_sitter_query": { + "description": "The `items` `tree_sitter_query`.", + "type": "string" + }, + "type": { + "description": "The `items` `type`.", + "type": "string" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems` object.", + "properties": { + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + } + }, + "type": "object" + }, + "GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData` object.", + "properties": { + "id": { + "description": "The `data` `id`.", + "type": "string" + }, + "type": { + "default": "rules", + "description": "Rules resource type.", + "enum": [ + "rules" + ], + "example": "rules", + "type": "string", + "x-enum-varnames": [ + "RULES" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsDataType": { + "default": "rules", + "description": "Rules resource type.", + "enum": [ + "rules" + ], + "example": "rules", + "type": "string", + "x-enum-varnames": [ + "RULES" + ] + }, + "GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems` object.", + "properties": { + "annotation_count": { + "description": "The `items` `annotation_count`.", + "format": "int64", + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "code": { + "description": "The `items` `code`.", + "type": "string" + }, + "filename": { + "description": "The `items` `filename`.", + "type": "string" + } + }, + "type": "object" + }, + "GetMultipleRulesetsResponseDataType": { + "default": "get_multiple_rulesets_response", + "description": "Get multiple rulesets response resource type.", + "enum": [ + "get_multiple_rulesets_response" + ], + "example": "get_multiple_rulesets_response", + "type": "string", + "x-enum-varnames": [ + "GET_MULTIPLE_RULESETS_RESPONSE" + ] + }, "GetResourceEvaluationFiltersResponse": { "description": "The definition of `GetResourceEvaluationFiltersResponse` object.", "properties": { @@ -300417,6 +301790,601 @@ "ISSUE_TEAM_OWNERS" ] }, + "SecretRuleArray": { + "description": "The definition of `SecretRuleArray` object.", + "properties": { + "data": { + "description": "The `SecretRuleArray` `data`.", + "items": { + "description": "The definition of `SecretRuleData` object.", + "properties": { + "attributes": { + "description": "The definition of `SecretRuleDataAttributes` object.", + "properties": { + "default_included_keywords": { + "description": "The `attributes` `default_included_keywords`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "description": { + "description": "The `attributes` `description`.", + "type": "string" + }, + "license": { + "description": "The `attributes` `license`.", + "type": "string" + }, + "match_validation": { + "description": "The definition of `SecretRuleDataAttributesMatchValidation` object.", + "properties": { + "endpoint": { + "description": "The `match_validation` `endpoint`.", + "type": "string" + }, + "hosts": { + "description": "The `match_validation` `hosts`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "http_method": { + "description": "The `match_validation` `http_method`.", + "type": "string" + }, + "invalid_http_status_code": { + "description": "The `match_validation` `invalid_http_status_code`.", + "items": { + "description": "The definition of `SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems` object.", + "properties": { + "end": { + "description": "The `items` `end`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "start": { + "description": "The `items` `start`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + }, + "request_headers": { + "additionalProperties": { + "type": "string" + }, + "description": "The `match_validation` `request_headers`.", + "type": "object" + }, + "timeout_seconds": { + "description": "The `match_validation` `timeout_seconds`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "type": { + "description": "The `match_validation` `type`.", + "type": "string" + }, + "valid_http_status_code": { + "description": "The `match_validation` `valid_http_status_code`.", + "items": { + "description": "The definition of `SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems` object.", + "properties": { + "end": { + "description": "The `items` `end`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "start": { + "description": "The `items` `start`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "name": { + "description": "The `attributes` `name`.", + "type": "string" + }, + "pattern": { + "description": "The `attributes` `pattern`.", + "type": "string" + }, + "priority": { + "description": "The `attributes` `priority`.", + "type": "string" + }, + "sds_id": { + "description": "The `attributes` `sds_id`.", + "type": "string" + }, + "validators": { + "description": "The `attributes` `validators`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "description": "The `SecretRuleData` `id`.", + "type": "string" + }, + "type": { + "default": "secret_rule", + "description": "Secret rule resource type.", + "enum": [ + "secret_rule" + ], + "example": "secret_rule", + "type": "string", + "x-enum-varnames": [ + "SECRET_RULE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "SecretRuleData": { + "description": "The definition of `SecretRuleData` object.", + "properties": { + "attributes": { + "description": "The definition of `SecretRuleDataAttributes` object.", + "properties": { + "default_included_keywords": { + "description": "The `attributes` `default_included_keywords`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "description": { + "description": "The `attributes` `description`.", + "type": "string" + }, + "license": { + "description": "The `attributes` `license`.", + "type": "string" + }, + "match_validation": { + "description": "The definition of `SecretRuleDataAttributesMatchValidation` object.", + "properties": { + "endpoint": { + "description": "The `match_validation` `endpoint`.", + "type": "string" + }, + "hosts": { + "description": "The `match_validation` `hosts`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "http_method": { + "description": "The `match_validation` `http_method`.", + "type": "string" + }, + "invalid_http_status_code": { + "description": "The `match_validation` `invalid_http_status_code`.", + "items": { + "description": "The definition of `SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems` object.", + "properties": { + "end": { + "description": "The `items` `end`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "start": { + "description": "The `items` `start`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + }, + "request_headers": { + "additionalProperties": { + "type": "string" + }, + "description": "The `match_validation` `request_headers`.", + "type": "object" + }, + "timeout_seconds": { + "description": "The `match_validation` `timeout_seconds`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "type": { + "description": "The `match_validation` `type`.", + "type": "string" + }, + "valid_http_status_code": { + "description": "The `match_validation` `valid_http_status_code`.", + "items": { + "description": "The definition of `SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems` object.", + "properties": { + "end": { + "description": "The `items` `end`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "start": { + "description": "The `items` `start`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "name": { + "description": "The `attributes` `name`.", + "type": "string" + }, + "pattern": { + "description": "The `attributes` `pattern`.", + "type": "string" + }, + "priority": { + "description": "The `attributes` `priority`.", + "type": "string" + }, + "sds_id": { + "description": "The `attributes` `sds_id`.", + "type": "string" + }, + "validators": { + "description": "The `attributes` `validators`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "description": "The `SecretRuleData` `id`.", + "type": "string" + }, + "type": { + "default": "secret_rule", + "description": "Secret rule resource type.", + "enum": [ + "secret_rule" + ], + "example": "secret_rule", + "type": "string", + "x-enum-varnames": [ + "SECRET_RULE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "SecretRuleDataAttributes": { + "description": "The definition of `SecretRuleDataAttributes` object.", + "properties": { + "default_included_keywords": { + "description": "The `attributes` `default_included_keywords`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "description": { + "description": "The `attributes` `description`.", + "type": "string" + }, + "license": { + "description": "The `attributes` `license`.", + "type": "string" + }, + "match_validation": { + "description": "The definition of `SecretRuleDataAttributesMatchValidation` object.", + "properties": { + "endpoint": { + "description": "The `match_validation` `endpoint`.", + "type": "string" + }, + "hosts": { + "description": "The `match_validation` `hosts`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "http_method": { + "description": "The `match_validation` `http_method`.", + "type": "string" + }, + "invalid_http_status_code": { + "description": "The `match_validation` `invalid_http_status_code`.", + "items": { + "description": "The definition of `SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems` object.", + "properties": { + "end": { + "description": "The `items` `end`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "start": { + "description": "The `items` `start`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + }, + "request_headers": { + "additionalProperties": { + "type": "string" + }, + "description": "The `match_validation` `request_headers`.", + "type": "object" + }, + "timeout_seconds": { + "description": "The `match_validation` `timeout_seconds`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "type": { + "description": "The `match_validation` `type`.", + "type": "string" + }, + "valid_http_status_code": { + "description": "The `match_validation` `valid_http_status_code`.", + "items": { + "description": "The definition of `SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems` object.", + "properties": { + "end": { + "description": "The `items` `end`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "start": { + "description": "The `items` `start`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "name": { + "description": "The `attributes` `name`.", + "type": "string" + }, + "pattern": { + "description": "The `attributes` `pattern`.", + "type": "string" + }, + "priority": { + "description": "The `attributes` `priority`.", + "type": "string" + }, + "sds_id": { + "description": "The `attributes` `sds_id`.", + "type": "string" + }, + "validators": { + "description": "The `attributes` `validators`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "SecretRuleDataAttributesMatchValidation": { + "description": "The definition of `SecretRuleDataAttributesMatchValidation` object.", + "properties": { + "endpoint": { + "description": "The `match_validation` `endpoint`.", + "type": "string" + }, + "hosts": { + "description": "The `match_validation` `hosts`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "http_method": { + "description": "The `match_validation` `http_method`.", + "type": "string" + }, + "invalid_http_status_code": { + "description": "The `match_validation` `invalid_http_status_code`.", + "items": { + "description": "The definition of `SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems` object.", + "properties": { + "end": { + "description": "The `items` `end`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "start": { + "description": "The `items` `start`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + }, + "request_headers": { + "additionalProperties": { + "type": "string" + }, + "description": "The `match_validation` `request_headers`.", + "type": "object" + }, + "timeout_seconds": { + "description": "The `match_validation` `timeout_seconds`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "type": { + "description": "The `match_validation` `type`.", + "type": "string" + }, + "valid_http_status_code": { + "description": "The `match_validation` `valid_http_status_code`.", + "items": { + "description": "The definition of `SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems` object.", + "properties": { + "end": { + "description": "The `items` `end`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "start": { + "description": "The `items` `start`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems": { + "description": "The definition of `SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems` object.", + "properties": { + "end": { + "description": "The `items` `end`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "start": { + "description": "The `items` `start`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems": { + "description": "The definition of `SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems` object.", + "properties": { + "end": { + "description": "The `items` `end`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "start": { + "description": "The `items` `start`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "SecretRuleDataType": { + "default": "secret_rule", + "description": "Secret rule resource type.", + "enum": [ + "secret_rule" + ], + "example": "secret_rule", + "type": "string", + "x-enum-varnames": [ + "SECRET_RULE" + ] + }, "SecurityFilter": { "description": "The security filter's properties.", "properties": { @@ -686810,6 +688778,620 @@ } } }, + "/api/v2/static-analysis/rulesets": { + "post": { + "description": "Get rules for multiple rulesets in batch.", + "operationId": "ListMultipleRulesets", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "The definition of `GetMultipleRulesetsRequest` object.", + "properties": { + "data": { + "description": "The definition of `GetMultipleRulesetsRequestData` object.", + "properties": { + "attributes": { + "description": "The definition of `GetMultipleRulesetsRequestDataAttributes` object.", + "properties": { + "include_testing_rules": { + "description": "The `attributes` `include_testing_rules`.", + "type": "boolean" + }, + "include_tests": { + "description": "The `attributes` `include_tests`.", + "type": "boolean" + }, + "rulesets": { + "description": "The `attributes` `rulesets`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "description": "The `GetMultipleRulesetsRequestData` `id`.", + "type": "string" + }, + "type": { + "default": "get_multiple_rulesets_request", + "description": "Get multiple rulesets request resource type.", + "enum": [ + "get_multiple_rulesets_request" + ], + "example": "get_multiple_rulesets_request", + "type": "string", + "x-enum-varnames": [ + "GET_MULTIPLE_RULESETS_REQUEST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "The definition of `GetMultipleRulesetsResponse` object.", + "properties": { + "data": { + "description": "The definition of `GetMultipleRulesetsResponseData` object.", + "properties": { + "attributes": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributes` object.", + "properties": { + "rulesets": { + "description": "The `attributes` `rulesets`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItems` object.", + "properties": { + "data": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsData` object.", + "properties": { + "id": { + "description": "The `data` `id`.", + "type": "string" + }, + "type": { + "default": "rulesets", + "description": "Rulesets resource type.", + "enum": [ + "rulesets" + ], + "example": "rulesets", + "type": "string", + "x-enum-varnames": [ + "RULESETS" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + }, + "rules": { + "description": "The `items` `rules`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems` object.", + "properties": { + "arguments": { + "description": "The `items` `arguments`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems` object.", + "properties": { + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "category": { + "description": "The `items` `category`.", + "type": "string" + }, + "checksum": { + "description": "The `items` `checksum`.", + "type": "string" + }, + "code": { + "description": "The `items` `code`.", + "type": "string" + }, + "created_at": { + "description": "The `items` `created_at`.", + "format": "date-time", + "type": "string" + }, + "created_by": { + "description": "The `items` `created_by`.", + "type": "string" + }, + "cve": { + "description": "The `items` `cve`.", + "type": "string" + }, + "cwe": { + "description": "The `items` `cwe`.", + "type": "string" + }, + "data": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData` object.", + "properties": { + "id": { + "description": "The `data` `id`.", + "type": "string" + }, + "type": { + "default": "rules", + "description": "Rules resource type.", + "enum": [ + "rules" + ], + "example": "rules", + "type": "string", + "x-enum-varnames": [ + "RULES" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "description": { + "description": "The `items` `description`.", + "type": "string" + }, + "documentation_url": { + "description": "The `items` `documentation_url`.", + "type": "string" + }, + "entity_checked": { + "description": "The `items` `entity_checked`.", + "type": "string" + }, + "is_published": { + "description": "The `items` `is_published`.", + "type": "boolean" + }, + "is_testing": { + "description": "The `items` `is_testing`.", + "type": "boolean" + }, + "language": { + "description": "The `items` `language`.", + "type": "string" + }, + "last_updated_at": { + "description": "The `items` `last_updated_at`.", + "format": "date-time", + "type": "string" + }, + "last_updated_by": { + "description": "The `items` `last_updated_by`.", + "type": "string" + }, + "name": { + "description": "The `items` `name`.", + "type": "string" + }, + "regex": { + "description": "The `items` `regex`.", + "type": "string" + }, + "severity": { + "description": "The `items` `severity`.", + "type": "string" + }, + "short_description": { + "description": "The `items` `short_description`.", + "type": "string" + }, + "should_use_ai_fix": { + "description": "The `items` `should_use_ai_fix`.", + "type": "boolean" + }, + "tests": { + "description": "The `items` `tests`.", + "items": { + "description": "The definition of `GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems` object.", + "properties": { + "annotation_count": { + "description": "The `items` `annotation_count`.", + "format": "int64", + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "code": { + "description": "The `items` `code`.", + "type": "string" + }, + "filename": { + "description": "The `items` `filename`.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "tree_sitter_query": { + "description": "The `items` `tree_sitter_query`.", + "type": "string" + }, + "type": { + "description": "The `items` `type`.", + "type": "string" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "type": "array" + }, + "short_description": { + "description": "The `items` `short_description`.", + "type": "string" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "description": "The `GetMultipleRulesetsResponseData` `id`.", + "type": "string" + }, + "type": { + "default": "get_multiple_rulesets_response", + "description": "Get multiple rulesets response resource type.", + "enum": [ + "get_multiple_rulesets_response" + ], + "example": "get_multiple_rulesets_response", + "type": "string", + "x-enum-varnames": [ + "GET_MULTIPLE_RULESETS_RESPONSE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "AuthZ": [ + "code_analysis_read" + ] + }, + { + "apiKeyAuth": [], + "appKeyAuth": [] + } + ], + "summary": "Ruleset get multiple", + "tags": [ + "Security Monitoring" + ], + "x-menu-order": 28, + "x-undo": { + "operationId": "TODO", + "parameters": [], + "type": "unsafe" + }, + "x-unstable": "**Note**: This endpoint may be subject to changes." + } + }, + "/api/v2/static-analysis/secrets/rules": { + "get": { + "description": "Returns list of Secrets rules with ID, Pattern, Description, Priority, and SDS ID", + "operationId": "GetSecretsRules", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "The definition of `SecretRuleArray` object.", + "properties": { + "data": { + "description": "The `SecretRuleArray` `data`.", + "items": { + "description": "The definition of `SecretRuleData` object.", + "properties": { + "attributes": { + "description": "The definition of `SecretRuleDataAttributes` object.", + "properties": { + "default_included_keywords": { + "description": "The `attributes` `default_included_keywords`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "description": { + "description": "The `attributes` `description`.", + "type": "string" + }, + "license": { + "description": "The `attributes` `license`.", + "type": "string" + }, + "match_validation": { + "description": "The definition of `SecretRuleDataAttributesMatchValidation` object.", + "properties": { + "endpoint": { + "description": "The `match_validation` `endpoint`.", + "type": "string" + }, + "hosts": { + "description": "The `match_validation` `hosts`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "http_method": { + "description": "The `match_validation` `http_method`.", + "type": "string" + }, + "invalid_http_status_code": { + "description": "The `match_validation` `invalid_http_status_code`.", + "items": { + "description": "The definition of `SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems` object.", + "properties": { + "end": { + "description": "The `items` `end`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "start": { + "description": "The `items` `start`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + }, + "request_headers": { + "additionalProperties": { + "type": "string" + }, + "description": "The `match_validation` `request_headers`.", + "type": "object" + }, + "timeout_seconds": { + "description": "The `match_validation` `timeout_seconds`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "type": { + "description": "The `match_validation` `type`.", + "type": "string" + }, + "valid_http_status_code": { + "description": "The `match_validation` `valid_http_status_code`.", + "items": { + "description": "The definition of `SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems` object.", + "properties": { + "end": { + "description": "The `items` `end`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + }, + "start": { + "description": "The `items` `start`.", + "format": "int64", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "name": { + "description": "The `attributes` `name`.", + "type": "string" + }, + "pattern": { + "description": "The `attributes` `pattern`.", + "type": "string" + }, + "priority": { + "description": "The `attributes` `priority`.", + "type": "string" + }, + "sds_id": { + "description": "The `attributes` `sds_id`.", + "type": "string" + }, + "validators": { + "description": "The `attributes` `validators`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "description": "The `SecretRuleData` `id`.", + "type": "string" + }, + "type": { + "default": "secret_rule", + "description": "Secret rule resource type.", + "enum": [ + "secret_rule" + ], + "example": "secret_rule", + "type": "string", + "x-enum-varnames": [ + "SECRET_RULE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "OK" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "AuthZ": [ + "code_analysis_read" + ] + }, + { + "apiKeyAuth": [], + "appKeyAuth": [] + } + ], + "summary": "Returns list of Secrets rules", + "tags": [ + "Security Monitoring" + ], + "x-menu-order": 28, + "x-undo": { + "type": "safe" + }, + "x-unstable": "**Note**: This endpoint may be subject to changes." + } + }, "/api/v2/synthetics/settings/on_demand_concurrency_cap": { "get": { "description": "Get the on-demand concurrency cap.",