From becec0d501e8aaacacae67ac4aeeab26b3a4c093 Mon Sep 17 00:00:00 2001
From: OlivierDehaene <23298448+OlivierDehaene@users.noreply.github.com>
Date: Thu, 9 Mar 2023 15:15:51 +0100
Subject: [PATCH] update schema

---
 docs/openapi.json | 20 +++++++++++++++-----
 router/src/lib.rs | 10 +++++-----
 2 files changed, 20 insertions(+), 10 deletions(-)

diff --git a/docs/openapi.json b/docs/openapi.json
index 8ddaabac..881b892c 100644
--- a/docs/openapi.json
+++ b/docs/openapi.json
@@ -241,7 +241,8 @@
           "seed": {
             "type": "integer",
             "format": "int64",
-            "example": 42
+            "example": 42,
+            "nullable": true
           },
           "tokens": {
             "type": "array",
@@ -283,7 +284,8 @@
           "seed": {
             "type": "integer",
             "format": "int64",
-            "example": 42
+            "example": 42,
+            "nullable": true
           },
           "tokens": {
             "type": "array",
@@ -352,8 +354,9 @@
           },
           "return_full_text": {
             "type": "boolean",
-            "default": "None",
-            "example": false
+            "default": "null",
+            "example": false,
+            "nullable": true
           },
           "seed": {
             "type": "integer",
@@ -398,6 +401,12 @@
             "maximum": 1.0,
             "exclusiveMinimum": 0.0
           },
+          "truncate": {
+            "type": "integer",
+            "default": "null",
+            "example": "null",
+            "nullable": true
+          },
           "typical_p": {
             "type": "number",
             "format": "float",
@@ -487,7 +496,8 @@
           "seed": {
             "type": "integer",
             "format": "int64",
-            "example": 42
+            "example": 42,
+            "nullable": true
           }
         }
       },
diff --git a/router/src/lib.rs b/router/src/lib.rs
index 3873a3b5..91b4417c 100644
--- a/router/src/lib.rs
+++ b/router/src/lib.rs
@@ -59,13 +59,13 @@ pub(crate) struct GenerateParameters {
     #[schema(exclusive_minimum = 0, exclusive_maximum = 512, default = "20")]
     pub max_new_tokens: u32,
     #[serde(default)]
-    #[schema(default = "null", example = false)]
+    #[schema(nullable = true, default = "null", example = false)]
     pub return_full_text: Option<bool>,
     #[serde(default)]
     #[schema(inline, max_items = 4, example = json ! (["photographer"]))]
     pub stop: Vec<String>,
     #[serde(default)]
-    #[schema(default = "null", example = "null")]
+    #[schema(nullable = true, default = "null", example = "null")]
     pub truncate: Option<usize>,
     #[serde(default)]
     #[schema(default = "false", example = true)]
@@ -176,7 +176,7 @@ pub(crate) struct BestOfSequence {
     pub finish_reason: FinishReason,
     #[schema(example = 1)]
     pub generated_tokens: u32,
-    #[schema(example = 42)]
+    #[schema(nullable = true, example = 42)]
     pub seed: Option<u64>,
     pub prefill: Vec<PrefillToken>,
     pub tokens: Vec<Token>,
@@ -188,7 +188,7 @@ pub(crate) struct Details {
     pub finish_reason: FinishReason,
     #[schema(example = 1)]
     pub generated_tokens: u32,
-    #[schema(example = 42)]
+    #[schema(nullable = true, example = 42)]
     pub seed: Option<u64>,
     pub prefill: Vec<PrefillToken>,
     pub tokens: Vec<Token>,
@@ -210,7 +210,7 @@ pub(crate) struct StreamDetails {
     pub finish_reason: FinishReason,
     #[schema(example = 1)]
     pub generated_tokens: u32,
-    #[schema(example = 42)]
+    #[schema(nullable = true, example = 42)]
     pub seed: Option<u64>,
 }