fix(api): add module metadata for api_reference package - #45
Merged
Conversation
Castiron-Internal-PR: openai/openai-cli-internal#15 Castiron-Source-SHA: c112e934844e7662d510c61751bcc8a41d28ee92 Castiron-Public-Base-SHA: 506a6bd
There was a problem hiding this comment.
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
.gitattributesconfiguration 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.modis missing agodirective. Without it, the module defaults to Go 1.16 semantics (e.g., different module graph pruning behavior) andgo mod tidywill typically rewrite the file. The rootgo.modalready pinsgo 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
marked this pull request as ready for review
August 3, 2026 17:25
jbeckwith-oai
approved these changes
Aug 3, 2026
jbeckwith-oai
enabled auto-merge
August 3, 2026 22:27
jbeckwith-oai
disabled auto-merge
August 3, 2026 22:28
There was a problem hiding this comment.
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
godirective. Without it, the Go toolchain will assume legacy module semantics andgo mod tidyon 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
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
Internal pull request: https://github.com/openai/openai-cli-internal/pull/15
Validation