Skip to content

fix(api): add module metadata for api_reference package - #45

Merged
jbeckwith-oai merged 2 commits into
mainfrom
castiron/promotions/pr-15-c112e934844e
Aug 3, 2026
Merged

fix(api): add module metadata for api_reference package#45
jbeckwith-oai merged 2 commits into
mainfrom
castiron/promotions/pr-15-c112e934844e

Conversation

@apcha-oai

@apcha-oai apcha-oai commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Summary

Add Go module declaration and a gitattributes entry for the api_reference package. These are metadata and formatting controls only and do not change any customer-visible SDK types, methods, or runtime behavior.

Changes

  • Add Go module declaration for the api_reference package (module github.com/openai/openai-cli/api_reference).
  • Add .gitattributes rule to treat openapi.transformed.yml with whitespace handling to control diffs/formatting.
  • No changes to the public SDK surface, API contracts, or runtime behavior.

Internal pull request: https://github.com/openai/openai-cli-internal/pull/15

Validation

  • Generated SDK changes were copied from the internal pull request.
  • Public SDK CI runs against this draft pull request.

Castiron-Internal-PR: openai/openai-cli-internal#15
Castiron-Source-SHA: c112e934844e7662d510c61751bcc8a41d28ee92
Castiron-Public-Base-SHA: 506a6bd
Copilot AI review requested due to automatic review settings August 3, 2026 17:20

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

This PR promotes generated CLI SDK artifacts into the public repository, adding metadata and configuration needed to track and manage the generated API reference output.

Changes:

  • Add a standalone Go module definition under api_reference/.
  • Add .gitattributes configuration for the transformed OpenAPI spec file.
  • Add Castiron generation metadata (.castiron.stats.yml) to record the generation inputs/outputs.

Reviewed changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated no comments.

File Description
api_reference/go.mod Introduces a nested Go module for the api_reference subtree.
api_reference/.gitattributes Configures Git attributes for openapi.transformed.yml within api_reference/.
.castiron.stats.yml Records codegen provenance (schema/config hashes and codegen SHA).
Suppressed comments (1)

api_reference/go.mod:2

  • api_reference/go.mod is missing a go directive. Without it, the module defaults to Go 1.16 semantics (e.g., different module graph pruning behavior) and go mod tidy will typically rewrite the file. The root go.mod already pins go 1.25.0, so aligning here avoids toolchain-dependent diffs.
module github.com/openai/openai-cli/api_reference


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@apcha-oai apcha-oai changed the title [castiron] promote CLI SDK changes chore(api): add module metadata for api_reference package Aug 3, 2026
@apcha-oai
apcha-oai marked this pull request as ready for review August 3, 2026 17:25
@apcha-oai
apcha-oai requested a review from a team as a code owner August 3, 2026 17:25
Copilot AI review requested due to automatic review settings August 3, 2026 22:27
@jbeckwith-oai
jbeckwith-oai enabled auto-merge August 3, 2026 22:27
@jbeckwith-oai
jbeckwith-oai disabled auto-merge August 3, 2026 22:28
@jbeckwith-oai jbeckwith-oai changed the title chore(api): add module metadata for api_reference package fix(api): add module metadata for api_reference package Aug 3, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 3 out of 4 changed files in this pull request and generated no new comments.

Suppressed comments (2)

api_reference/go.mod:2

  • This nested module’s go.mod is missing a go directive. Without it, the Go toolchain will assume legacy module semantics and go mod tidy on newer Go versions will typically add the directive anyway, creating avoidable churn. Align it with the repository’s Go version (see root go.mod:3).
module github.com/openai/openai-cli/api_reference

.castiron.stats.yml:3

  • PR description says the changes are limited to the api_reference module declaration and .gitattributes, but this PR also adds .castiron.stats.yml. Please either mention this file in the PR description/change list or drop it from the PR if it’s not intended to be committed.
schema_version: 1
generation_id: 8980ba38-7734-42cc-a876-8da69c2888c3
openapi_spec_hash: d342651bd77c6cd6ea10a9d889b35bb8

@jbeckwith-oai
jbeckwith-oai added this pull request to the merge queue Aug 3, 2026
Merged via the queue into main with commit 337a64f Aug 3, 2026
10 checks passed
@jbeckwith-oai
jbeckwith-oai deleted the castiron/promotions/pr-15-c112e934844e branch August 3, 2026 22:46
@openai-homebrew-releaser openai-homebrew-releaser Bot mentioned this pull request Aug 3, 2026
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.

3 participants