Skip to content

Commit 63afee3

Browse files
b4s36t4b4s36t4
authored
Merge pull request #121 from swapnilroy-cell/swapnilroy/openapi
changes in guardrail api and api key creation api
2 parents 363fad0 + 6257663 commit 63afee3

1 file changed

Lines changed: 126 additions & 0 deletions

File tree

‎openapi.yaml‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2000,6 +2000,18 @@ paths:
20002000
onFail: "block"
20012001
message: "Model not in approved whitelist"
20022002

2003+
allowed_request_types:
2004+
summary: "[BASIC] Restrict to Chat and Embed Only"
2005+
value:
2006+
name: "Restrict to Chat and Embed Only"
2007+
checks:
2008+
- id: "default.allowedRequestTypes"
2009+
parameters:
2010+
allowedTypes: ["chatComplete", "embed"]
2011+
actions:
2012+
on_fail: "deny"
2013+
on_success: "continue"
2014+
20032015
case_validation:
20042016
summary: "[BASIC] Case Validation Checks"
20052017
value:
@@ -32940,6 +32952,9 @@ components:
3294032952

3294132953
CreateApiKeyObject:
3294232954
type: object
32955+
required:
32956+
- name
32957+
- scopes
3294332958
properties:
3294432959
name:
3294532960
type: string
@@ -33202,6 +33217,7 @@ components:
3320233217
- "default.endsWith"
3320333218
- "default.alluppercase"
3320433219
- "default.requiredMetadataKeys"
33220+
- "default.allowedRequestTypes"
3320533221
# PRO category guardrails
3320633222
- "portkey.moderateContent"
3320733223
- "portkey.language"
@@ -33250,6 +33266,7 @@ components:
3325033266
- $ref: '#/components/schemas/EndsWithParameters'
3325133267
- $ref: '#/components/schemas/UppercaseParameters'
3325233268
- $ref: '#/components/schemas/RequiredMetadataKeysParameters'
33269+
- $ref: '#/components/schemas/AllowedRequestTypesParameters'
3325333270
- $ref: '#/components/schemas/SydeGuardParameters'
3325433271
- $ref: '#/components/schemas/AporiaParameters'
3325533272
- $ref: '#/components/schemas/PillarScanParameters'
@@ -33389,6 +33406,7 @@ components:
3338933406

3339033407
# Detailed parameter schemas for specific guardrail types
3339133408
JWTParameters:
33409+
title: JWT Parameters
3339233410
type: object
3339333411
required:
3339433412
- jwksUri
@@ -33421,6 +33439,7 @@ components:
3342133439
default: ["RS256"]
3342233440

3342333441
RegexMatchParameters:
33442+
title: Regex Match Parameters
3342433443
type: object
3342533444
required:
3342633445
- rule
@@ -33434,6 +33453,7 @@ components:
3343433453
default: false
3343533454

3343633455
ModelWhitelistParameters:
33456+
title: Model Whitelist Parameters
3343733457
type: object
3343833458
required:
3343933459
- models
@@ -33445,6 +33465,7 @@ components:
3344533465
description: List of allowed models
3344633466

3344733467
WordCountParameters:
33468+
title: Word Count Parameters
3344833469
type: object
3344933470
properties:
3345033471
minWords:
@@ -33461,6 +33482,7 @@ components:
3346133482
default: false
3346233483

3346333484
SentenceCountParameters:
33485+
title: Sentence Count Parameters
3346433486
type: object
3346533487
properties:
3346633488
minSentences:
@@ -33477,6 +33499,7 @@ components:
3347733499
default: false
3347833500

3347933501
CharacterCountParameters:
33502+
title: Character Count Parameters
3348033503
type: object
3348133504
properties:
3348233505
minCharacters:
@@ -33493,6 +33516,7 @@ components:
3349333516
default: false
3349433517

3349533518
JSONSchemaParameters:
33519+
title: JSON Schema Parameters
3349633520
type: object
3349733521
required:
3349833522
- schema
@@ -33507,6 +33531,7 @@ components:
3350733531
default: false
3350833532

3350933533
JSONKeysParameters:
33534+
title: JSON Keys Parameters
3351033535
type: object
3351133536
required:
3351233537
- keys
@@ -33524,6 +33549,7 @@ components:
3352433549
default: "any"
3352533550

3352633551
ContainsParameters:
33552+
title: Contains Parameters
3352733553
type: object
3352833554
required:
3352933555
- words
@@ -33541,6 +33567,7 @@ components:
3354133567
default: "any"
3354233568

3354333569
ValidUrlsParameters:
33570+
title: Valid URLs Parameters
3354433571
type: object
3354533572
properties:
3354633573
onlyDNS:
@@ -33553,6 +33580,7 @@ components:
3355333580
default: false
3355433581

3355533582
ContainsCodeParameters:
33583+
title: Contains Code Parameters
3355633584
type: object
3355733585
required:
3355833586
- format
@@ -33592,6 +33620,7 @@ components:
3359233620
default: false
3359333621

3359433622
WebhookParameters:
33623+
title: Webhook Parameters
3359533624
type: object
3359633625
required:
3359733626
- webhookURL
@@ -33614,6 +33643,7 @@ components:
3361433643
default: false
3361533644

3361633645
EndsWithParameters:
33646+
title: Ends With Parameters
3361733647
type: object
3361833648
required:
3361933649
- suffix
@@ -33627,6 +33657,7 @@ components:
3362733657
default: false
3362833658

3362933659
UppercaseParameters:
33660+
title: Uppercase Parameters
3363033661
type: object
3363133662
properties:
3363233663
not:
@@ -33635,6 +33666,7 @@ components:
3363533666
default: false
3363633667

3363733668
RequiredMetadataKeysParameters:
33669+
title: Required Metadata Keys Parameters
3363833670
type: object
3363933671
required:
3364033672
- metadataKeys
@@ -33651,7 +33683,86 @@ components:
3365133683
description: Operator to use for key checking
3365233684
default: "all"
3365333685

33686+
AllowedRequestTypesParameters:
33687+
title: Allowed Request Types Parameters
33688+
type: object
33689+
description: Parameters for default.allowedRequestTypes check. Restrict which request types are allowed or blocked. You can use either or both; when both are specified, blocked types take precedence.
33690+
properties:
33691+
allowedTypes:
33692+
type: array
33693+
items:
33694+
type: string
33695+
enum:
33696+
- complete
33697+
- chatComplete
33698+
- embed
33699+
- rerank
33700+
- moderate
33701+
- proxy
33702+
- imageGenerate
33703+
- createSpeech
33704+
- createTranscription
33705+
- createTranslation
33706+
- realtime
33707+
- uploadFile
33708+
- listFiles
33709+
- retrieveFile
33710+
- deleteFile
33711+
- retrieveFileContent
33712+
- createBatch
33713+
- retrieveBatch
33714+
- cancelBatch
33715+
- listBatches
33716+
- getBatchOutput
33717+
- listFinetunes
33718+
- createFinetune
33719+
- retrieveFinetune
33720+
- cancelFinetune
33721+
- createModelResponse
33722+
- getModelResponse
33723+
- deleteModelResponse
33724+
- listResponseInputItems
33725+
- messages
33726+
description: Request types to allow (allowlist). When set, only these request types are permitted.
33727+
blockedTypes:
33728+
type: array
33729+
items:
33730+
type: string
33731+
enum:
33732+
- complete
33733+
- chatComplete
33734+
- embed
33735+
- rerank
33736+
- moderate
33737+
- proxy
33738+
- imageGenerate
33739+
- createSpeech
33740+
- createTranscription
33741+
- createTranslation
33742+
- realtime
33743+
- uploadFile
33744+
- listFiles
33745+
- retrieveFile
33746+
- deleteFile
33747+
- retrieveFileContent
33748+
- createBatch
33749+
- retrieveBatch
33750+
- cancelBatch
33751+
- listBatches
33752+
- getBatchOutput
33753+
- listFinetunes
33754+
- createFinetune
33755+
- retrieveFinetune
33756+
- cancelFinetune
33757+
- createModelResponse
33758+
- getModelResponse
33759+
- deleteModelResponse
33760+
- listResponseInputItems
33761+
- messages
33762+
description: Request types to block (blocklist). When set, these request types are denied.
33763+
3365433764
SydeGuardParameters:
33765+
title: SydeGuard Parameters
3365533766
type: object
3365633767
properties:
3365733768
prompt_injection_threshold:
@@ -33681,6 +33792,7 @@ components:
3368133792
default: 5000
3368233793

3368333794
AporiaParameters:
33795+
title: Aporia Parameters
3368433796
type: object
3368533797
required:
3368633798
- projectID
@@ -33694,6 +33806,7 @@ components:
3369433806
default: 5000
3369533807

3369633808
PillarScanParameters:
33809+
title: Pillar Scan Parameters
3369733810
type: object
3369833811
required:
3369933812
- scanners
@@ -33715,6 +33828,7 @@ components:
3371533828
default: 5000
3371633829

3371733830
PatronusParameters:
33831+
title: Patronus Parameters
3371833832
type: object
3371933833
properties:
3372033834
redact:
@@ -33727,6 +33841,7 @@ components:
3372733841
default: 5000
3372833842

3372933843
PatronusCustomParameters:
33844+
title: Patronus Custom Parameters
3373033845
type: object
3373133846
required:
3373233847
- profile
@@ -33740,6 +33855,7 @@ components:
3374033855
default: 15000
3374133856

3374233857
PortkeyModerationParameters:
33858+
title: Portkey Moderation Parameters
3374333859
type: object
3374433860
required:
3374533861
- categories
@@ -33767,6 +33883,7 @@ components:
3376733883
default: 5000
3376833884

3376933885
PortkeyLanguageParameters:
33886+
title: Portkey Language Parameters
3377033887
type: object
3377133888
properties:
3377233889
language:
@@ -33832,6 +33949,7 @@ components:
3383233949
default: 5000
3383333950

3383433951
PortkeyPIIParameters:
33952+
title: Portkey PII Parameters
3383533953
type: object
3383633954
required:
3383733955
- categories
@@ -33859,6 +33977,7 @@ components:
3385933977
default: 5000
3386033978

3386133979
MistralModerationParameters:
33980+
title: Mistral Moderation Parameters
3386233981
type: object
3386333982
required:
3386433983
- categories
@@ -33884,6 +34003,7 @@ components:
3388434003
default: 5000
3388534004

3388634005
BedrockGuardParameters:
34006+
title: Bedrock Guard Parameters
3388734007
type: object
3388834008
required:
3388934009
- guardrailVersion
@@ -33905,6 +34025,7 @@ components:
3390534025
default: 5000
3390634026

3390734027
PromptfooParameters:
34028+
title: Promptfoo Parameters
3390834029
type: object
3390934030
properties:
3391034031
redact:
@@ -33917,6 +34038,7 @@ components:
3391734038
default: 5000
3391834039

3391934040
AcuvityScanParameters:
34041+
title: Acuvity Scan Parameters
3392034042
type: object
3392134043
properties:
3392234044
prompt_injection:
@@ -34057,6 +34179,7 @@ components:
3405734179
default: 5000
3405834180

3405934181
AzureContentSafetyParameters:
34182+
title: Azure Content Safety Parameters
3406034183
type: object
3406134184
properties:
3406234185
blocklistNames:
@@ -34085,6 +34208,7 @@ components:
3408534208
default: 5000
3408634209

3408734210
AzurePIIParameters:
34211+
title: Azure PII Parameters
3408834212
type: object
3408934213
properties:
3409034214
domain:
@@ -34110,6 +34234,7 @@ components:
3411034234
default: 5000
3411134235

3411234236
PANWPrismaParameters:
34237+
title: PANW Prisma Parameters
3411334238
type: object
3411434239
required:
3411534240
- profile_name
@@ -34125,6 +34250,7 @@ components:
3412534250
description: Application user identifier
3412634251

3412734252
BasicParameters:
34253+
title: Basic Parameters
3412834254
type: object
3412934255
description: Basic parameters with no specific requirements
3413034256
additionalProperties: true

0 commit comments

Comments
 (0)