Repository navigation
Align the 2.17 and Preview custom object instance endpoints with what the API does - #754
Open
markdennis22 wants to merge 4 commits into
Open
markdennis22 wants to merge 4 commits into
markdennis22 wants to merge 4 commits into
Conversation
Swaps the two delete operationIds so each matches its path, types custom_attributes values in the create request, documents the 400s and the delete 404s the API returns, explains the external_id lookup, and adds the accepted OAuth scopes to each operation. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
A list body also matches the single-instance schema, which requires no properties, so oneOf would reject an ordinary list response. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…attributes Reference attributes take an array of ids, so the create request's custom_attributes union now allows an array of strings. The description says datetime attributes take a Unix timestamp or date string, list attributes take an option label or id and clear on a value that matches no option, and an unmatched reference id is skipped. 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?
The 2.17 spec for the custom object instance endpoints didn't match the API. The two delete operations had each other's operationIds, the create request typed every custom attribute as a string, and several error responses were missing. The Preview spec had the same problems, and the next version is cut from Preview, so it needs the same fixes.
How?
Corrects the custom object instance endpoints and their request schema to match the API's current behaviour, and adds the OAuth scopes each endpoint accepts to its description. The same changes go into the Preview spec, keeping content that only applies to Preview, such as the
{id}path parameter name.Risks
The Preview SDKs are generated from this spec, so these changes affect generated Preview types:
deleteCustomObjectInstancesByIdtakesidinstead ofexternal_id, anddeleteCustomObjectInstancesByExternalIdthe reversecustom_attributesvalues become a newCreateOrUpdateCustomObjectInstanceRequestCustomAttributesValueunion of string, integer, number, boolean and array of stringsListCustomObjectInstancesResponseunion of the list, a single instance and the not-found body, instead ofCustomObjectInstancesPaginatedListexternal_id. With it, the API already returned a single object400errors on create and listNotes for reviewers
fern checkshows 0 errors and the same 317 warnings as main. There are no new dangling refs, and the only operationId change is the delete swap.Generated with Claude Code