Skip to content

[NA] [SDK] [DOCS] Update automatically OpenAPI spec and Fern code - #7922

Open
CometActions wants to merge 1 commit into
mainfrom
github-actions/NA-automatically-update-openapi-spec-and-fern-code
Open

[NA] [SDK] [DOCS] Update automatically OpenAPI spec and Fern code#7922
CometActions wants to merge 1 commit into
mainfrom
github-actions/NA-automatically-update-openapi-spec-and-fern-code

Conversation

@CometActions

Copy link
Copy Markdown
Collaborator

Details

Automated daily update of OpenAPI spec and Fern code after running ./scripts/generate_openapi.sh and ./sdks/opik_optimizer/scripts/generate_fern_docs.py.

Change checklist

  • User facing changes
  • Documentation updated

Issues

N/A

Testing

  • Passed CI

Documentation

@CometActions
CometActions requested review from a team as code owners August 20, 2026 00:07
@github-actions github-actions Bot added documentation Improvements or additions to documentation python Pull requests that update Python code typescript *.ts *.tsx Python SDK TypeScript SDK 🟢 size/S labels Aug 20, 2026
@github-actions

github-actions Bot commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

⏱️ pre-commit per-hook timing

Hook Description Result Duration
📘 typecheck — typescript sdk Whole-project tsc type check 9.94s
📘 eslint — typescript sdk Lint + autofix JS/TS 1.07s
Total (2 ran) 11.01s
⏭️ 41 skipped (no matching files changed)
Hook Description Result
🐍 trim trailing whitespace — python sdk Strip trailing whitespace ⏭️
🐍 fix end of files — python sdk Ensure files end in a newline ⏭️
🐍 ruff — python sdk Lint + autofix Python (ruff) ⏭️
🐍 ruff-format — python sdk Format Python code (ruff) ⏭️
🐍 mypy — python sdk Static type check ⏭️
🤖 trim trailing whitespace — optimizer Strip trailing whitespace ⏭️
🤖 fix end of files — optimizer Ensure files end in a newline ⏭️
🤖 check yaml — optimizer Validate YAML syntax ⏭️
🤖 check json — optimizer Validate JSON syntax ⏭️
🤖 check toml — optimizer Validate TOML syntax ⏭️
🤖 check for added large files — optimizer Block large files (>1MB) ⏭️
🔐 detect private key — optimizer Block committed private keys ⏭️
🤖 check for merge conflicts — optimizer Block merge-conflict markers ⏭️
🤖 check for case conflicts — optimizer Block case-only name clashes ⏭️
🤖 pyupgrade — optimizer Modernize Python syntax ⏭️
🤖 ruff — optimizer Lint + autofix Python (ruff) ⏭️
🤖 ruff-format — optimizer Format Python code (ruff) ⏭️
🤖 mypy — optimizer Static type check ⏭️
📓 nbstripout — optimizer notebooks Strip notebook output ⏭️
📝 markdownlint — optimizer Lint Markdown ⏭️
🔤 codespell — optimizer Fix common misspellings ⏭️
📊 radon cc — optimizer Cyclomatic-complexity gate ⏭️
📊 radon raw — optimizer Raw size metrics gate ⏭️
📊 xenon — optimizer Fail on complexity thresholds ⏭️
📊 lizard — optimizer Cyclomatic-complexity gate ⏭️
🧹 vulture — optimizer Find dead code ⏭️
🛡️ trim trailing whitespace — guardrails Strip trailing whitespace ⏭️
🛡️ fix end of files — guardrails Ensure files end in a newline ⏭️
🛡️ ruff — guardrails Lint + autofix Python (ruff) ⏭️
🛡️ ruff-format — guardrails Format Python code (ruff) ⏭️
🛡️ mypy — guardrails Static type check ⏭️
⚓ helm-docs Regenerate Helm chart README ⏭️
block non-public FE plugins Block non-public FE plugins ⏭️
☕ spotless — java backend Format Java code ⏭️
🧪 pre-commit wrapper smoke tests Self-test the wrapper scripts ⏭️
🧪 rebaseline script tests Self-test the changelog re-baseline script ⏭️
🌐 eslint — frontend Lint + autofix JS/TS ⏭️
🌐 typecheck — frontend Whole-project tsc type check ⏭️
⚙️ actionlint — github workflows Lint GitHub Actions workflows ⏭️
🐳 hadolint — dockerfiles Lint Dockerfiles ⏭️
🌈 zizmor — github workflows security Security-scan GitHub Actions workflows ⏭️

@github-actions

github-actions Bot commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

🌿 Preview your docs: https://opik-preview-01a021a7-195d-75db-9726-298f4085d83d.docs.buildwithfern.com/docs/opik

No broken links found

Unverified links (timeout / rate-limited / server error — not failing the check)

https://aistudio.google.com/apikey (401)
↳ on page: /docs/opik/administration/workspace-settings/ai_providers
https://console.cloud.google.com/iam-admin/iam (401)
↳ on page: /docs/opik/administration/workspace-settings/ai_providers
https://console.cloud.google.com/iam-admin/roles (401)
↳ on page: /docs/opik/administration/workspace-settings/ai_providers
https://console.cloud.google.com/iam-admin/serviceaccounts (401)
↳ on page: /docs/opik/administration/workspace-settings/ai_providers
https://console.mistral.ai/api-keys/ (timeout)
↳ on page: /docs/opik/integrations/mistral
https://console.x.ai/ (403)
↳ on page: /docs/opik/integrations/xai-grok
https://docs.konghq.com/gateway/latest/ (timeout)
↳ on page: /docs/opik/integrations/kong-ai-gateway
https://docs.predibase.com/integrations/comet (403)
↳ on page: /docs/opik/integrations/predibase
https://fdr-prod-docs-files-public.s3.us-east-1.amazonaws.com/opik.docs.buildwithfern.com/3d3f24f6b09c56c508e10f61190c13d9c8094bd0a2b7dd0854425d74476d12a3/add_cookbook_banner.js?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA6KXJSKKNFOCF7G4B%2F20260821%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20260821T001122Z&X-Amz-Expires=604800&X-Amz-Signature=dbf6478a2686e9685d261a9b092757d9a01605914c77252f0bc141d23a07ddd6&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject (403)
↳ on page: /docs/opik/v1/reference/rest-api/runners/cancel-job
https://portal.azure.com/ (403)
↳ on page: /docs/opik/administration/workspace-settings/ai_providers
https://www.ibm.com/products/watsonx-ai (timeout)
↳ on page: /docs/opik/integrations/watsonx
https://www.together.ai/ (timeout)
↳ on page: /docs/opik/integrations/together-ai
https://x.ai/ (403)
↳ on page: /docs/opik/integrations/xai-grok


📌 Results for commit aa5c119

Comment on lines +7035 to +7039
description: "Retrieve prompt version. When project_name is supplied the lookup\
\ is scoped to that project: a prompt belonging to a different project is\
\ never matched, and an unknown project name returns 404. Legacy prompts with\
\ no project are still resolved as a deprecated fallback, signalled by the\
\ X-Opik-Deprecation response header."

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

searchPrompts can return another project’s version

The released TypeScript searchPrompts caller omits projectName from retrievePromptVersion({ name }) after workspace-wide listing, so duplicate prompt names can resolve to another project’s version and be returned under the configured project — should we pass the resolved project name or listed prompt’s project ID, or explicitly retain the documented legacy semantics?

Severity

Want Baz to fix this for you? Activate Fixer

Other fix methods

Fix in Cursor

Prompt for AI Agents
Before applying, verify this suggestion against the current code. In
`sdks/code_generation/fern/openapi/openapi.yaml` around lines 7035-7039, update the
TypeScript `searchPrompts` implementation that calls `retrievePromptVersion` to honor
the documented project-scoped lookup. Resolve the configured project name before
retrieval and pass it as `projectName` (or pass the project ID from the listed prompt)
instead of calling with only `{ name }`, and add or update a regression test covering
duplicate prompt names across projects.

Comment on lines +7035 to +7039
description: "Retrieve prompt version. When project_name is supplied the lookup\
\ is scoped to that project: a prompt belonging to a different project is\
\ never matched, and an unknown project name returns 404. Legacy prompts with\
\ no project are still resolved as a deprecated fallback, signalled by the\
\ X-Opik-Deprecation response header."

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing required AI disclosure metadata

The PR description omits the exact ## AI-WATERMARK section required by .agents/skills/documentation/SKILL.md, so this Fern/OpenAPI documentation change doesn't meet the repository PR-template requirement — should we add the completed yes/no disclosure and, when applicable, tools, models, scope, and human-verification details?

Severity

Want Baz to fix this for you? Activate Fixer You can also update your AI coding guidelines based on this comment by apply pr to [branch name]

Other fix methods

Fix in Cursor

Prompt for AI Agents
Before applying, verify this suggestion against the current code. In
apps/opik-documentation/documentation/fern/openapi/opik.yaml around lines 7035-7039,
update the associated pull request description to comply with
.agents/skills/documentation/SKILL.md. Add the exact `## AI-WATERMARK` section, complete
the required yes/no disclosure, and include the tools, models, scope, and
human-verification details when applicable; do not alter the OpenAPI description solely
to address this checklist finding.

@CometActions
CometActions force-pushed the github-actions/NA-automatically-update-openapi-spec-and-fern-code branch from da121b5 to 7bbba47 Compare August 21, 2026 00:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation Python SDK python Pull requests that update Python code 🟢 size/S TypeScript SDK typescript *.ts *.tsx

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant