From 92a761c0a567bc6fd16545cf3627724ccc1695d5 Mon Sep 17 00:00:00 2001
From: Jacob Payne <jacob@spectrocloud.com>
Date: Mon, 5 Jun 2023 15:25:21 -0700
Subject: [PATCH] documented remaining endpoints

---
 api/api.go    |  2 +-
 api/openai.go | 27 +++++++++++++++++++++++++++
 2 files changed, 28 insertions(+), 1 deletion(-)

diff --git a/api/api.go b/api/api.go
index e47fe24e..7d28801e 100644
--- a/api/api.go
+++ b/api/api.go
@@ -3,7 +3,7 @@ package api
 import (
 	"errors"
 
-	_ "github.com/go-skynet/LocalAI/docs/swagger"
+	_ "github.com/go-skynet/LocalAI/docs"
 	model "github.com/go-skynet/LocalAI/pkg/model"
 	"github.com/gofiber/fiber/v2"
 	"github.com/gofiber/fiber/v2/middleware/cors"
diff --git a/api/openai.go b/api/openai.go
index c106be5c..af2db959 100644
--- a/api/openai.go
+++ b/api/openai.go
@@ -440,6 +440,22 @@ func chatEndpoint(cm ConfigMerger, debug bool, loader *model.ModelLoader, thread
 	}
 }
 
+// OpenAI CHAT API endpoint for editing model parameters
+// editEndpoint mimics the /edits endpoint for local models
+// @Summary Modify model parameters
+// @Description Alter model parameters for text completion models.
+// @Tags Chat
+// @Accept json
+// @Produce json
+// @Param model body string true "Define which model to modify."
+// @Param instruction body string true "Define the initial prompt for the model."
+// @Param input body string true "Initial input prompt for model."
+// @Param stop body string true "Define stop words for the model to reply after."
+// @Success 200 {object} OpenAIResponse
+// @Failure 400 {object} APIError
+// @Failure 401 {object} APIError
+// @Failure 500 {object} APIError
+// @Router /edits [post]
 func editEndpoint(cm ConfigMerger, debug bool, loader *model.ModelLoader, threads, ctx int, f16 bool) func(c *fiber.Ctx) error {
 	return func(c *fiber.Ctx) error {
 		config, input, err := readConfig(cm, c, loader, debug, threads, ctx, f16)
@@ -487,6 +503,17 @@ func editEndpoint(cm ConfigMerger, debug bool, loader *model.ModelLoader, thread
 	}
 }
 
+// OpenAI CHAT API endpoint for listing loaded models
+// listModels mimics the /models endpoint for listing loaded local models
+// @Summary Get a list of all currently loaded models
+// @Description List all currently loaded models.
+// @Tags Chat
+// @Produce json
+// @Success 200 {object} OpenAIResponse
+// @Failure 400 {object} APIError
+// @Failure 401 {object} APIError
+// @Failure 500 {object} APIError
+// @Router /models [get]
 func listModels(loader *model.ModelLoader, cm ConfigMerger) func(ctx *fiber.Ctx) error {
 	return func(c *fiber.Ctx) error {
 		models, err := loader.ListModels()