now icon indicating copy to clipboard operation
now copied to clipboard

docs: improve REST endpoint (swagger) documentation

Open fogx opened this issue 3 years ago • 1 comments

our current documentation for the rest endpoints is very sparse. The requests have many (optional) parameters, none of which are actually documented in the API page. Example: https://nowrun.jina.ai/api/v1/text-to-image/docs#/Text-To-Image/index_index_post

What is the host and port? Where do i get the jwt or api_key? tags for what? uris for what? etc.

{
  "host": "localhost",
  "port": 31080,
  "jwt": {},
  "api_key": "string",
  "tags": {},
  "uris": [
    "string"
  ],
  "images": [
    "string"
  ]
}

fogx avatar Sep 08 '22 14:09 fogx

please also rename the content variable - image: "string" doesn't make sense to me as a user. I would prefer base64_string or something more descriptive. And i would expect this to be the same value in all apis - not "song", "text", "image". What kind of "song"? what kind of "image"?

fogx avatar Sep 09 '22 11:09 fogx

In fact, I have no direction at all on what needs to be entered, what api_key is, and what uri needs to be, is there such a description please? Or you can operate it and send me the feasible json, maybe I can understand what is going on.

thread

fogx avatar Oct 31 '22 14:10 fogx