Skip to content

Docs/02 schemas - #545

Merged
flsh86 merged 8 commits into
docs/01-foundationfrom
docs/02-schemas
Jul 29, 2026
Merged

Docs/02 schemas#545
flsh86 merged 8 commits into
docs/01-foundationfrom
docs/02-schemas

Conversation

@flsh86

@flsh86 flsh86 commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Schema derivation was explained (differently) in three structured-outputs pages and the agent-tools page. This PR gives it a single home and untangles the OpenAI structured-outputs page.

  • Add a shared page other/json-schemas.md: what problem a JSON Schema solves → the easiest way (derives from a case class) → customising the derived schema (Tapir) → building one manually. All provider pages link here instead of re-explaining derivation
  • Restructure openai/structured-outputs.md to a clear flow (typed createChatCompletionAs[T] → strict-mode normalization → lower-level ResponseFormat.JsonSchema) and extract the flight-booking function-tool walkthrough into a new dedicated openai/tool-calling.md — OpenAI previously was the only provider without a tool-calling page
  • Align claude/structured-outputs.md with the same flow (the section titled "Basic" was actually the lower-level path) and compile-check its manual-schema snippet
  • Link the Gemini structured-outputs and tool-calling pages to the shared schema page
  • Give the tool-definition preamble in agents/tools.md a proper heading and compile-check its example

flsh86 and others added 5 commits July 29, 2026 08:28
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@flsh86
flsh86 marked this pull request as ready for review July 29, 2026 08:50
@flsh86
flsh86 merged commit fe3f0e1 into master Jul 29, 2026
15 checks passed
@flsh86
flsh86 deleted the docs/02-schemas branch July 29, 2026 11:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant