DOCS-1752 - Add OpenAI C2C source doc - #6975
Conversation
Adds documentation for the new OpenAI Cloud-to-Cloud source, covering setup of the Admin API Key and collection of Organization Usage Costs data.
|
This adds a new (Private Preview) OpenAI C2C source doc. Found two concrete issues by comparing the doc's JSON schema table against its own reference examples:
The row reads: I checked the raw bytes and confirmed those are typographic quotes (U+201C/U+201D — " "), not ASCII
The Configuration Object table says:
Minor completeness gap (not blocking): the Source configuration steps link Project IDs and API Key IDs to Everything else — the |
JV0812
left a comment
There was a problem hiding this comment.
The doc is well-structured overall, but the JSON schema table has two issues that would trip up anyone following it literally — see comment above for details. Please fix the smart quotes in the schemaRef row and reconcile pollingInterval's type/default/required status with the reference examples before merging.
Replaces smart quotes with straight quotes in the schemaRef JSON schema table row, and reconciles pollingInterval's type/default/required status with the reference examples.
|
@JV0812 Thanks for the catch — both issues are fixed in 719185e:
Left the Project IDs/API Key IDs |
JV0812
left a comment
There was a problem hiding this comment.
Confirmed both fixes directly against the PR head content: schemaRef now uses straight ASCII quotes, and pollingInterval is now Integer/Required: No/default 5, matching both reference examples (which now include the field). Verified with a clean local build. Approving.
|
|
||
| | Polling Interval | Data | | ||
| |:--|:--| | ||
| | 5 minutes | [Organization Costs](https://developers.openai.com/api/reference/resources/admin/subresources/organization/subresources/usage/methods/costs) | |
There was a problem hiding this comment.
Configurable 5 min for Audit endpoint
Fix 24 hrs for cost endpoint
| #### Prerequisites | ||
|
|
||
| - Requires an OpenAI API account with usage-based billing. New accounts receive a limited free credit grant. | ||
| - Admin API keys require an Organization Owner or Admin role. See [Rate limits](https://platform.openai.com/docs/guides/rate-limits) for tier details. |
There was a problem hiding this comment.
Wrong link ref shared
| | fields | JSON Object | No | `null` | JSON map of key-value fields (metadata) to apply to the Collector or source. Use the boolean field _siemForward to enable forwarding to SIEM.|`{"_siemForward": false, "fieldA": "valueA"}` | | ||
| | adminApiKey | String | Yes | `null` | OpenAI Admin API Key required for organization-level endpoints. | `sk-admin-` | | ||
| | projectIds | Array of String | No | `null` | Filter costs to specific project IDs. If empty, costs for all projects are returned. | | | ||
| | apiKeyIds | Array of String | No | `null` | Filter costs to specific API key IDs. If empty, costs for all API keys are returned. | | |
There was a problem hiding this comment.
Looks like it's an old config; please reverify with the latest main repo
https://github.com/jasklabs/c2c-openai/blob/main/TDD.md
Purpose of this pull request
This pull request adds documentation for the new OpenAI Cloud-to-Cloud source, covering setup of the Admin API Key and collection of Organization Usage Costs data from the OpenAI Administration API.
Select the type of change
Ticket (if applicable)
https://sumologic.atlassian.net/browse/DOCS-1752