[PR #14467] docs: add API options reference table with default values #45940

Open
opened 2026-04-25 01:32:15 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/ollama/ollama/pull/14467
Author: @Anandesh-Sharma
Created: 2/26/2026
Status: 🔄 Open

Base: mainHead: docs-api-options-defaults


📝 Commits (1)

  • 09a4af6 docs: add complete options reference table with defaults to API docs

📊 Changes

1 file changed (+24 additions, -2 deletions)

View changed files

📝 docs/api.md (+24 -2)

📄 Description

Summary

  • Adds a complete reference table of all valid options parameters to the API documentation, including descriptions, types, and default values
  • Removes deprecated options (penalize_newline, numa) from the example request that are no longer present in the codebase
  • Default values are sourced from api.DefaultOptions() in api/types.go

This helps developers using the API directly (not through a client library) understand what options are available and their defaults without having to read the source code.

Fixes #4937
Fixes #6045


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/ollama/ollama/pull/14467 **Author:** [@Anandesh-Sharma](https://github.com/Anandesh-Sharma) **Created:** 2/26/2026 **Status:** 🔄 Open **Base:** `main` ← **Head:** `docs-api-options-defaults` --- ### 📝 Commits (1) - [`09a4af6`](https://github.com/ollama/ollama/commit/09a4af614f46ea1127222bd2e7568ac325a1217a) docs: add complete options reference table with defaults to API docs ### 📊 Changes **1 file changed** (+24 additions, -2 deletions) <details> <summary>View changed files</summary> 📝 `docs/api.md` (+24 -2) </details> ### 📄 Description ## Summary - Adds a complete reference table of all valid `options` parameters to the API documentation, including descriptions, types, and default values - Removes deprecated options (`penalize_newline`, `numa`) from the example request that are no longer present in the codebase - Default values are sourced from `api.DefaultOptions()` in `api/types.go` This helps developers using the API directly (not through a client library) understand what options are available and their defaults without having to read the source code. Fixes #4937 Fixes #6045 --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-04-25 01:32:15 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/ollama#45940