Repository navigation
feat: describe bot API enums with their wire values - #257
Merged
0xF6 merged 1 commit intoOct 28, 2026
Merged
Conversation
Contributor
|
Contributor License Agreement — signed. All contributors to this pull request have signed the CLA: @omnifaced. |
Codecov Report❌ Patch coverage is 📢 Thoughts on this report? Let us know! |
omnifaced
force-pushed
the
feat/bot-api-machine-readable-enums
branch
2 times, most recently
from
October 28, 2026 00:35
2839154 to
20b74e8
Compare
The docs manifest gave enums as bare names under `type: string`, and the OpenAPI document gave number enums as a plain `integer`. Both serializers write those enums as numbers, so a client built from either description sent `"bold"` where the server reads 10, and read user flags and entitlements as names where bitmasks arrive. - The manifest has a top-level `enums` list: wire format (`number` or `string`), underlying type, whether it is a flags enum, and each member's number. Enum fields reference it through `enumType`, and their `type` is the JSON type that travels. `enumValues` keeps its camelCase names, so the docs site reads it as before. Union variants also carry their discriminator's number. - OpenAPI lists number enum values in `enum` with `x-enum-varnames`, and flags enums map names to bits in `x-argon-flags`. Ion enums are unsigned, and the writer silently drops ulong nodes, so values are written as long. - The IEvents/v1/Stream body is a server-sent event stream whose `data:` is the bare payload, not the BotSseEvent envelope the route declares. Bumps docs/bot-api-docs to the regenerated description.
omnifaced
force-pushed
the
feat/bot-api-machine-readable-enums
branch
from
October 28, 2026 07:43
20b74e8 to
32889cb
Compare
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.
The docs manifest gave enums as bare names under
type: string, and the OpenAPI document gave number enums as a plaininteger. Both serializers write those enums as numbers, so a client built from either description sent"bold"where the server reads 10, and read user flags and entitlements as names where bitmasks arrive.enumslist: wire format (numberorstring), underlying type, whether it is a flags enum, and each member's number. Enum fields reference it throughenumType, and theirtypeis the JSON type that travels.enumValueskeeps its camelCase names, so the docs site reads it as before. Union variants also carry their discriminator's number.enumwithx-enum-varnames, and flags enums map names to bits inx-argon-flags. Ion enums are unsigned, and the writer silently drops ulong nodes, so values are written as long.data:is the bare payload, not the BotSseEvent envelope the route declares.Bumps docs/bot-api-docs to the regenerated description.
Claude-Session: https://claude.ai/code/session_01BjYorEWFhiaFKUgjL5wg6m