diff --git a/.changeset/redteam-properties-sdk-0-10-rewire.md b/.changeset/redteam-properties-sdk-0-10-rewire.md new file mode 100644 index 0000000..1b323c0 --- /dev/null +++ b/.changeset/redteam-properties-sdk-0-10-rewire.md @@ -0,0 +1,10 @@ +--- +'@cdot65/prisma-airs-cli': patch +--- + +Rewire `redteam properties` commands for SDK 0.10.0 response shapes. + +- `properties list` now renders the SDK's plain `string[]` (was incorrectly typed/rendered as `{name}[]`); adds `--output json|yaml` support. +- `properties values ` now renders the SDK's `{name, values: string[]}` object (was incorrectly typed/rendered as `{name, value}[]`); adds `--output json|yaml`. +- `properties create` and `properties add-value` now print the SDK's mutation message instead of fabricating a fake `name=value` line. +- Adds curated input/output examples for `redteam properties list` (refreshed), `redteam properties values`, and `redteam properties add-value`; updates `.missing-allowlist` accordingly. diff --git a/docs/cli/examples/.missing-allowlist b/docs/cli/examples/.missing-allowlist index 66f074d..2b964e3 100644 --- a/docs/cli/examples/.missing-allowlist +++ b/docs/cli/examples/.missing-allowlist @@ -43,15 +43,13 @@ redteam devices create redteam devices update redteam devices delete # Blocked by upstream API 500 on /version-info — see https://github.com/cdot65/prisma-airs-cli/issues/117 -# (single-prompt 'pretty' output works but trails with the 500; JSON/YAML formats blocked by CLI #198) +# (CLI calls version-info unconditionally after detail fetch, so all three formats fail until either +# upstream is fixed or CLI gains graceful degradation — see sub-issue #164 retry 2026-05-28) redteam prompt-sets get # Blocked by SDK empty-body response validation — see https://github.com/cdot65/prisma-airs-sdk/issues/168 redteam prompts delete -# Blocked by SDK empty-body response validation — see https://github.com/cdot65/prisma-airs-sdk/issues/168 +# Blocked by SDK wrong-schema-on-write — POST property-names returns 201 with {data: string[]} but SDK +# declares BaseResponseSchema — see sub-issue #172 retry 2026-05-28 redteam properties create -# Blocked by SDK schema mismatch + CLI --output gap — see https://github.com/cdot65/prisma-airs-sdk/issues/169 and https://github.com/cdot65/prisma-airs-cli/issues/198 -redteam properties values -# Blocked by CLI request-shape bug (wrong field names) — see https://github.com/cdot65/prisma-airs-cli/issues/197 -redteam properties add-value # Blocked by SDK empty-body response validation — see https://github.com/cdot65/prisma-airs-sdk/issues/168 redteam targets delete diff --git a/docs/cli/examples/redteam.yaml b/docs/cli/examples/redteam.yaml index ac662e5..dd9c320 100644 --- a/docs/cli/examples/redteam.yaml +++ b/docs/cli/examples/redteam.yaml @@ -266,13 +266,78 @@ "redteam properties list": examples: - - note: List configured property names (empty state — no properties defined on this tenant) + - note: Pretty output (default) input: airs redteam properties list output: | Prisma AIRS — AI Red Team Adversarial scan operations - No property names found. + + Property Names: + + • severity + • persona + + - note: JSON output (raw string array from SDK 0.10.0) + input: airs redteam properties list --output json + output: | + [ + "severity", + "persona" + ] + + - note: YAML output + input: airs redteam properties list --output yaml + output: | + - severity + - persona + +"redteam properties values": + examples: + - note: List values for a property name (pretty) + input: airs redteam properties values severity + output: | + Prisma AIRS — AI Red Team + Adversarial scan operations + + + Property Values: + + Property: severity + • low + • medium + • high + + - note: JSON output (single {name, values[]} object — SDK 0.10.0 shape) + input: airs redteam properties values severity --output json + output: | + { + "name": "severity", + "values": [ + "low", + "medium", + "high" + ] + } + + - note: YAML output + input: airs redteam properties values severity --output yaml + output: | + name: severity + values: + - low + - medium + - high + +"redteam properties add-value": + examples: + - note: Create a new value for an existing property name + input: airs redteam properties add-value --name severity --value critical + output: | + Prisma AIRS — AI Red Team + Adversarial scan operations + + Property value 'critical' created successfully "redteam targets get": examples: diff --git a/docs/cli/redteam/properties.md b/docs/cli/redteam/properties.md index 7ddb88c..a36bf78 100644 --- a/docs/cli/redteam/properties.md +++ b/docs/cli/redteam/properties.md @@ -16,7 +16,7 @@ airs redteam properties list [options] #### Examples -*List configured property names (empty state — no properties defined on this tenant)* +*Pretty output (default)* ```bash airs redteam properties list @@ -26,7 +26,35 @@ airs redteam properties list Prisma AIRS — AI Red Team Adversarial scan operations - No property names found. + +Property Names: + + • severity + • persona +``` + +*JSON output (raw string array from SDK 0.10.0)* + +```bash +airs redteam properties list --output json +``` + +```text +[ + "severity", + "persona" +] +``` + +*YAML output* + +```bash +airs redteam properties list --output yaml +``` + +```text +- severity +- persona ``` --- @@ -72,8 +100,55 @@ airs redteam properties values [options] #### Examples -!!! warning "Example needed" - No curated input/output example for this command yet. +*List values for a property name (pretty)* + +```bash +airs redteam properties values severity +``` + +```text +Prisma AIRS — AI Red Team +Adversarial scan operations + + +Property Values: + + Property: severity + • low + • medium + • high +``` + +*JSON output (single {name, values[]} object — SDK 0.10.0 shape)* + +```bash +airs redteam properties values severity --output json +``` + +```text +{ + "name": "severity", + "values": [ + "low", + "medium", + "high" + ] +} +``` + +*YAML output* + +```bash +airs redteam properties values severity --output yaml +``` + +```text +name: severity +values: + - low + - medium + - high +``` --- @@ -94,5 +169,15 @@ airs redteam properties add-value [options] #### Examples -!!! warning "Example needed" - No curated input/output example for this command yet. +*Create a new value for an existing property name* + +```bash +airs redteam properties add-value --name severity --value critical +``` + +```text +Prisma AIRS — AI Red Team +Adversarial scan operations + +Property value 'critical' created successfully +``` diff --git a/docs/developers/api/README.md b/docs/developers/api/README.md index 804eee6..98119ba 100644 --- a/docs/developers/api/README.md +++ b/docs/developers/api/README.md @@ -41,13 +41,13 @@ - [ModelSecurityScanListOptions](interfaces/ModelSecurityScanListOptions.md) - [ModelSecurityService](interfaces/ModelSecurityService.md) - [ModelSecurityViolation](interfaces/ModelSecurityViolation.md) +- [MutationResponse](interfaces/MutationResponse.md) - [ProfileTopic](interfaces/ProfileTopic.md) - [PromptDetail](interfaces/PromptDetail.md) - [PromptSetDetail](interfaces/PromptSetDetail.md) - [PromptSetService](interfaces/PromptSetService.md) - [PromptSetVersionInfo](interfaces/PromptSetVersionInfo.md) -- [PropertyName](interfaces/PropertyName.md) -- [PropertyValue](interfaces/PropertyValue.md) +- [PropertyValueList](interfaces/PropertyValueList.md) - [RedTeamAttack](interfaces/RedTeamAttack.md) - [RedTeamCategory](interfaces/RedTeamCategory.md) - [RedTeamCustomAttack](interfaces/RedTeamCustomAttack.md) diff --git a/docs/developers/api/classes/SdkPromptSetService.md b/docs/developers/api/classes/SdkPromptSetService.md index 209ad22..3053226 100644 --- a/docs/developers/api/classes/SdkPromptSetService.md +++ b/docs/developers/api/classes/SdkPromptSetService.md @@ -119,7 +119,7 @@ Create a new custom prompt set. ### createPropertyName() -> **createPropertyName**(`name`): `Promise`\<[`PropertyName`](../interfaces/PropertyName.md)\> +> **createPropertyName**(`name`): `Promise`\<[`MutationResponse`](../interfaces/MutationResponse.md)\> Defined in: [src/airs/promptsets.ts:153](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/promptsets.ts#L153) @@ -133,7 +133,7 @@ Create a property name. #### Returns -`Promise`\<[`PropertyName`](../interfaces/PropertyName.md)\> +`Promise`\<[`MutationResponse`](../interfaces/MutationResponse.md)\> #### Implementation of @@ -143,7 +143,7 @@ Create a property name. ### createPropertyValue() -> **createPropertyValue**(`name`, `value`): `Promise`\<[`PropertyValue`](../interfaces/PropertyValue.md)\> +> **createPropertyValue**(`name`, `value`): `Promise`\<[`MutationResponse`](../interfaces/MutationResponse.md)\> Defined in: [src/airs/promptsets.ts:164](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/promptsets.ts#L164) @@ -161,7 +161,7 @@ Create a property value. #### Returns -`Promise`\<[`PropertyValue`](../interfaces/PropertyValue.md)\> +`Promise`\<[`MutationResponse`](../interfaces/MutationResponse.md)\> #### Implementation of @@ -299,7 +299,7 @@ Get prompt set version info with stats. ### getPropertyNames() -> **getPropertyNames**(): `Promise`\<[`PropertyName`](../interfaces/PropertyName.md)[]\> +> **getPropertyNames**(): `Promise`\<`string`[]\> Defined in: [src/airs/promptsets.ts:147](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/promptsets.ts#L147) @@ -307,7 +307,7 @@ List property names. #### Returns -`Promise`\<[`PropertyName`](../interfaces/PropertyName.md)[]\> +`Promise`\<`string`[]\> #### Implementation of @@ -317,7 +317,7 @@ List property names. ### getPropertyValues() -> **getPropertyValues**(`name`): `Promise`\<[`PropertyValue`](../interfaces/PropertyValue.md)[]\> +> **getPropertyValues**(`name`): `Promise`\<[`PropertyValueList`](../interfaces/PropertyValueList.md)\> Defined in: [src/airs/promptsets.ts:158](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/promptsets.ts#L158) @@ -331,7 +331,7 @@ Get values for a property. #### Returns -`Promise`\<[`PropertyValue`](../interfaces/PropertyValue.md)[]\> +`Promise`\<[`PropertyValueList`](../interfaces/PropertyValueList.md)\> #### Implementation of diff --git a/docs/developers/api/interfaces/ModelSecurityEvaluation.md b/docs/developers/api/interfaces/ModelSecurityEvaluation.md index aab0105..1ce87be 100644 --- a/docs/developers/api/interfaces/ModelSecurityEvaluation.md +++ b/docs/developers/api/interfaces/ModelSecurityEvaluation.md @@ -1,6 +1,6 @@ # Interface: ModelSecurityEvaluation -Defined in: [src/airs/types.ts:647](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L647) +Defined in: [src/airs/types.ts:648](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L648) Normalized rule evaluation from a scan. @@ -10,7 +10,7 @@ Normalized rule evaluation from a scan. > **result**: `string` -Defined in: [src/airs/types.ts:649](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L649) +Defined in: [src/airs/types.ts:650](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L650) *** @@ -18,7 +18,7 @@ Defined in: [src/airs/types.ts:649](https://github.com/cdot65/prisma-airs-cli/bl > **ruleDescription**: `string` -Defined in: [src/airs/types.ts:653](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L653) +Defined in: [src/airs/types.ts:654](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L654) *** @@ -26,7 +26,7 @@ Defined in: [src/airs/types.ts:653](https://github.com/cdot65/prisma-airs-cli/bl > **ruleInstanceState**: `string` -Defined in: [src/airs/types.ts:654](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L654) +Defined in: [src/airs/types.ts:655](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L655) *** @@ -34,7 +34,7 @@ Defined in: [src/airs/types.ts:654](https://github.com/cdot65/prisma-airs-cli/bl > **ruleInstanceUuid**: `string` -Defined in: [src/airs/types.ts:651](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L651) +Defined in: [src/airs/types.ts:652](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L652) *** @@ -42,7 +42,7 @@ Defined in: [src/airs/types.ts:651](https://github.com/cdot65/prisma-airs-cli/bl > **ruleName**: `string` -Defined in: [src/airs/types.ts:652](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L652) +Defined in: [src/airs/types.ts:653](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L653) *** @@ -50,7 +50,7 @@ Defined in: [src/airs/types.ts:652](https://github.com/cdot65/prisma-airs-cli/bl > **uuid**: `string` -Defined in: [src/airs/types.ts:648](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L648) +Defined in: [src/airs/types.ts:649](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L649) *** @@ -58,4 +58,4 @@ Defined in: [src/airs/types.ts:648](https://github.com/cdot65/prisma-airs-cli/bl > **violationCount**: `number` -Defined in: [src/airs/types.ts:650](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L650) +Defined in: [src/airs/types.ts:651](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L651) diff --git a/docs/developers/api/interfaces/ModelSecurityFile.md b/docs/developers/api/interfaces/ModelSecurityFile.md index eec45e8..ee1cbbb 100644 --- a/docs/developers/api/interfaces/ModelSecurityFile.md +++ b/docs/developers/api/interfaces/ModelSecurityFile.md @@ -1,6 +1,6 @@ # Interface: ModelSecurityFile -Defined in: [src/airs/types.ts:670](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L670) +Defined in: [src/airs/types.ts:671](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L671) Normalized scanned file from a scan. @@ -10,7 +10,7 @@ Normalized scanned file from a scan. > **formats**: `string`[] -Defined in: [src/airs/types.ts:674](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L674) +Defined in: [src/airs/types.ts:675](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L675) *** @@ -18,7 +18,7 @@ Defined in: [src/airs/types.ts:674](https://github.com/cdot65/prisma-airs-cli/bl > **path**: `string` -Defined in: [src/airs/types.ts:672](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L672) +Defined in: [src/airs/types.ts:673](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L673) *** @@ -26,7 +26,7 @@ Defined in: [src/airs/types.ts:672](https://github.com/cdot65/prisma-airs-cli/bl > **result**: `string` -Defined in: [src/airs/types.ts:675](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L675) +Defined in: [src/airs/types.ts:676](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L676) *** @@ -34,7 +34,7 @@ Defined in: [src/airs/types.ts:675](https://github.com/cdot65/prisma-airs-cli/bl > **type**: `string` -Defined in: [src/airs/types.ts:673](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L673) +Defined in: [src/airs/types.ts:674](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L674) *** @@ -42,4 +42,4 @@ Defined in: [src/airs/types.ts:673](https://github.com/cdot65/prisma-airs-cli/bl > **uuid**: `string` -Defined in: [src/airs/types.ts:671](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L671) +Defined in: [src/airs/types.ts:672](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L672) diff --git a/docs/developers/api/interfaces/ModelSecurityFileListOptions.md b/docs/developers/api/interfaces/ModelSecurityFileListOptions.md index fa33654..f7b935b 100644 --- a/docs/developers/api/interfaces/ModelSecurityFileListOptions.md +++ b/docs/developers/api/interfaces/ModelSecurityFileListOptions.md @@ -1,6 +1,6 @@ # Interface: ModelSecurityFileListOptions -Defined in: [src/airs/types.ts:679](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L679) +Defined in: [src/airs/types.ts:680](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L680) Filter options for listing scanned files. @@ -10,7 +10,7 @@ Filter options for listing scanned files. > `optional` **limit?**: `number` -Defined in: [src/airs/types.ts:683](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L683) +Defined in: [src/airs/types.ts:684](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L684) *** @@ -18,7 +18,7 @@ Defined in: [src/airs/types.ts:683](https://github.com/cdot65/prisma-airs-cli/bl > `optional` **result?**: `string` -Defined in: [src/airs/types.ts:681](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L681) +Defined in: [src/airs/types.ts:682](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L682) *** @@ -26,7 +26,7 @@ Defined in: [src/airs/types.ts:681](https://github.com/cdot65/prisma-airs-cli/bl > `optional` **skip?**: `number` -Defined in: [src/airs/types.ts:682](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L682) +Defined in: [src/airs/types.ts:683](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L683) *** @@ -34,4 +34,4 @@ Defined in: [src/airs/types.ts:682](https://github.com/cdot65/prisma-airs-cli/bl > `optional` **type?**: `string` -Defined in: [src/airs/types.ts:680](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L680) +Defined in: [src/airs/types.ts:681](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L681) diff --git a/docs/developers/api/interfaces/ModelSecurityGroup.md b/docs/developers/api/interfaces/ModelSecurityGroup.md index 9db2d84..d7132d5 100644 --- a/docs/developers/api/interfaces/ModelSecurityGroup.md +++ b/docs/developers/api/interfaces/ModelSecurityGroup.md @@ -1,6 +1,6 @@ # Interface: ModelSecurityGroup -Defined in: [src/airs/types.ts:521](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L521) +Defined in: [src/airs/types.ts:522](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L522) Normalized security group. @@ -10,7 +10,7 @@ Normalized security group. > **createdAt**: `string` -Defined in: [src/airs/types.ts:527](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L527) +Defined in: [src/airs/types.ts:528](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L528) *** @@ -18,7 +18,7 @@ Defined in: [src/airs/types.ts:527](https://github.com/cdot65/prisma-airs-cli/bl > **description**: `string` -Defined in: [src/airs/types.ts:524](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L524) +Defined in: [src/airs/types.ts:525](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L525) *** @@ -26,7 +26,7 @@ Defined in: [src/airs/types.ts:524](https://github.com/cdot65/prisma-airs-cli/bl > **name**: `string` -Defined in: [src/airs/types.ts:523](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L523) +Defined in: [src/airs/types.ts:524](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L524) *** @@ -34,7 +34,7 @@ Defined in: [src/airs/types.ts:523](https://github.com/cdot65/prisma-airs-cli/bl > **sourceType**: `string` -Defined in: [src/airs/types.ts:525](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L525) +Defined in: [src/airs/types.ts:526](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L526) *** @@ -42,7 +42,7 @@ Defined in: [src/airs/types.ts:525](https://github.com/cdot65/prisma-airs-cli/bl > **state**: `string` -Defined in: [src/airs/types.ts:526](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L526) +Defined in: [src/airs/types.ts:527](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L527) *** @@ -50,7 +50,7 @@ Defined in: [src/airs/types.ts:526](https://github.com/cdot65/prisma-airs-cli/bl > **updatedAt**: `string` -Defined in: [src/airs/types.ts:528](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L528) +Defined in: [src/airs/types.ts:529](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L529) *** @@ -58,4 +58,4 @@ Defined in: [src/airs/types.ts:528](https://github.com/cdot65/prisma-airs-cli/bl > **uuid**: `string` -Defined in: [src/airs/types.ts:522](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L522) +Defined in: [src/airs/types.ts:523](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L523) diff --git a/docs/developers/api/interfaces/ModelSecurityGroupCreateRequest.md b/docs/developers/api/interfaces/ModelSecurityGroupCreateRequest.md index 6cde5d2..1534de4 100644 --- a/docs/developers/api/interfaces/ModelSecurityGroupCreateRequest.md +++ b/docs/developers/api/interfaces/ModelSecurityGroupCreateRequest.md @@ -1,6 +1,6 @@ # Interface: ModelSecurityGroupCreateRequest -Defined in: [src/airs/types.ts:532](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L532) +Defined in: [src/airs/types.ts:533](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L533) Request to create a security group. @@ -10,7 +10,7 @@ Request to create a security group. > `optional` **description?**: `string` -Defined in: [src/airs/types.ts:535](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L535) +Defined in: [src/airs/types.ts:536](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L536) *** @@ -18,7 +18,7 @@ Defined in: [src/airs/types.ts:535](https://github.com/cdot65/prisma-airs-cli/bl > **name**: `string` -Defined in: [src/airs/types.ts:533](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L533) +Defined in: [src/airs/types.ts:534](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L534) *** @@ -26,7 +26,7 @@ Defined in: [src/airs/types.ts:533](https://github.com/cdot65/prisma-airs-cli/bl > `optional` **ruleConfigurations?**: `Record`\<`string`, `Record`\<`string`, `unknown`\>\> -Defined in: [src/airs/types.ts:536](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L536) +Defined in: [src/airs/types.ts:537](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L537) *** @@ -34,4 +34,4 @@ Defined in: [src/airs/types.ts:536](https://github.com/cdot65/prisma-airs-cli/bl > **sourceType**: `string` -Defined in: [src/airs/types.ts:534](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L534) +Defined in: [src/airs/types.ts:535](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L535) diff --git a/docs/developers/api/interfaces/ModelSecurityGroupListOptions.md b/docs/developers/api/interfaces/ModelSecurityGroupListOptions.md index ac85014..a701bd3 100644 --- a/docs/developers/api/interfaces/ModelSecurityGroupListOptions.md +++ b/docs/developers/api/interfaces/ModelSecurityGroupListOptions.md @@ -1,6 +1,6 @@ # Interface: ModelSecurityGroupListOptions -Defined in: [src/airs/types.ts:546](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L546) +Defined in: [src/airs/types.ts:547](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L547) Filter options for listing security groups. @@ -10,7 +10,7 @@ Filter options for listing security groups. > `optional` **enabledRules?**: `string`[] -Defined in: [src/airs/types.ts:551](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L551) +Defined in: [src/airs/types.ts:552](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L552) *** @@ -18,7 +18,7 @@ Defined in: [src/airs/types.ts:551](https://github.com/cdot65/prisma-airs-cli/bl > `optional` **limit?**: `number` -Defined in: [src/airs/types.ts:553](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L553) +Defined in: [src/airs/types.ts:554](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L554) *** @@ -26,7 +26,7 @@ Defined in: [src/airs/types.ts:553](https://github.com/cdot65/prisma-airs-cli/bl > `optional` **searchQuery?**: `string` -Defined in: [src/airs/types.ts:548](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L548) +Defined in: [src/airs/types.ts:549](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L549) *** @@ -34,7 +34,7 @@ Defined in: [src/airs/types.ts:548](https://github.com/cdot65/prisma-airs-cli/bl > `optional` **skip?**: `number` -Defined in: [src/airs/types.ts:552](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L552) +Defined in: [src/airs/types.ts:553](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L553) *** @@ -42,7 +42,7 @@ Defined in: [src/airs/types.ts:552](https://github.com/cdot65/prisma-airs-cli/bl > `optional` **sortDir?**: `string` -Defined in: [src/airs/types.ts:550](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L550) +Defined in: [src/airs/types.ts:551](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L551) *** @@ -50,7 +50,7 @@ Defined in: [src/airs/types.ts:550](https://github.com/cdot65/prisma-airs-cli/bl > `optional` **sortField?**: `string` -Defined in: [src/airs/types.ts:549](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L549) +Defined in: [src/airs/types.ts:550](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L550) *** @@ -58,4 +58,4 @@ Defined in: [src/airs/types.ts:549](https://github.com/cdot65/prisma-airs-cli/bl > `optional` **sourceTypes?**: `string`[] -Defined in: [src/airs/types.ts:547](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L547) +Defined in: [src/airs/types.ts:548](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L548) diff --git a/docs/developers/api/interfaces/ModelSecurityGroupUpdateRequest.md b/docs/developers/api/interfaces/ModelSecurityGroupUpdateRequest.md index c40fb14..8a70151 100644 --- a/docs/developers/api/interfaces/ModelSecurityGroupUpdateRequest.md +++ b/docs/developers/api/interfaces/ModelSecurityGroupUpdateRequest.md @@ -1,6 +1,6 @@ # Interface: ModelSecurityGroupUpdateRequest -Defined in: [src/airs/types.ts:540](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L540) +Defined in: [src/airs/types.ts:541](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L541) Request to update a security group. @@ -10,7 +10,7 @@ Request to update a security group. > `optional` **description?**: `string` -Defined in: [src/airs/types.ts:542](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L542) +Defined in: [src/airs/types.ts:543](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L543) *** @@ -18,4 +18,4 @@ Defined in: [src/airs/types.ts:542](https://github.com/cdot65/prisma-airs-cli/bl > `optional` **name?**: `string` -Defined in: [src/airs/types.ts:541](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L541) +Defined in: [src/airs/types.ts:542](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L542) diff --git a/docs/developers/api/interfaces/ModelSecurityLabel.md b/docs/developers/api/interfaces/ModelSecurityLabel.md index f294d27..c3d46b7 100644 --- a/docs/developers/api/interfaces/ModelSecurityLabel.md +++ b/docs/developers/api/interfaces/ModelSecurityLabel.md @@ -1,6 +1,6 @@ # Interface: ModelSecurityLabel -Defined in: [src/airs/types.ts:687](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L687) +Defined in: [src/airs/types.ts:688](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L688) Label key-value pair. @@ -10,7 +10,7 @@ Label key-value pair. > **key**: `string` -Defined in: [src/airs/types.ts:688](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L688) +Defined in: [src/airs/types.ts:689](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L689) *** @@ -18,4 +18,4 @@ Defined in: [src/airs/types.ts:688](https://github.com/cdot65/prisma-airs-cli/bl > **value**: `string` -Defined in: [src/airs/types.ts:689](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L689) +Defined in: [src/airs/types.ts:690](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L690) diff --git a/docs/developers/api/interfaces/ModelSecurityPyPIAuth.md b/docs/developers/api/interfaces/ModelSecurityPyPIAuth.md index 3e8ad60..f4dda03 100644 --- a/docs/developers/api/interfaces/ModelSecurityPyPIAuth.md +++ b/docs/developers/api/interfaces/ModelSecurityPyPIAuth.md @@ -1,6 +1,6 @@ # Interface: ModelSecurityPyPIAuth -Defined in: [src/airs/types.ts:693](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L693) +Defined in: [src/airs/types.ts:694](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L694) PyPI authentication response. @@ -10,7 +10,7 @@ PyPI authentication response. > **expiresAt**: `string` -Defined in: [src/airs/types.ts:695](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L695) +Defined in: [src/airs/types.ts:696](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L696) *** @@ -18,4 +18,4 @@ Defined in: [src/airs/types.ts:695](https://github.com/cdot65/prisma-airs-cli/bl > **url**: `string` -Defined in: [src/airs/types.ts:694](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L694) +Defined in: [src/airs/types.ts:695](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L695) diff --git a/docs/developers/api/interfaces/ModelSecurityRule.md b/docs/developers/api/interfaces/ModelSecurityRule.md index ca204d2..19974a4 100644 --- a/docs/developers/api/interfaces/ModelSecurityRule.md +++ b/docs/developers/api/interfaces/ModelSecurityRule.md @@ -1,6 +1,6 @@ # Interface: ModelSecurityRule -Defined in: [src/airs/types.ts:557](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L557) +Defined in: [src/airs/types.ts:558](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L558) Normalized security rule. @@ -10,7 +10,7 @@ Normalized security rule. > **compatibleSources**: `string`[] -Defined in: [src/airs/types.ts:562](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L562) +Defined in: [src/airs/types.ts:563](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L563) *** @@ -18,7 +18,7 @@ Defined in: [src/airs/types.ts:562](https://github.com/cdot65/prisma-airs-cli/bl > **constantValues**: `Record`\<`string`, `unknown`\> -Defined in: [src/airs/types.ts:570](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L570) +Defined in: [src/airs/types.ts:571](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L571) *** @@ -26,7 +26,7 @@ Defined in: [src/airs/types.ts:570](https://github.com/cdot65/prisma-airs-cli/bl > **defaultState**: `string` -Defined in: [src/airs/types.ts:563](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L563) +Defined in: [src/airs/types.ts:564](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L564) *** @@ -34,7 +34,7 @@ Defined in: [src/airs/types.ts:563](https://github.com/cdot65/prisma-airs-cli/bl > **defaultValues**: `Record`\<`string`, `unknown`\> -Defined in: [src/airs/types.ts:571](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L571) +Defined in: [src/airs/types.ts:572](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L572) *** @@ -42,7 +42,7 @@ Defined in: [src/airs/types.ts:571](https://github.com/cdot65/prisma-airs-cli/bl > **description**: `string` -Defined in: [src/airs/types.ts:560](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L560) +Defined in: [src/airs/types.ts:561](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L561) *** @@ -50,7 +50,7 @@ Defined in: [src/airs/types.ts:560](https://github.com/cdot65/prisma-airs-cli/bl > **editableFields**: [`ModelSecurityRuleEditableField`](ModelSecurityRuleEditableField.md)[] -Defined in: [src/airs/types.ts:569](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L569) +Defined in: [src/airs/types.ts:570](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L570) *** @@ -58,7 +58,7 @@ Defined in: [src/airs/types.ts:569](https://github.com/cdot65/prisma-airs-cli/bl > **name**: `string` -Defined in: [src/airs/types.ts:559](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L559) +Defined in: [src/airs/types.ts:560](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L560) *** @@ -66,7 +66,7 @@ Defined in: [src/airs/types.ts:559](https://github.com/cdot65/prisma-airs-cli/bl > **remediation**: `object` -Defined in: [src/airs/types.ts:564](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L564) +Defined in: [src/airs/types.ts:565](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L565) #### description @@ -86,7 +86,7 @@ Defined in: [src/airs/types.ts:564](https://github.com/cdot65/prisma-airs-cli/bl > **ruleType**: `string` -Defined in: [src/airs/types.ts:561](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L561) +Defined in: [src/airs/types.ts:562](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L562) *** @@ -94,4 +94,4 @@ Defined in: [src/airs/types.ts:561](https://github.com/cdot65/prisma-airs-cli/bl > **uuid**: `string` -Defined in: [src/airs/types.ts:558](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L558) +Defined in: [src/airs/types.ts:559](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L559) diff --git a/docs/developers/api/interfaces/ModelSecurityRuleEditableField.md b/docs/developers/api/interfaces/ModelSecurityRuleEditableField.md index 17f1b3b..e60e9ee 100644 --- a/docs/developers/api/interfaces/ModelSecurityRuleEditableField.md +++ b/docs/developers/api/interfaces/ModelSecurityRuleEditableField.md @@ -1,6 +1,6 @@ # Interface: ModelSecurityRuleEditableField -Defined in: [src/airs/types.ts:575](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L575) +Defined in: [src/airs/types.ts:576](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L576) Editable field spec for a security rule. @@ -10,7 +10,7 @@ Editable field spec for a security rule. > **attributeName**: `string` -Defined in: [src/airs/types.ts:576](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L576) +Defined in: [src/airs/types.ts:577](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L577) *** @@ -18,7 +18,7 @@ Defined in: [src/airs/types.ts:576](https://github.com/cdot65/prisma-airs-cli/bl > `optional` **description?**: `string` -Defined in: [src/airs/types.ts:580](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L580) +Defined in: [src/airs/types.ts:581](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L581) *** @@ -26,7 +26,7 @@ Defined in: [src/airs/types.ts:580](https://github.com/cdot65/prisma-airs-cli/bl > **displayName**: `string` -Defined in: [src/airs/types.ts:578](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L578) +Defined in: [src/airs/types.ts:579](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L579) *** @@ -34,7 +34,7 @@ Defined in: [src/airs/types.ts:578](https://github.com/cdot65/prisma-airs-cli/bl > **displayType**: `string` -Defined in: [src/airs/types.ts:579](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L579) +Defined in: [src/airs/types.ts:580](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L580) *** @@ -42,7 +42,7 @@ Defined in: [src/airs/types.ts:579](https://github.com/cdot65/prisma-airs-cli/bl > `optional` **dropdownValues?**: `object`[] -Defined in: [src/airs/types.ts:581](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L581) +Defined in: [src/airs/types.ts:582](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L582) #### label @@ -58,4 +58,4 @@ Defined in: [src/airs/types.ts:581](https://github.com/cdot65/prisma-airs-cli/bl > **type**: `string` -Defined in: [src/airs/types.ts:577](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L577) +Defined in: [src/airs/types.ts:578](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L578) diff --git a/docs/developers/api/interfaces/ModelSecurityRuleInstance.md b/docs/developers/api/interfaces/ModelSecurityRuleInstance.md index fd8ac63..879d5fc 100644 --- a/docs/developers/api/interfaces/ModelSecurityRuleInstance.md +++ b/docs/developers/api/interfaces/ModelSecurityRuleInstance.md @@ -1,6 +1,6 @@ # Interface: ModelSecurityRuleInstance -Defined in: [src/airs/types.ts:593](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L593) +Defined in: [src/airs/types.ts:594](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L594) Normalized rule instance within a security group. @@ -10,7 +10,7 @@ Normalized rule instance within a security group. > **createdAt**: `string` -Defined in: [src/airs/types.ts:598](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L598) +Defined in: [src/airs/types.ts:599](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L599) *** @@ -18,7 +18,7 @@ Defined in: [src/airs/types.ts:598](https://github.com/cdot65/prisma-airs-cli/bl > **fieldValues**: `Record`\<`string`, `unknown`\> -Defined in: [src/airs/types.ts:601](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L601) +Defined in: [src/airs/types.ts:602](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L602) *** @@ -26,7 +26,7 @@ Defined in: [src/airs/types.ts:601](https://github.com/cdot65/prisma-airs-cli/bl > **rule**: `Record`\<`string`, `unknown`\> -Defined in: [src/airs/types.ts:600](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L600) +Defined in: [src/airs/types.ts:601](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L601) *** @@ -34,7 +34,7 @@ Defined in: [src/airs/types.ts:600](https://github.com/cdot65/prisma-airs-cli/bl > **securityGroupUuid**: `string` -Defined in: [src/airs/types.ts:595](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L595) +Defined in: [src/airs/types.ts:596](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L596) *** @@ -42,7 +42,7 @@ Defined in: [src/airs/types.ts:595](https://github.com/cdot65/prisma-airs-cli/bl > **securityRuleUuid**: `string` -Defined in: [src/airs/types.ts:596](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L596) +Defined in: [src/airs/types.ts:597](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L597) *** @@ -50,7 +50,7 @@ Defined in: [src/airs/types.ts:596](https://github.com/cdot65/prisma-airs-cli/bl > **state**: `string` -Defined in: [src/airs/types.ts:597](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L597) +Defined in: [src/airs/types.ts:598](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L598) *** @@ -58,7 +58,7 @@ Defined in: [src/airs/types.ts:597](https://github.com/cdot65/prisma-airs-cli/bl > **updatedAt**: `string` -Defined in: [src/airs/types.ts:599](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L599) +Defined in: [src/airs/types.ts:600](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L600) *** @@ -66,4 +66,4 @@ Defined in: [src/airs/types.ts:599](https://github.com/cdot65/prisma-airs-cli/bl > **uuid**: `string` -Defined in: [src/airs/types.ts:594](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L594) +Defined in: [src/airs/types.ts:595](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L595) diff --git a/docs/developers/api/interfaces/ModelSecurityRuleInstanceListOptions.md b/docs/developers/api/interfaces/ModelSecurityRuleInstanceListOptions.md index dca76c2..11fed86 100644 --- a/docs/developers/api/interfaces/ModelSecurityRuleInstanceListOptions.md +++ b/docs/developers/api/interfaces/ModelSecurityRuleInstanceListOptions.md @@ -1,6 +1,6 @@ # Interface: ModelSecurityRuleInstanceListOptions -Defined in: [src/airs/types.ts:605](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L605) +Defined in: [src/airs/types.ts:606](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L606) Filter options for listing rule instances. @@ -10,7 +10,7 @@ Filter options for listing rule instances. > `optional` **limit?**: `number` -Defined in: [src/airs/types.ts:609](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L609) +Defined in: [src/airs/types.ts:610](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L610) *** @@ -18,7 +18,7 @@ Defined in: [src/airs/types.ts:609](https://github.com/cdot65/prisma-airs-cli/bl > `optional` **securityRuleUuid?**: `string` -Defined in: [src/airs/types.ts:606](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L606) +Defined in: [src/airs/types.ts:607](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L607) *** @@ -26,7 +26,7 @@ Defined in: [src/airs/types.ts:606](https://github.com/cdot65/prisma-airs-cli/bl > `optional` **skip?**: `number` -Defined in: [src/airs/types.ts:608](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L608) +Defined in: [src/airs/types.ts:609](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L609) *** @@ -34,4 +34,4 @@ Defined in: [src/airs/types.ts:608](https://github.com/cdot65/prisma-airs-cli/bl > `optional` **state?**: `string` -Defined in: [src/airs/types.ts:607](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L607) +Defined in: [src/airs/types.ts:608](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L608) diff --git a/docs/developers/api/interfaces/ModelSecurityRuleInstanceUpdateRequest.md b/docs/developers/api/interfaces/ModelSecurityRuleInstanceUpdateRequest.md index 40960b6..8caced8 100644 --- a/docs/developers/api/interfaces/ModelSecurityRuleInstanceUpdateRequest.md +++ b/docs/developers/api/interfaces/ModelSecurityRuleInstanceUpdateRequest.md @@ -1,6 +1,6 @@ # Interface: ModelSecurityRuleInstanceUpdateRequest -Defined in: [src/airs/types.ts:613](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L613) +Defined in: [src/airs/types.ts:614](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L614) Request to update a rule instance. @@ -10,7 +10,7 @@ Request to update a rule instance. > `optional` **fieldValues?**: `Record`\<`string`, `unknown`\> -Defined in: [src/airs/types.ts:615](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L615) +Defined in: [src/airs/types.ts:616](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L616) *** @@ -18,4 +18,4 @@ Defined in: [src/airs/types.ts:615](https://github.com/cdot65/prisma-airs-cli/bl > `optional` **state?**: `string` -Defined in: [src/airs/types.ts:614](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L614) +Defined in: [src/airs/types.ts:615](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L615) diff --git a/docs/developers/api/interfaces/ModelSecurityRuleListOptions.md b/docs/developers/api/interfaces/ModelSecurityRuleListOptions.md index 002a78b..6b34196 100644 --- a/docs/developers/api/interfaces/ModelSecurityRuleListOptions.md +++ b/docs/developers/api/interfaces/ModelSecurityRuleListOptions.md @@ -1,6 +1,6 @@ # Interface: ModelSecurityRuleListOptions -Defined in: [src/airs/types.ts:585](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L585) +Defined in: [src/airs/types.ts:586](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L586) Filter options for listing security rules. @@ -10,7 +10,7 @@ Filter options for listing security rules. > `optional` **limit?**: `number` -Defined in: [src/airs/types.ts:589](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L589) +Defined in: [src/airs/types.ts:590](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L590) *** @@ -18,7 +18,7 @@ Defined in: [src/airs/types.ts:589](https://github.com/cdot65/prisma-airs-cli/bl > `optional` **searchQuery?**: `string` -Defined in: [src/airs/types.ts:587](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L587) +Defined in: [src/airs/types.ts:588](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L588) *** @@ -26,7 +26,7 @@ Defined in: [src/airs/types.ts:587](https://github.com/cdot65/prisma-airs-cli/bl > `optional` **skip?**: `number` -Defined in: [src/airs/types.ts:588](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L588) +Defined in: [src/airs/types.ts:589](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L589) *** @@ -34,4 +34,4 @@ Defined in: [src/airs/types.ts:588](https://github.com/cdot65/prisma-airs-cli/bl > `optional` **sourceType?**: `string` -Defined in: [src/airs/types.ts:586](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L586) +Defined in: [src/airs/types.ts:587](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L587) diff --git a/docs/developers/api/interfaces/ModelSecurityScan.md b/docs/developers/api/interfaces/ModelSecurityScan.md index 8918942..8409e8c 100644 --- a/docs/developers/api/interfaces/ModelSecurityScan.md +++ b/docs/developers/api/interfaces/ModelSecurityScan.md @@ -1,6 +1,6 @@ # Interface: ModelSecurityScan -Defined in: [src/airs/types.ts:619](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L619) +Defined in: [src/airs/types.ts:620](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L620) Normalized model security scan. @@ -10,7 +10,7 @@ Normalized model security scan. > **createdAt**: `string` -Defined in: [src/airs/types.ts:631](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L631) +Defined in: [src/airs/types.ts:632](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L632) *** @@ -18,7 +18,7 @@ Defined in: [src/airs/types.ts:631](https://github.com/cdot65/prisma-airs-cli/bl > **evalOutcome**: `string` -Defined in: [src/airs/types.ts:621](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L621) +Defined in: [src/airs/types.ts:622](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L622) *** @@ -26,7 +26,7 @@ Defined in: [src/airs/types.ts:621](https://github.com/cdot65/prisma-airs-cli/bl > **evalSummary**: \{ `rulesFailed`: `number`; `rulesPassed`: `number`; `totalRules`: `number`; \} \| `null` -Defined in: [src/airs/types.ts:626](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L626) +Defined in: [src/airs/types.ts:627](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L627) *** @@ -34,7 +34,7 @@ Defined in: [src/airs/types.ts:626](https://github.com/cdot65/prisma-airs-cli/bl > **labels**: `object`[] -Defined in: [src/airs/types.ts:633](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L633) +Defined in: [src/airs/types.ts:634](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L634) #### key @@ -50,7 +50,7 @@ Defined in: [src/airs/types.ts:633](https://github.com/cdot65/prisma-airs-cli/bl > **modelUri**: `string` -Defined in: [src/airs/types.ts:622](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L622) +Defined in: [src/airs/types.ts:623](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L623) *** @@ -58,7 +58,7 @@ Defined in: [src/airs/types.ts:622](https://github.com/cdot65/prisma-airs-cli/bl > **scanOrigin**: `string` -Defined in: [src/airs/types.ts:623](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L623) +Defined in: [src/airs/types.ts:624](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L624) *** @@ -66,7 +66,7 @@ Defined in: [src/airs/types.ts:623](https://github.com/cdot65/prisma-airs-cli/bl > **securityGroupName**: `string` -Defined in: [src/airs/types.ts:625](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L625) +Defined in: [src/airs/types.ts:626](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L626) *** @@ -74,7 +74,7 @@ Defined in: [src/airs/types.ts:625](https://github.com/cdot65/prisma-airs-cli/bl > **sourceType**: `string` -Defined in: [src/airs/types.ts:624](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L624) +Defined in: [src/airs/types.ts:625](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L625) *** @@ -82,7 +82,7 @@ Defined in: [src/airs/types.ts:624](https://github.com/cdot65/prisma-airs-cli/bl > **updatedAt**: `string` -Defined in: [src/airs/types.ts:632](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L632) +Defined in: [src/airs/types.ts:633](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L633) *** @@ -90,4 +90,4 @@ Defined in: [src/airs/types.ts:632](https://github.com/cdot65/prisma-airs-cli/bl > **uuid**: `string` -Defined in: [src/airs/types.ts:620](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L620) +Defined in: [src/airs/types.ts:621](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L621) diff --git a/docs/developers/api/interfaces/ModelSecurityScanListOptions.md b/docs/developers/api/interfaces/ModelSecurityScanListOptions.md index f7ee8f1..e1423f4 100644 --- a/docs/developers/api/interfaces/ModelSecurityScanListOptions.md +++ b/docs/developers/api/interfaces/ModelSecurityScanListOptions.md @@ -1,6 +1,6 @@ # Interface: ModelSecurityScanListOptions -Defined in: [src/airs/types.ts:637](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L637) +Defined in: [src/airs/types.ts:638](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L638) Filter options for listing scans. @@ -10,7 +10,7 @@ Filter options for listing scans. > `optional` **evalOutcome?**: `string` -Defined in: [src/airs/types.ts:638](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L638) +Defined in: [src/airs/types.ts:639](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L639) *** @@ -18,7 +18,7 @@ Defined in: [src/airs/types.ts:638](https://github.com/cdot65/prisma-airs-cli/bl > `optional` **limit?**: `number` -Defined in: [src/airs/types.ts:643](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L643) +Defined in: [src/airs/types.ts:644](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L644) *** @@ -26,7 +26,7 @@ Defined in: [src/airs/types.ts:643](https://github.com/cdot65/prisma-airs-cli/bl > `optional` **scanOrigin?**: `string` -Defined in: [src/airs/types.ts:640](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L640) +Defined in: [src/airs/types.ts:641](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L641) *** @@ -34,7 +34,7 @@ Defined in: [src/airs/types.ts:640](https://github.com/cdot65/prisma-airs-cli/bl > `optional` **search?**: `string` -Defined in: [src/airs/types.ts:641](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L641) +Defined in: [src/airs/types.ts:642](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L642) *** @@ -42,7 +42,7 @@ Defined in: [src/airs/types.ts:641](https://github.com/cdot65/prisma-airs-cli/bl > `optional` **skip?**: `number` -Defined in: [src/airs/types.ts:642](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L642) +Defined in: [src/airs/types.ts:643](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L643) *** @@ -50,4 +50,4 @@ Defined in: [src/airs/types.ts:642](https://github.com/cdot65/prisma-airs-cli/bl > `optional` **sourceType?**: `string` -Defined in: [src/airs/types.ts:639](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L639) +Defined in: [src/airs/types.ts:640](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L640) diff --git a/docs/developers/api/interfaces/ModelSecurityService.md b/docs/developers/api/interfaces/ModelSecurityService.md index e5ff0e6..b84b3dd 100644 --- a/docs/developers/api/interfaces/ModelSecurityService.md +++ b/docs/developers/api/interfaces/ModelSecurityService.md @@ -1,6 +1,6 @@ # Interface: ModelSecurityService -Defined in: [src/airs/types.ts:705](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L705) +Defined in: [src/airs/types.ts:706](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L706) Contract for Model Security operations. @@ -10,7 +10,7 @@ Contract for Model Security operations. > **addLabels**(`scanUuid`, `labels`): `Promise`\<`void`\> -Defined in: [src/airs/types.ts:753](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L753) +Defined in: [src/airs/types.ts:754](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L754) #### Parameters @@ -32,7 +32,7 @@ Defined in: [src/airs/types.ts:753](https://github.com/cdot65/prisma-airs-cli/bl > **createGroup**(`request`): `Promise`\<[`ModelSecurityGroup`](ModelSecurityGroup.md)\> -Defined in: [src/airs/types.ts:710](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L710) +Defined in: [src/airs/types.ts:711](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L711) #### Parameters @@ -50,7 +50,7 @@ Defined in: [src/airs/types.ts:710](https://github.com/cdot65/prisma-airs-cli/bl > **createScan**(`request`): `Promise`\<[`ModelSecurityScan`](ModelSecurityScan.md)\> -Defined in: [src/airs/types.ts:730](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L730) +Defined in: [src/airs/types.ts:731](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L731) #### Parameters @@ -68,7 +68,7 @@ Defined in: [src/airs/types.ts:730](https://github.com/cdot65/prisma-airs-cli/bl > **deleteGroup**(`uuid`): `Promise`\<`void`\> -Defined in: [src/airs/types.ts:712](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L712) +Defined in: [src/airs/types.ts:713](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L713) #### Parameters @@ -86,7 +86,7 @@ Defined in: [src/airs/types.ts:712](https://github.com/cdot65/prisma-airs-cli/bl > **deleteLabels**(`scanUuid`, `keys`): `Promise`\<`void`\> -Defined in: [src/airs/types.ts:755](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L755) +Defined in: [src/airs/types.ts:756](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L756) #### Parameters @@ -108,7 +108,7 @@ Defined in: [src/airs/types.ts:755](https://github.com/cdot65/prisma-airs-cli/bl > **getEvaluation**(`uuid`): `Promise`\<[`ModelSecurityEvaluation`](ModelSecurityEvaluation.md)\> -Defined in: [src/airs/types.ts:740](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L740) +Defined in: [src/airs/types.ts:741](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L741) #### Parameters @@ -126,7 +126,7 @@ Defined in: [src/airs/types.ts:740](https://github.com/cdot65/prisma-airs-cli/bl > **getEvaluations**(`scanUuid`, `opts?`): `Promise`\<\{ `evaluations`: [`ModelSecurityEvaluation`](ModelSecurityEvaluation.md)[]; `totalItems`: `number`; \}\> -Defined in: [src/airs/types.ts:736](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L736) +Defined in: [src/airs/types.ts:737](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L737) #### Parameters @@ -154,7 +154,7 @@ Defined in: [src/airs/types.ts:736](https://github.com/cdot65/prisma-airs-cli/bl > **getFiles**(`scanUuid`, `opts?`): `Promise`\<\{ `files`: [`ModelSecurityFile`](ModelSecurityFile.md)[]; `totalItems`: `number`; \}\> -Defined in: [src/airs/types.ts:748](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L748) +Defined in: [src/airs/types.ts:749](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L749) #### Parameters @@ -176,7 +176,7 @@ Defined in: [src/airs/types.ts:748](https://github.com/cdot65/prisma-airs-cli/bl > **getGroup**(`uuid`): `Promise`\<[`ModelSecurityGroup`](ModelSecurityGroup.md)\> -Defined in: [src/airs/types.ts:709](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L709) +Defined in: [src/airs/types.ts:710](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L710) #### Parameters @@ -194,7 +194,7 @@ Defined in: [src/airs/types.ts:709](https://github.com/cdot65/prisma-airs-cli/bl > **getLabelKeys**(`opts?`): `Promise`\<\{ `keys`: `string`[]; `totalItems`: `number`; \}\> -Defined in: [src/airs/types.ts:756](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L756) +Defined in: [src/airs/types.ts:757](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L757) #### Parameters @@ -218,7 +218,7 @@ Defined in: [src/airs/types.ts:756](https://github.com/cdot65/prisma-airs-cli/bl > **getLabelValues**(`key`, `opts?`): `Promise`\<\{ `totalItems`: `number`; `values`: `string`[]; \}\> -Defined in: [src/airs/types.ts:760](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L760) +Defined in: [src/airs/types.ts:761](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L761) #### Parameters @@ -246,7 +246,7 @@ Defined in: [src/airs/types.ts:760](https://github.com/cdot65/prisma-airs-cli/bl > **getPyPIAuth**(): `Promise`\<[`ModelSecurityPyPIAuth`](ModelSecurityPyPIAuth.md)\> -Defined in: [src/airs/types.ts:765](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L765) +Defined in: [src/airs/types.ts:766](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L766) #### Returns @@ -258,7 +258,7 @@ Defined in: [src/airs/types.ts:765](https://github.com/cdot65/prisma-airs-cli/bl > **getRule**(`uuid`): `Promise`\<[`ModelSecurityRule`](ModelSecurityRule.md)\> -Defined in: [src/airs/types.ts:728](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L728) +Defined in: [src/airs/types.ts:729](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L729) #### Parameters @@ -276,7 +276,7 @@ Defined in: [src/airs/types.ts:728](https://github.com/cdot65/prisma-airs-cli/bl > **getRuleInstance**(`groupUuid`, `instanceUuid`): `Promise`\<[`ModelSecurityRuleInstance`](ModelSecurityRuleInstance.md)\> -Defined in: [src/airs/types.ts:718](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L718) +Defined in: [src/airs/types.ts:719](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L719) #### Parameters @@ -298,7 +298,7 @@ Defined in: [src/airs/types.ts:718](https://github.com/cdot65/prisma-airs-cli/bl > **getScan**(`uuid`): `Promise`\<[`ModelSecurityScan`](ModelSecurityScan.md)\> -Defined in: [src/airs/types.ts:734](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L734) +Defined in: [src/airs/types.ts:735](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L735) #### Parameters @@ -316,7 +316,7 @@ Defined in: [src/airs/types.ts:734](https://github.com/cdot65/prisma-airs-cli/bl > **getViolation**(`uuid`): `Promise`\<[`ModelSecurityViolation`](ModelSecurityViolation.md)\> -Defined in: [src/airs/types.ts:746](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L746) +Defined in: [src/airs/types.ts:747](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L747) #### Parameters @@ -334,7 +334,7 @@ Defined in: [src/airs/types.ts:746](https://github.com/cdot65/prisma-airs-cli/bl > **getViolations**(`scanUuid`, `opts?`): `Promise`\<\{ `totalItems`: `number`; `violations`: [`ModelSecurityViolation`](ModelSecurityViolation.md)[]; \}\> -Defined in: [src/airs/types.ts:742](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L742) +Defined in: [src/airs/types.ts:743](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L743) #### Parameters @@ -362,7 +362,7 @@ Defined in: [src/airs/types.ts:742](https://github.com/cdot65/prisma-airs-cli/bl > **listGroups**(`opts?`): `Promise`\<\{ `groups`: [`ModelSecurityGroup`](ModelSecurityGroup.md)[]; `totalItems`: `number`; \}\> -Defined in: [src/airs/types.ts:706](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L706) +Defined in: [src/airs/types.ts:707](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L707) #### Parameters @@ -380,7 +380,7 @@ Defined in: [src/airs/types.ts:706](https://github.com/cdot65/prisma-airs-cli/bl > **listRuleInstances**(`groupUuid`, `opts?`): `Promise`\<\{ `ruleInstances`: [`ModelSecurityRuleInstance`](ModelSecurityRuleInstance.md)[]; `totalItems`: `number`; \}\> -Defined in: [src/airs/types.ts:714](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L714) +Defined in: [src/airs/types.ts:715](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L715) #### Parameters @@ -402,7 +402,7 @@ Defined in: [src/airs/types.ts:714](https://github.com/cdot65/prisma-airs-cli/bl > **listRules**(`opts?`): `Promise`\<\{ `rules`: [`ModelSecurityRule`](ModelSecurityRule.md)[]; `totalItems`: `number`; \}\> -Defined in: [src/airs/types.ts:725](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L725) +Defined in: [src/airs/types.ts:726](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L726) #### Parameters @@ -420,7 +420,7 @@ Defined in: [src/airs/types.ts:725](https://github.com/cdot65/prisma-airs-cli/bl > **listScans**(`opts?`): `Promise`\<\{ `scans`: [`ModelSecurityScan`](ModelSecurityScan.md)[]; `totalItems`: `number`; \}\> -Defined in: [src/airs/types.ts:731](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L731) +Defined in: [src/airs/types.ts:732](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L732) #### Parameters @@ -438,7 +438,7 @@ Defined in: [src/airs/types.ts:731](https://github.com/cdot65/prisma-airs-cli/bl > **setLabels**(`scanUuid`, `labels`): `Promise`\<`void`\> -Defined in: [src/airs/types.ts:754](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L754) +Defined in: [src/airs/types.ts:755](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L755) #### Parameters @@ -460,7 +460,7 @@ Defined in: [src/airs/types.ts:754](https://github.com/cdot65/prisma-airs-cli/bl > **updateGroup**(`uuid`, `request`): `Promise`\<[`ModelSecurityGroup`](ModelSecurityGroup.md)\> -Defined in: [src/airs/types.ts:711](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L711) +Defined in: [src/airs/types.ts:712](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L712) #### Parameters @@ -482,7 +482,7 @@ Defined in: [src/airs/types.ts:711](https://github.com/cdot65/prisma-airs-cli/bl > **updateRuleInstance**(`groupUuid`, `instanceUuid`, `request`): `Promise`\<[`ModelSecurityRuleInstance`](ModelSecurityRuleInstance.md)\> -Defined in: [src/airs/types.ts:719](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L719) +Defined in: [src/airs/types.ts:720](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L720) #### Parameters diff --git a/docs/developers/api/interfaces/ModelSecurityViolation.md b/docs/developers/api/interfaces/ModelSecurityViolation.md index 36a5669..ccded56 100644 --- a/docs/developers/api/interfaces/ModelSecurityViolation.md +++ b/docs/developers/api/interfaces/ModelSecurityViolation.md @@ -1,6 +1,6 @@ # Interface: ModelSecurityViolation -Defined in: [src/airs/types.ts:658](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L658) +Defined in: [src/airs/types.ts:659](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L659) Normalized violation from a scan. @@ -10,7 +10,7 @@ Normalized violation from a scan. > **description**: `string` -Defined in: [src/airs/types.ts:660](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L660) +Defined in: [src/airs/types.ts:661](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L661) *** @@ -18,7 +18,7 @@ Defined in: [src/airs/types.ts:660](https://github.com/cdot65/prisma-airs-cli/bl > **file**: `string` -Defined in: [src/airs/types.ts:663](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L663) +Defined in: [src/airs/types.ts:664](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L664) *** @@ -26,7 +26,7 @@ Defined in: [src/airs/types.ts:663](https://github.com/cdot65/prisma-airs-cli/bl > **ruleDescription**: `string` -Defined in: [src/airs/types.ts:665](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L665) +Defined in: [src/airs/types.ts:666](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L666) *** @@ -34,7 +34,7 @@ Defined in: [src/airs/types.ts:665](https://github.com/cdot65/prisma-airs-cli/bl > **ruleInstanceState**: `string` -Defined in: [src/airs/types.ts:666](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L666) +Defined in: [src/airs/types.ts:667](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L667) *** @@ -42,7 +42,7 @@ Defined in: [src/airs/types.ts:666](https://github.com/cdot65/prisma-airs-cli/bl > **ruleName**: `string` -Defined in: [src/airs/types.ts:664](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L664) +Defined in: [src/airs/types.ts:665](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L665) *** @@ -50,7 +50,7 @@ Defined in: [src/airs/types.ts:664](https://github.com/cdot65/prisma-airs-cli/bl > **threat**: `string` -Defined in: [src/airs/types.ts:661](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L661) +Defined in: [src/airs/types.ts:662](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L662) *** @@ -58,7 +58,7 @@ Defined in: [src/airs/types.ts:661](https://github.com/cdot65/prisma-airs-cli/bl > **threatDescription**: `string` -Defined in: [src/airs/types.ts:662](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L662) +Defined in: [src/airs/types.ts:663](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L663) *** @@ -66,4 +66,4 @@ Defined in: [src/airs/types.ts:662](https://github.com/cdot65/prisma-airs-cli/bl > **uuid**: `string` -Defined in: [src/airs/types.ts:659](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L659) +Defined in: [src/airs/types.ts:660](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L660) diff --git a/docs/developers/api/interfaces/MutationResponse.md b/docs/developers/api/interfaces/MutationResponse.md new file mode 100644 index 0000000..24dddf9 --- /dev/null +++ b/docs/developers/api/interfaces/MutationResponse.md @@ -0,0 +1,21 @@ +# Interface: MutationResponse + +Defined in: [src/airs/types.ts:248](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L248) + +Generic write-op response from custom-attack endpoints (SDK BaseResponseSchema). + +## Properties + +### message + +> **message**: `string` + +Defined in: [src/airs/types.ts:249](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L249) + +*** + +### status? + +> `optional` **status?**: `number` + +Defined in: [src/airs/types.ts:250](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L250) diff --git a/docs/developers/api/interfaces/PromptSetService.md b/docs/developers/api/interfaces/PromptSetService.md index 317f8df..1037957 100644 --- a/docs/developers/api/interfaces/PromptSetService.md +++ b/docs/developers/api/interfaces/PromptSetService.md @@ -84,7 +84,7 @@ Create a new custom prompt set. ### createPropertyName() -> **createPropertyName**(`name`): `Promise`\<[`PropertyName`](PropertyName.md)\> +> **createPropertyName**(`name`): `Promise`\<[`MutationResponse`](MutationResponse.md)\> Defined in: [src/airs/types.ts:117](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L117) @@ -98,13 +98,13 @@ Create a property name. #### Returns -`Promise`\<[`PropertyName`](PropertyName.md)\> +`Promise`\<[`MutationResponse`](MutationResponse.md)\> *** ### createPropertyValue() -> **createPropertyValue**(`name`, `value`): `Promise`\<[`PropertyValue`](PropertyValue.md)\> +> **createPropertyValue**(`name`, `value`): `Promise`\<[`MutationResponse`](MutationResponse.md)\> Defined in: [src/airs/types.ts:121](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L121) @@ -122,7 +122,7 @@ Create a property value. #### Returns -`Promise`\<[`PropertyValue`](PropertyValue.md)\> +`Promise`\<[`MutationResponse`](MutationResponse.md)\> *** @@ -236,7 +236,7 @@ Get prompt set version info with stats. ### getPropertyNames() -> **getPropertyNames**(): `Promise`\<[`PropertyName`](PropertyName.md)[]\> +> **getPropertyNames**(): `Promise`\<`string`[]\> Defined in: [src/airs/types.ts:115](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L115) @@ -244,13 +244,13 @@ List property names. #### Returns -`Promise`\<[`PropertyName`](PropertyName.md)[]\> +`Promise`\<`string`[]\> *** ### getPropertyValues() -> **getPropertyValues**(`name`): `Promise`\<[`PropertyValue`](PropertyValue.md)[]\> +> **getPropertyValues**(`name`): `Promise`\<[`PropertyValueList`](PropertyValueList.md)\> Defined in: [src/airs/types.ts:119](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L119) @@ -264,7 +264,7 @@ Get values for a property. #### Returns -`Promise`\<[`PropertyValue`](PropertyValue.md)[]\> +`Promise`\<[`PropertyValueList`](PropertyValueList.md)\> *** diff --git a/docs/developers/api/interfaces/PropertyValue.md b/docs/developers/api/interfaces/PropertyValue.md deleted file mode 100644 index 5259769..0000000 --- a/docs/developers/api/interfaces/PropertyValue.md +++ /dev/null @@ -1,21 +0,0 @@ -# Interface: PropertyValue - -Defined in: [src/airs/types.ts:247](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L247) - -Property value entry. - -## Properties - -### name - -> **name**: `string` - -Defined in: [src/airs/types.ts:248](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L248) - -*** - -### value - -> **value**: `string` - -Defined in: [src/airs/types.ts:249](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L249) diff --git a/docs/developers/api/interfaces/PropertyName.md b/docs/developers/api/interfaces/PropertyValueList.md similarity index 53% rename from docs/developers/api/interfaces/PropertyName.md rename to docs/developers/api/interfaces/PropertyValueList.md index 6eee39c..127767f 100644 --- a/docs/developers/api/interfaces/PropertyName.md +++ b/docs/developers/api/interfaces/PropertyValueList.md @@ -1,8 +1,8 @@ -# Interface: PropertyName +# Interface: PropertyValueList Defined in: [src/airs/types.ts:242](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L242) -Property name entry. +Values for a single property name (SDK 0.10.0 shape). ## Properties @@ -11,3 +11,11 @@ Property name entry. > **name**: `string` Defined in: [src/airs/types.ts:243](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L243) + +*** + +### values + +> **values**: `string`[] + +Defined in: [src/airs/types.ts:244](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L244) diff --git a/docs/developers/api/interfaces/RedTeamAttack.md b/docs/developers/api/interfaces/RedTeamAttack.md index d5b1aa4..1e01a69 100644 --- a/docs/developers/api/interfaces/RedTeamAttack.md +++ b/docs/developers/api/interfaces/RedTeamAttack.md @@ -1,6 +1,6 @@ # Interface: RedTeamAttack -Defined in: [src/airs/types.ts:303](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L303) +Defined in: [src/airs/types.ts:304](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L304) Normalized attack list item (static/dynamic scans). @@ -10,7 +10,7 @@ Normalized attack list item (static/dynamic scans). > `optional` **category?**: `string` -Defined in: [src/airs/types.ts:307](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L307) +Defined in: [src/airs/types.ts:308](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L308) *** @@ -18,7 +18,7 @@ Defined in: [src/airs/types.ts:307](https://github.com/cdot65/prisma-airs-cli/bl > **id**: `string` -Defined in: [src/airs/types.ts:304](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L304) +Defined in: [src/airs/types.ts:305](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L305) *** @@ -26,7 +26,7 @@ Defined in: [src/airs/types.ts:304](https://github.com/cdot65/prisma-airs-cli/bl > **name**: `string` -Defined in: [src/airs/types.ts:305](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L305) +Defined in: [src/airs/types.ts:306](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L306) *** @@ -34,7 +34,7 @@ Defined in: [src/airs/types.ts:305](https://github.com/cdot65/prisma-airs-cli/bl > `optional` **severity?**: `string` -Defined in: [src/airs/types.ts:306](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L306) +Defined in: [src/airs/types.ts:307](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L307) *** @@ -42,7 +42,7 @@ Defined in: [src/airs/types.ts:306](https://github.com/cdot65/prisma-airs-cli/bl > `optional` **subCategory?**: `string` -Defined in: [src/airs/types.ts:308](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L308) +Defined in: [src/airs/types.ts:309](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L309) *** @@ -50,7 +50,7 @@ Defined in: [src/airs/types.ts:308](https://github.com/cdot65/prisma-airs-cli/bl > `optional` **subCategoryDisplayName?**: `string` -Defined in: [src/airs/types.ts:309](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L309) +Defined in: [src/airs/types.ts:310](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L310) *** @@ -58,4 +58,4 @@ Defined in: [src/airs/types.ts:309](https://github.com/cdot65/prisma-airs-cli/bl > **successful**: `boolean` -Defined in: [src/airs/types.ts:310](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L310) +Defined in: [src/airs/types.ts:311](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L311) diff --git a/docs/developers/api/interfaces/RedTeamCategory.md b/docs/developers/api/interfaces/RedTeamCategory.md index 75ec120..059f182 100644 --- a/docs/developers/api/interfaces/RedTeamCategory.md +++ b/docs/developers/api/interfaces/RedTeamCategory.md @@ -1,6 +1,6 @@ # Interface: RedTeamCategory -Defined in: [src/airs/types.ts:253](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L253) +Defined in: [src/airs/types.ts:254](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L254) Normalized attack category with subcategories. @@ -10,7 +10,7 @@ Normalized attack category with subcategories. > `optional` **description?**: `string` -Defined in: [src/airs/types.ts:256](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L256) +Defined in: [src/airs/types.ts:257](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L257) *** @@ -18,7 +18,7 @@ Defined in: [src/airs/types.ts:256](https://github.com/cdot65/prisma-airs-cli/bl > **displayName**: `string` -Defined in: [src/airs/types.ts:255](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L255) +Defined in: [src/airs/types.ts:256](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L256) *** @@ -26,7 +26,7 @@ Defined in: [src/airs/types.ts:255](https://github.com/cdot65/prisma-airs-cli/bl > **id**: `string` -Defined in: [src/airs/types.ts:254](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L254) +Defined in: [src/airs/types.ts:255](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L255) *** @@ -34,7 +34,7 @@ Defined in: [src/airs/types.ts:254](https://github.com/cdot65/prisma-airs-cli/bl > **subCategories**: `object`[] -Defined in: [src/airs/types.ts:257](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L257) +Defined in: [src/airs/types.ts:258](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L258) #### description? diff --git a/docs/developers/api/interfaces/RedTeamCustomAttack.md b/docs/developers/api/interfaces/RedTeamCustomAttack.md index 3835867..b9bd943 100644 --- a/docs/developers/api/interfaces/RedTeamCustomAttack.md +++ b/docs/developers/api/interfaces/RedTeamCustomAttack.md @@ -1,6 +1,6 @@ # Interface: RedTeamCustomAttack -Defined in: [src/airs/types.ts:314](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L314) +Defined in: [src/airs/types.ts:315](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L315) Normalized custom attack item (custom prompt set scans). @@ -10,7 +10,7 @@ Normalized custom attack item (custom prompt set scans). > `optional` **asr?**: `number` -Defined in: [src/airs/types.ts:319](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L319) +Defined in: [src/airs/types.ts:320](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L320) *** @@ -18,7 +18,7 @@ Defined in: [src/airs/types.ts:319](https://github.com/cdot65/prisma-airs-cli/bl > `optional` **goal?**: `string` -Defined in: [src/airs/types.ts:317](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L317) +Defined in: [src/airs/types.ts:318](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L318) *** @@ -26,7 +26,7 @@ Defined in: [src/airs/types.ts:317](https://github.com/cdot65/prisma-airs-cli/bl > **promptId**: `string` -Defined in: [src/airs/types.ts:315](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L315) +Defined in: [src/airs/types.ts:316](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L316) *** @@ -34,7 +34,7 @@ Defined in: [src/airs/types.ts:315](https://github.com/cdot65/prisma-airs-cli/bl > `optional` **promptSetName?**: `string` -Defined in: [src/airs/types.ts:320](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L320) +Defined in: [src/airs/types.ts:321](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L321) *** @@ -42,7 +42,7 @@ Defined in: [src/airs/types.ts:320](https://github.com/cdot65/prisma-airs-cli/bl > **promptText**: `string` -Defined in: [src/airs/types.ts:316](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L316) +Defined in: [src/airs/types.ts:317](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L317) *** @@ -50,4 +50,4 @@ Defined in: [src/airs/types.ts:316](https://github.com/cdot65/prisma-airs-cli/bl > **threat**: `boolean` -Defined in: [src/airs/types.ts:318](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L318) +Defined in: [src/airs/types.ts:319](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L319) diff --git a/docs/developers/api/interfaces/RedTeamCustomReport.md b/docs/developers/api/interfaces/RedTeamCustomReport.md index fb9c654..62176ee 100644 --- a/docs/developers/api/interfaces/RedTeamCustomReport.md +++ b/docs/developers/api/interfaces/RedTeamCustomReport.md @@ -1,6 +1,6 @@ # Interface: RedTeamCustomReport -Defined in: [src/airs/types.ts:285](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L285) +Defined in: [src/airs/types.ts:286](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L286) Normalized custom attack report summary. @@ -10,7 +10,7 @@ Normalized custom attack report summary. > **asr**: `number` -Defined in: [src/airs/types.ts:291](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L291) +Defined in: [src/airs/types.ts:292](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L292) *** @@ -18,7 +18,7 @@ Defined in: [src/airs/types.ts:291](https://github.com/cdot65/prisma-airs-cli/bl > **failedAttacks**: `number` -Defined in: [src/airs/types.ts:289](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L289) +Defined in: [src/airs/types.ts:290](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L290) *** @@ -26,7 +26,7 @@ Defined in: [src/airs/types.ts:289](https://github.com/cdot65/prisma-airs-cli/bl > **promptSets**: `object`[] -Defined in: [src/airs/types.ts:292](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L292) +Defined in: [src/airs/types.ts:293](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L293) #### promptSetId @@ -58,7 +58,7 @@ Defined in: [src/airs/types.ts:292](https://github.com/cdot65/prisma-airs-cli/bl > **score**: `number` -Defined in: [src/airs/types.ts:290](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L290) +Defined in: [src/airs/types.ts:291](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L291) *** @@ -66,7 +66,7 @@ Defined in: [src/airs/types.ts:290](https://github.com/cdot65/prisma-airs-cli/bl > **totalAttacks**: `number` -Defined in: [src/airs/types.ts:287](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L287) +Defined in: [src/airs/types.ts:288](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L288) *** @@ -74,7 +74,7 @@ Defined in: [src/airs/types.ts:287](https://github.com/cdot65/prisma-airs-cli/bl > **totalPrompts**: `number` -Defined in: [src/airs/types.ts:286](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L286) +Defined in: [src/airs/types.ts:287](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L287) *** @@ -82,4 +82,4 @@ Defined in: [src/airs/types.ts:286](https://github.com/cdot65/prisma-airs-cli/bl > **totalThreats**: `number` -Defined in: [src/airs/types.ts:288](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L288) +Defined in: [src/airs/types.ts:289](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L289) diff --git a/docs/developers/api/interfaces/RedTeamService.md b/docs/developers/api/interfaces/RedTeamService.md index d4589b9..f018b26 100644 --- a/docs/developers/api/interfaces/RedTeamService.md +++ b/docs/developers/api/interfaces/RedTeamService.md @@ -1,6 +1,6 @@ # Interface: RedTeamService -Defined in: [src/airs/types.ts:392](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L392) +Defined in: [src/airs/types.ts:393](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L393) Contract for AI Red Team scan operations. @@ -10,7 +10,7 @@ Contract for AI Red Team scan operations. > **abortScan**(`jobId`): `Promise`\<`void`\> -Defined in: [src/airs/types.ts:488](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L488) +Defined in: [src/airs/types.ts:489](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L489) Abort a running scan. @@ -30,7 +30,7 @@ Abort a running scan. > **acceptEula**(`eulaContent`): `Promise`\<`EulaStatus`\> -Defined in: [src/airs/types.ts:398](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L398) +Defined in: [src/airs/types.ts:399](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L399) Accept the EULA. @@ -50,7 +50,7 @@ Accept the EULA. > **createDevices**(`tenantId`, `request`): `Promise`\<`Record`\<`string`, `unknown`\>\> -Defined in: [src/airs/types.ts:409](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L409) +Defined in: [src/airs/types.ts:410](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L410) Create devices for an instance. @@ -74,7 +74,7 @@ Create devices for an instance. > **createInstance**(`request`): `Promise`\<`InstanceResponse`\> -Defined in: [src/airs/types.ts:401](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L401) +Defined in: [src/airs/types.ts:402](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L402) Create an instance. @@ -94,7 +94,7 @@ Create an instance. > **createScan**(`request`): `Promise`\<[`RedTeamJob`](RedTeamJob.md)\> -Defined in: [src/airs/types.ts:465](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L465) +Defined in: [src/airs/types.ts:466](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L466) Create a red team scan job. @@ -144,7 +144,7 @@ Create a red team scan job. > **createTarget**(`request`, `opts?`): `Promise`\<[`RedTeamTargetDetail`](RedTeamTargetDetail.md)\> -Defined in: [src/airs/types.ts:437](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L437) +Defined in: [src/airs/types.ts:438](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L438) Create a red team target. @@ -168,7 +168,7 @@ Create a red team target. > **deleteDevices**(`tenantId`, `serialNumbers`): `Promise`\<`Record`\<`string`, `unknown`\>\> -Defined in: [src/airs/types.ts:419](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L419) +Defined in: [src/airs/types.ts:420](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L420) Delete devices by serial numbers. @@ -192,7 +192,7 @@ Delete devices by serial numbers. > **deleteInstance**(`tenantId`): `Promise`\<`InstanceResponse`\> -Defined in: [src/airs/types.ts:407](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L407) +Defined in: [src/airs/types.ts:408](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L408) Delete an instance. @@ -212,7 +212,7 @@ Delete an instance. > **deleteTarget**(`uuid`): `Promise`\<`void`\> -Defined in: [src/airs/types.ts:450](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L450) +Defined in: [src/airs/types.ts:451](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L451) Delete a red team target. @@ -232,7 +232,7 @@ Delete a red team target. > **getCategories**(): `Promise`\<[`RedTeamCategory`](RedTeamCategory.md)[]\> -Defined in: [src/airs/types.ts:506](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L506) +Defined in: [src/airs/types.ts:507](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L507) List available attack categories. @@ -246,7 +246,7 @@ List available attack categories. > **getCustomReport**(`jobId`): `Promise`\<[`RedTeamCustomReport`](RedTeamCustomReport.md)\> -Defined in: [src/airs/types.ts:494](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L494) +Defined in: [src/airs/types.ts:495](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L495) Get custom attack report. @@ -266,7 +266,7 @@ Get custom attack report. > **getEulaContent**(): `Promise`\<`EulaContent`\> -Defined in: [src/airs/types.ts:394](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L394) +Defined in: [src/airs/types.ts:395](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L395) Get EULA content. @@ -280,7 +280,7 @@ Get EULA content. > **getEulaStatus**(): `Promise`\<`EulaStatus`\> -Defined in: [src/airs/types.ts:396](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L396) +Defined in: [src/airs/types.ts:397](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L397) Get EULA acceptance status. @@ -294,7 +294,7 @@ Get EULA acceptance status. > **getInstance**(`tenantId`): `Promise`\<`InstanceDetail`\> -Defined in: [src/airs/types.ts:403](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L403) +Defined in: [src/airs/types.ts:404](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L404) Get instance details. @@ -314,7 +314,7 @@ Get instance details. > **getRegistryCredentials**(): `Promise`\<`RegistryCredentials`\> -Defined in: [src/airs/types.ts:421](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L421) +Defined in: [src/airs/types.ts:422](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L422) Get or create registry credentials. @@ -328,7 +328,7 @@ Get or create registry credentials. > **getScan**(`jobId`): `Promise`\<[`RedTeamJob`](RedTeamJob.md)\> -Defined in: [src/airs/types.ts:477](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L477) +Defined in: [src/airs/types.ts:478](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L478) Get scan status by job ID. @@ -348,7 +348,7 @@ Get scan status by job ID. > **getStaticReport**(`jobId`): `Promise`\<[`RedTeamStaticReport`](RedTeamStaticReport.md)\> -Defined in: [src/airs/types.ts:491](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L491) +Defined in: [src/airs/types.ts:492](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L492) Get static scan report. @@ -368,7 +368,7 @@ Get static scan report. > **getTarget**(`uuid`): `Promise`\<[`RedTeamTargetDetail`](RedTeamTargetDetail.md)\> -Defined in: [src/airs/types.ts:434](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L434) +Defined in: [src/airs/types.ts:435](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L435) Get target details. @@ -388,7 +388,7 @@ Get target details. > **getTargetMetadata**(): `Promise`\<`Record`\<`string`, `unknown`\>\> -Defined in: [src/airs/types.ts:426](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L426) +Defined in: [src/airs/types.ts:427](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L427) Get target field metadata. @@ -402,7 +402,7 @@ Get target field metadata. > **getTargetProfile**(`uuid`): `Promise`\<`Record`\<`string`, `unknown`\>\> -Defined in: [src/airs/types.ts:456](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L456) +Defined in: [src/airs/types.ts:457](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L457) Get target profile. @@ -422,7 +422,7 @@ Get target profile. > **getTargetTemplates**(): `Promise`\<`Record`\<`string`, `unknown`\>\> -Defined in: [src/airs/types.ts:428](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L428) +Defined in: [src/airs/types.ts:429](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L429) Get provider-specific target templates. @@ -436,7 +436,7 @@ Get provider-specific target templates. > **listAttacks**(`jobId`, `opts?`): `Promise`\<\{ `attacks`: [`RedTeamAttack`](RedTeamAttack.md)[]; `totalItems?`: `number`; \}\> -Defined in: [src/airs/types.ts:497](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L497) +Defined in: [src/airs/types.ts:498](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L498) List attacks from a static/dynamic scan. @@ -466,7 +466,7 @@ List attacks from a static/dynamic scan. > **listCustomAttacks**(`jobId`, `opts?`): `Promise`\<[`RedTeamCustomAttack`](RedTeamCustomAttack.md)[]\> -Defined in: [src/airs/types.ts:503](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L503) +Defined in: [src/airs/types.ts:504](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L504) List attacks from a custom prompt set scan. @@ -492,7 +492,7 @@ List attacks from a custom prompt set scan. > **listScans**(`opts?`): `Promise`\<[`RedTeamJob`](RedTeamJob.md)[]\> -Defined in: [src/airs/types.ts:480](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L480) +Defined in: [src/airs/types.ts:481](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L481) List recent scans with optional filters. @@ -526,7 +526,7 @@ List recent scans with optional filters. > **listTargets**(): `Promise`\<[`RedTeamTarget`](RedTeamTarget.md)[]\> -Defined in: [src/airs/types.ts:431](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L431) +Defined in: [src/airs/types.ts:432](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L432) List configured red team targets. @@ -540,7 +540,7 @@ List configured red team targets. > **probeTarget**(`request`): `Promise`\<`Record`\<`string`, `unknown`\>\> -Defined in: [src/airs/types.ts:453](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L453) +Defined in: [src/airs/types.ts:454](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L454) Probe a target connection. @@ -560,7 +560,7 @@ Probe a target connection. > **updateDevices**(`tenantId`, `request`): `Promise`\<`Record`\<`string`, `unknown`\>\> -Defined in: [src/airs/types.ts:414](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L414) +Defined in: [src/airs/types.ts:415](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L415) Update devices (PATCH). @@ -584,7 +584,7 @@ Update devices (PATCH). > **updateInstance**(`tenantId`, `request`): `Promise`\<`InstanceResponse`\> -Defined in: [src/airs/types.ts:405](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L405) +Defined in: [src/airs/types.ts:406](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L406) Update an instance. @@ -608,7 +608,7 @@ Update an instance. > **updateTarget**(`uuid`, `request`, `opts?`): `Promise`\<[`RedTeamTargetDetail`](RedTeamTargetDetail.md)\> -Defined in: [src/airs/types.ts:443](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L443) +Defined in: [src/airs/types.ts:444](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L444) Update a red team target. @@ -636,7 +636,7 @@ Update a red team target. > **updateTargetProfile**(`uuid`, `request`): `Promise`\<`Record`\<`string`, `unknown`\>\> -Defined in: [src/airs/types.ts:459](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L459) +Defined in: [src/airs/types.ts:460](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L460) Update target profile. @@ -660,7 +660,7 @@ Update target profile. > **validateTargetAuth**(`request`): `Promise`\<`TargetAuthValidationResult`\> -Defined in: [src/airs/types.ts:424](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L424) +Defined in: [src/airs/types.ts:425](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L425) Validate target auth credentials. @@ -680,7 +680,7 @@ Validate target auth credentials. > **waitForCompletion**(`jobId`, `onProgress?`, `intervalMs?`): `Promise`\<[`RedTeamJob`](RedTeamJob.md)\> -Defined in: [src/airs/types.ts:509](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L509) +Defined in: [src/airs/types.ts:510](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L510) Poll until scan completes. Calls onProgress for status updates. diff --git a/docs/developers/api/interfaces/RedTeamStaticReport.md b/docs/developers/api/interfaces/RedTeamStaticReport.md index 0d69579..0ee59ce 100644 --- a/docs/developers/api/interfaces/RedTeamStaticReport.md +++ b/docs/developers/api/interfaces/RedTeamStaticReport.md @@ -1,6 +1,6 @@ # Interface: RedTeamStaticReport -Defined in: [src/airs/types.ts:265](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L265) +Defined in: [src/airs/types.ts:266](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L266) Normalized static report summary. @@ -10,7 +10,7 @@ Normalized static report summary. > `optional` **asr?**: `number` \| `null` -Defined in: [src/airs/types.ts:267](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L267) +Defined in: [src/airs/types.ts:268](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L268) *** @@ -18,7 +18,7 @@ Defined in: [src/airs/types.ts:267](https://github.com/cdot65/prisma-airs-cli/bl > **categories**: `object`[] -Defined in: [src/airs/types.ts:274](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L274) +Defined in: [src/airs/types.ts:275](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L275) #### asr @@ -50,7 +50,7 @@ Defined in: [src/airs/types.ts:274](https://github.com/cdot65/prisma-airs-cli/bl > `optional` **reportSummary?**: `string` \| `null` -Defined in: [src/airs/types.ts:273](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L273) +Defined in: [src/airs/types.ts:274](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L274) *** @@ -58,7 +58,7 @@ Defined in: [src/airs/types.ts:273](https://github.com/cdot65/prisma-airs-cli/bl > `optional` **score?**: `number` \| `null` -Defined in: [src/airs/types.ts:266](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L266) +Defined in: [src/airs/types.ts:267](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L267) *** @@ -66,7 +66,7 @@ Defined in: [src/airs/types.ts:266](https://github.com/cdot65/prisma-airs-cli/bl > **severityBreakdown**: `object`[] -Defined in: [src/airs/types.ts:268](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L268) +Defined in: [src/airs/types.ts:269](https://github.com/cdot65/prisma-airs-cli/blob/main/src/airs/types.ts#L269) #### failed diff --git a/src/airs/promptsets.ts b/src/airs/promptsets.ts index cb9bd77..13a602e 100644 --- a/src/airs/promptsets.ts +++ b/src/airs/promptsets.ts @@ -1,11 +1,11 @@ import { RedTeamClient, type RedTeamClientOptions } from '@cdot65/prisma-airs-sdk'; import type { + MutationResponse, PromptDetail, PromptSetDetail, PromptSetService, PromptSetVersionInfo, - PropertyName, - PropertyValue, + PropertyValueList, } from './types.js'; /** Normalize SDK prompt set response to PromptSetDetail. */ @@ -144,28 +144,28 @@ export class SdkPromptSetService implements PromptSetService { await this.client.customAttacks.deletePrompt(setUuid, promptUuid); } - async getPropertyNames(): Promise { + async getPropertyNames(): Promise { const response = await this.client.customAttacks.getPropertyNames(); - const raw = response as unknown as { data?: PropertyName[] }; + const raw = response as unknown as { data?: string[] }; return raw.data ?? []; } - async createPropertyName(name: string): Promise { + async createPropertyName(name: string): Promise { const response = await this.client.customAttacks.createPropertyName({ name } as never); - return response as unknown as PropertyName; + return response as unknown as MutationResponse; } - async getPropertyValues(name: string): Promise { + async getPropertyValues(name: string): Promise { const response = await this.client.customAttacks.getPropertyValues(name); - const raw = response as unknown as { data?: PropertyValue[] }; - return raw.data ?? []; + const raw = response as unknown as { name?: string; values?: string[] }; + return { name: raw.name ?? name, values: raw.values ?? [] }; } - async createPropertyValue(name: string, value: string): Promise { + async createPropertyValue(name: string, value: string): Promise { const response = await this.client.customAttacks.createPropertyValue({ property_name: name, property_value: value, }); - return response as unknown as PropertyValue; + return response as unknown as MutationResponse; } } diff --git a/src/airs/types.ts b/src/airs/types.ts index 909e168..38c8a59 100644 --- a/src/airs/types.ts +++ b/src/airs/types.ts @@ -112,13 +112,13 @@ export interface PromptSetService { /** Delete a prompt. */ deletePrompt(setUuid: string, promptUuid: string): Promise; /** List property names. */ - getPropertyNames(): Promise; + getPropertyNames(): Promise; /** Create a property name. */ - createPropertyName(name: string): Promise; + createPropertyName(name: string): Promise; /** Get values for a property. */ - getPropertyValues(name: string): Promise; + getPropertyValues(name: string): Promise; /** Create a property value. */ - createPropertyValue(name: string, value: string): Promise; + createPropertyValue(name: string, value: string): Promise; } // --------------------------------------------------------------------------- @@ -238,15 +238,16 @@ export interface PromptDetail { promptSetId: string; } -/** Property name entry. */ -export interface PropertyName { +/** Values for a single property name (SDK 0.10.0 shape). */ +export interface PropertyValueList { name: string; + values: string[]; } -/** Property value entry. */ -export interface PropertyValue { - name: string; - value: string; +/** Generic write-op response from custom-attack endpoints (SDK BaseResponseSchema). */ +export interface MutationResponse { + message: string; + status?: number; } /** Normalized attack category with subcategories. */ diff --git a/src/cli/commands/redteam.ts b/src/cli/commands/redteam.ts index bcd296d..8b20c5d 100644 --- a/src/cli/commands/redteam.ts +++ b/src/cli/commands/redteam.ts @@ -666,7 +666,7 @@ export function registerRedteamCommand(program: Command): void { renderRedteamHeader(); const service = await createPromptSetService(); const result = await service.createPropertyName(opts.name); - console.log(` Property created: ${result.name}\n`); + console.log(` ${result.message}\n`); } catch (err) { renderError(err instanceof Error ? err.message : String(err)); process.exit(1); @@ -700,7 +700,7 @@ export function registerRedteamCommand(program: Command): void { renderRedteamHeader(); const service = await createPromptSetService(); const result = await service.createPropertyValue(opts.name, opts.value); - console.log(` Value created: ${result.name}=${result.value}\n`); + console.log(` ${result.message}\n`); } catch (err) { renderError(err instanceof Error ? err.message : String(err)); process.exit(1); diff --git a/src/cli/renderer/redteam.ts b/src/cli/renderer/redteam.ts index efbb96d..c6404b9 100644 --- a/src/cli/renderer/redteam.ts +++ b/src/cli/renderer/redteam.ts @@ -538,22 +538,25 @@ export function renderPromptDetail(p: { } /** Render property names list. */ -export function renderPropertyNames( - names: Array<{ name: string }>, - format: OutputFormat = 'pretty', -): void { - if (names.length === 0) { - console.log(chalk.dim(' No property names found.\n')); +export function renderPropertyNames(names: string[], format: OutputFormat = 'pretty'): void { + if (format !== 'pretty') { + if (format === 'json') { + console.log(JSON.stringify(names, null, 2)); + } else if (format === 'yaml') { + console.log(yamlDump(names)); + } else { + const rows = names.map((n) => ({ name: n })); + console.log(formatOutput(rows, [{ key: 'name', label: 'Name' }], format)); + } return; } - if (format !== 'pretty') { - const rows = names.map((n) => ({ name: n.name })); - console.log(formatOutput(rows, [{ key: 'name', label: 'Name' }], format)); + if (names.length === 0) { + console.log(chalk.dim(' No property names found.\n')); return; } console.log(chalk.bold('\n Property Names:\n')); for (const n of names) { - console.log(` ${chalk.dim('•')} ${n.name}`); + console.log(` ${chalk.dim('•')} ${n}`); } console.log(); } @@ -602,26 +605,27 @@ export function renderEulaContent(content: { content: string }): void { console.log(` ${content.content}\n`); } -/** Render property values. */ +/** Render property values for a single property name. */ export function renderPropertyValues( - values: Array<{ name: string; value: string }>, + payload: { name: string; values: string[] }, format: OutputFormat = 'pretty', ): void { if (format !== 'pretty') { if (format === 'json') { - console.log(JSON.stringify(values, null, 2)); + console.log(JSON.stringify(payload, null, 2)); } else if (format === 'yaml') { - console.log(yamlDump(values)); + console.log(yamlDump(payload)); } return; } - if (values.length === 0) { + if (payload.values.length === 0) { console.log(chalk.dim(' No property values found.\n')); return; } console.log(chalk.bold('\n Property Values:\n')); - for (const v of values) { - console.log(` ${v.name}: ${chalk.dim(v.value)}`); + console.log(` ${chalk.dim('Property:')} ${payload.name}`); + for (const v of payload.values) { + console.log(` ${chalk.dim('•')} ${v}`); } console.log(); } diff --git a/src/index.ts b/src/index.ts index 8f91a0a..5b5626b 100644 --- a/src/index.ts +++ b/src/index.ts @@ -37,12 +37,12 @@ export type { ModelSecurityScanListOptions, ModelSecurityService, ModelSecurityViolation, + MutationResponse, PromptDetail, PromptSetDetail, PromptSetService, PromptSetVersionInfo, - PropertyName, - PropertyValue, + PropertyValueList, RedTeamAttack, RedTeamCategory, RedTeamCustomAttack, diff --git a/tests/unit/airs/promptsets.spec.ts b/tests/unit/airs/promptsets.spec.ts index c2d58fb..a6ed247 100644 --- a/tests/unit/airs/promptsets.spec.ts +++ b/tests/unit/airs/promptsets.spec.ts @@ -374,46 +374,63 @@ describe('SdkPromptSetService', () => { }); describe('getPropertyNames', () => { - it('returns property names', async () => { - mockGetPropertyNames.mockResolvedValue({ - data: [{ name: 'category' }, { name: 'severity' }], - }); + it('returns property names as a flat string array (SDK 0.10.0 shape)', async () => { + mockGetPropertyNames.mockResolvedValue({ data: ['category', 'severity'] }); const result = await service.getPropertyNames(); - expect(result).toEqual([{ name: 'category' }, { name: 'severity' }]); + expect(result).toEqual(['category', 'severity']); + }); + + it('returns empty array when SDK response has no data', async () => { + mockGetPropertyNames.mockResolvedValue({}); + const result = await service.getPropertyNames(); + expect(result).toEqual([]); }); }); describe('createPropertyName', () => { - it('creates and returns property name', async () => { - mockCreatePropertyName.mockResolvedValue({ name: 'priority' }); + it('returns the SDK mutation response (message + status)', async () => { + mockCreatePropertyName.mockResolvedValue({ + message: "Property name 'priority' created successfully", + status: 200, + }); const result = await service.createPropertyName('priority'); - expect(result).toEqual({ name: 'priority' }); + expect(result).toEqual({ + message: "Property name 'priority' created successfully", + status: 200, + }); expect(mockCreatePropertyName).toHaveBeenCalledWith({ name: 'priority' }); }); }); describe('getPropertyValues', () => { - it('returns property values', async () => { + it('returns {name, values[]} as a single object (SDK 0.10.0 shape)', async () => { mockGetPropertyValues.mockResolvedValue({ - data: [ - { name: 'category', value: 'security' }, - { name: 'category', value: 'safety' }, - ], + name: 'category', + values: ['security', 'safety'], }); const result = await service.getPropertyValues('category'); - expect(result).toEqual([ - { name: 'category', value: 'security' }, - { name: 'category', value: 'safety' }, - ]); + expect(result).toEqual({ name: 'category', values: ['security', 'safety'] }); expect(mockGetPropertyValues).toHaveBeenCalledWith('category'); }); + + it('coerces missing values to an empty array', async () => { + mockGetPropertyValues.mockResolvedValue({ name: 'category' }); + const result = await service.getPropertyValues('category'); + expect(result).toEqual({ name: 'category', values: [] }); + }); }); describe('createPropertyValue', () => { - it('sends property_name/property_value matching SDK schema', async () => { - mockCreatePropertyValue.mockResolvedValue({ name: 'category', value: 'compliance' }); + it('sends property_name/property_value and returns mutation response', async () => { + mockCreatePropertyValue.mockResolvedValue({ + message: "Property value 'compliance' created successfully", + status: 200, + }); const result = await service.createPropertyValue('category', 'compliance'); - expect(result).toEqual({ name: 'category', value: 'compliance' }); + expect(result).toEqual({ + message: "Property value 'compliance' created successfully", + status: 200, + }); expect(mockCreatePropertyValue).toHaveBeenCalledWith({ property_name: 'category', property_value: 'compliance', diff --git a/tests/unit/cli/redteam-output-flag.spec.ts b/tests/unit/cli/redteam-output-flag.spec.ts index 818f3d8..3a9fdf8 100644 --- a/tests/unit/cli/redteam-output-flag.spec.ts +++ b/tests/unit/cli/redteam-output-flag.spec.ts @@ -29,10 +29,8 @@ const sampleVersionInfo = { stats: { total: 42, active: 40, inactive: 2 }, }; -const sampleValues = [ - { name: 'persona', value: 'pirate' }, - { name: 'persona', value: 'doctor' }, -]; +const sampleValues = { name: 'persona', values: ['pirate', 'doctor'] }; +const sampleNames = ['persona', 'severity']; const sampleTarget = { uuid: 'tg-uuid-001', @@ -84,12 +82,12 @@ describe('renderPromptSetDetail --output', () => { }); describe('renderPropertyValues --output', () => { - it('emits JSON array when format=json', async () => { + it('emits JSON object with name + values[] when format=json', async () => { const { renderPropertyValues } = await import('../../../src/cli/renderer/redteam.js'); renderPropertyValues(sampleValues, 'json'); const parsed = JSON.parse(output.join('\n')); - expect(Array.isArray(parsed)).toBe(true); expect(parsed).toEqual(sampleValues); + expect(Array.isArray(parsed.values)).toBe(true); }); it('emits YAML when format=yaml', async () => { @@ -99,21 +97,54 @@ describe('renderPropertyValues --output', () => { expect(parsed).toEqual(sampleValues); }); - it('still renders pretty form when format=pretty', async () => { + it('renders pretty form with property name + bulleted values', async () => { const { renderPropertyValues } = await import('../../../src/cli/renderer/redteam.js'); renderPropertyValues(sampleValues, 'pretty'); const text = output.join('\n'); expect(text).toContain('Property Values'); expect(text).toContain('persona'); + expect(text).toContain('pirate'); + expect(text).toContain('doctor'); }); - it('prints empty-state message for empty list in pretty mode', async () => { + it('prints empty-state message when values list is empty in pretty mode', async () => { const { renderPropertyValues } = await import('../../../src/cli/renderer/redteam.js'); - renderPropertyValues([], 'pretty'); + renderPropertyValues({ name: 'persona', values: [] }, 'pretty'); expect(output.join('\n')).toContain('No property values'); }); }); +describe('renderPropertyNames --output', () => { + it('emits JSON string array when format=json', async () => { + const { renderPropertyNames } = await import('../../../src/cli/renderer/redteam.js'); + renderPropertyNames(sampleNames, 'json'); + const parsed = JSON.parse(output.join('\n')); + expect(parsed).toEqual(sampleNames); + }); + + it('emits YAML string list when format=yaml', async () => { + const { renderPropertyNames } = await import('../../../src/cli/renderer/redteam.js'); + renderPropertyNames(sampleNames, 'yaml'); + const parsed = yamlLoad(output.join('\n')); + expect(parsed).toEqual(sampleNames); + }); + + it('renders pretty form with bulleted names', async () => { + const { renderPropertyNames } = await import('../../../src/cli/renderer/redteam.js'); + renderPropertyNames(sampleNames, 'pretty'); + const text = output.join('\n'); + expect(text).toContain('Property Names'); + expect(text).toContain('persona'); + expect(text).toContain('severity'); + }); + + it('prints empty-state message for empty array in pretty mode', async () => { + const { renderPropertyNames } = await import('../../../src/cli/renderer/redteam.js'); + renderPropertyNames([], 'pretty'); + expect(output.join('\n')).toContain('No property names'); + }); +}); + describe('renderTargetDetail --output', () => { it('emits JSON with full target payload when format=json', async () => { const { renderTargetDetail } = await import('../../../src/cli/renderer/redteam.js');