docs: fix openapi.yaml warnings, rename api.md to api-reference.md (#12904)

This commit is contained in:
Jeffrey Morgan
2025-11-11 15:39:35 -08:00
committed by GitHub
parent 15968714bd
commit 2d5e066c8c
2 changed files with 21 additions and 8 deletions

View File

@@ -2,12 +2,15 @@ openapi: 3.1.0
info: info:
title: Ollama API title: Ollama API
version: 0.1.0 version: 0.1.0
license:
name: MIT
url: https://opensource.org/licenses/MIT
description: | description: |
OpenAPI specification for the Ollama HTTP API OpenAPI specification for the Ollama HTTP API
servers: servers:
- url: http://localhost:11434 - url: http://localhost:11434
description: Local Ollama instance description: Ollama
security: []
components: components:
securitySchemes: securitySchemes:
bearerAuth: bearerAuth:
@@ -93,8 +96,11 @@ components:
type: boolean type: boolean
default: true default: true
think: think:
type: boolean oneOf:
description: When true, returns separate thinking output in addition to content - type: boolean
- type: string
enum: [high, medium, low]
description: When true, returns separate thinking output in addition to content. Can be a boolean (true/false) or a string ("high", "medium", "low") for supported models.
raw: raw:
type: boolean type: boolean
description: When true, returns the raw response from the model without any prompt templating description: When true, returns the raw response from the model without any prompt templating
@@ -271,8 +277,11 @@ components:
type: boolean type: boolean
default: true default: true
think: think:
type: boolean oneOf:
description: When true, returns separate thinking output in addition to content - type: boolean
- type: string
enum: [high, medium, low]
description: When true, returns separate thinking output in addition to content. Can be a boolean (true/false) or a string ("high", "medium", "low") for supported models.
keep_alive: keep_alive:
oneOf: oneOf:
- type: string - type: string
@@ -310,7 +319,6 @@ components:
type: array type: array
items: items:
type: string type: string
nullable: true
description: Optional base64-encoded images in the response description: Optional base64-encoded images in the response
done: done:
type: boolean type: boolean
@@ -367,7 +375,6 @@ components:
type: array type: array
items: items:
type: string type: string
nullable: true
description: Partial base64-encoded images, when present description: Partial base64-encoded images, when present
done: done:
type: boolean type: boolean
@@ -543,6 +550,9 @@ components:
license: license:
type: string type: string
description: The license of the model description: The license of the model
modified_at:
type: string
description: Last modified timestamp in ISO 8601 format
details: details:
type: object type: object
description: High-level model details description: High-level model details
@@ -622,6 +632,9 @@ components:
size_vram: size_vram:
type: integer type: integer
description: VRAM usage in bytes description: VRAM usage in bytes
context_length:
type: integer
description: Context length for the running model
PsResponse: PsResponse:
type: object type: object
properties: properties: