From d521e03d07a3cf937257fef8f74ea138fdcea65c Mon Sep 17 00:00:00 2001
From: Evaline Ju <69598118+evaline-ju@users.noreply.github.com>
Date: Fri, 4 Oct 2024 09:23:13 -0600
Subject: [PATCH] :wrench: Add detector_params as optional for every detectors
 endpoint (#212)

Signed-off-by: Evaline Ju <69598118+evaline-ju@users.noreply.github.com>
---
 docs/api/openapi_detector_api.yaml | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/docs/api/openapi_detector_api.yaml b/docs/api/openapi_detector_api.yaml
index 11857461..9bd96f0d 100644
--- a/docs/api/openapi_detector_api.yaml
+++ b/docs/api/openapi_detector_api.yaml
@@ -232,6 +232,11 @@ components:
             allOf:
               - $ref: https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml#/components/schemas/ChatCompletionRequestMessage
               - type: object
+        detector_params:
+          type: object
+          default: {}
+          title: Detector Parameters
+          description: Optional detector parameters, used on a per-detector basis
       type: object
       required:
         - messages
@@ -284,6 +289,9 @@ components:
             - https://research.ibm.com/
         detector_params:
           type: object
+          default: {}
+          title: Detector Parameters
+          description: Optional detector parameters, used on a per-detector basis
       type: object
       required:
         - content
@@ -407,6 +415,11 @@ components:
           title: Generated Text
           description: Generated response from the LLM
           example: Some text generated by an LLM
+        detector_params:
+          type: object
+          default: {}
+          title: Detector Parameters
+          description: Optional detector parameters, used on a per-detector basis
       type: object
       required:
         - prompt
@@ -461,6 +474,11 @@ components:
             example: >-
               Your email is test@ibm.com! Only the next instance of email will be
               processed. test@ibm.com. Your SSN is 123-45-6789.
+        detector_params:
+          type: object
+          default: {}
+          title: Detector Parameters
+          description: Optional detector parameters, used on a per-detector basis
       type: object
       required:
         - contents