openapi(api-keys): document reset_usage on update and align examples#538
Draft
akhilmmenon wants to merge 303 commits intoopenai:masterfrom
Draft
openapi(api-keys): document reset_usage on update and align examples#538akhilmmenon wants to merge 303 commits intoopenai:masterfrom
akhilmmenon wants to merge 303 commits intoopenai:masterfrom
Conversation
feat: adding log export routes
Log Export Filter Schema
…y from api-keys object
chore: add workspace_ids to users and remove created_by and updated_b…
chore: log exports spec changes - make workspace optional
feat: workspace delete spec
Feat: analytics api
Feat: api key options in invites
Change summary for createFile operation
Further changes createFile summary
update summary for fine-tuning
Add openapi spec for mcp gateway
chore: policy entities
feat: add default provider options to integration workspace access in…
changes in guardrail api and api key creation api
Update Mintlify workflow to trigger on push to master instead of pull request merge
updated analytics api
…o OpenAPI spec for workspace-scoped integrations
…tions-for-ws-integrations feat: add create_default_provider and default_provider_slug options t…
chore: document behvaiour of prompt patch and updates
…t-workspaces-query feat: add status query parameter to filter workspaces by active or ar…
feat: secret references
chore: secret mappings
chore: realtime endpoint addition
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
reset_usagetoUpdateApiKeyObjectforPUT /api-keys/{id}.reset_usageas a boolean with clear behavior: resets current usage and can reactivate exhausted keys.{"reset_usage": true}PUTinstead ofGET.Why
The reset usage flow is already supported, but it was not clearly discoverable in the OpenAPI docs for API key updates. This change makes the behavior explicit and provides a minimal testable example.
Merge Timing
This PR should remain open for now. We are waiting to merge it after the rotate endpoint is Generally Available.
Scope Note
Please ensure this PR includes rotate endpoint OpenAPI updates as well (along with the
reset_usagedocumentation updates).Test Plan
redocly lintor equivalent project validation).PUT /api-keys/{id}request schema includesreset_usage.PUT /api-keys/{id}examples include{"reset_usage": true}.-X PUT.