Repository navigation
Align four shared 2.17 and Preview schemas with what the API sends - #761
Open
markdennis22 wants to merge 2 commits into
Open
markdennis22 wants to merge 2 commits into
markdennis22 wants to merge 2 commits into
Conversation
Types custom_object_instance custom attribute values, gives admin.avatar its object shape, widens data_event metadata values, and lets an error code be an integer as a few validation errors send it. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Applies the same 2.17 changes to the Preview spec, merged operation by operation so Preview-only content stays, such as the `{id}` path parameter name. The next version is cut from Preview, and the Preview SDKs are generated from it.
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
This branch has not been deployed
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.
Why?
Four shared 2.17 schemas didn't match what the API sends: custom object instance attribute values, the admin avatar, event metadata values, and error codes, which a few validation errors send as integers. The Preview spec has the same schemas, and the next version is cut from Preview, so it needs the same fixes.
How?
Corrects the four schemas to match the API's current behaviour, in 2.17 and in Preview.
Risks
The Preview SDKs are generated from this spec, so these changes affect generated Preview types:
CustomObjectInstance.custom_attributesvalues become aCustomObjectInstanceCustomAttributesValueunion of string, integer, number, boolean or reference objectAdmin.avatarbecomes a newAdminAvatarobject withimage_urlandtype, instead of a stringavataras a stringErrorErrorsItem.codebecomes anErrorErrorsItemCodeunion of string and integer422Notes for reviewers
data_event.metadatanow lists the value types. The Preview Fern overrides already keepmetadataa free-form map, so its Preview type doesn't change.fern checkshows 0 errors. There are no new dangling refs and no operationId changes, and no changed Preview type is a bareunknown.Generated with Claude Code