Skip to content

docs: add Xquik OpenAPI example#186

Open
kriptoburak wants to merge 1 commit into
Oaklight:masterfrom
kriptoburak:feature/xquik-openapi-example
Open

docs: add Xquik OpenAPI example#186
kriptoburak wants to merge 1 commit into
Oaklight:masterfrom
kriptoburak:feature/xquik-openapi-example

Conversation

@kriptoburak

Copy link
Copy Markdown

Summary

  • Add an OpenAPI example that registers Xquik's public API spec with ToolRegistry.
  • Keep live API execution opt-in with XQUIK_RUN_EXAMPLE=1 and a user-provided XQUIK_API_KEY.
  • Show the discovered Xquik search tools after registration so users can verify setup without credentials.

Validation

  • uv run --extra dev --python /Users/burak/.local/bin/python3.11 ruff format examples/openapi_related/xquik_openapi_example.py
  • uv run --extra dev --python /Users/burak/.local/bin/python3.11 ruff check examples/openapi_related/xquik_openapi_example.py
  • /Users/burak/.local/bin/python3.11 -m py_compile examples/openapi_related/xquik_openapi_example.py
  • uv run --python /Users/burak/.local/bin/python3.11 --with-editable . python examples/openapi_related/xquik_openapi_example.py
  • git diff --check

AI assistance was used to prepare this contribution. I reviewed the diff and validation output.

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