Skip to content

Add rule_check_kind support to TaxonomyBlockRule models#117

Merged
jfrench9 merged 1 commit into
mainfrom
chore/update-taxonomy-block
May 16, 2026
Merged

Add rule_check_kind support to TaxonomyBlockRule models#117
jfrench9 merged 1 commit into
mainfrom
chore/update-taxonomy-block

Conversation

@jfrench9
Copy link
Copy Markdown
Member

Summary

Updates the TaxonomyBlockRule and TaxonomyBlockRuleRequest models to support a new rule_check_kind field, along with enhanced documentation across the taxonomy block rule models.

Key Accomplishments

  • New field support: Added rule_check_kind to both TaxonomyBlockRule and TaxonomyBlockRuleRequest models, enabling more granular control over how taxonomy block rules are evaluated
  • Enhanced documentation: Improved docstrings and inline documentation for the taxonomy block rule models, making the API surface clearer for consumers of the client library
  • Model alignment: Ensured both the response model (TaxonomyBlockRule) and the request model (TaxonomyBlockRuleRequest) are consistent in supporting the new field

Changes Breakdown

  • taxonomy_block_rule.py — Significant updates including the addition of the rule_check_kind field, refactored model structure, and expanded documentation (73 lines changed: +46/-18)
  • taxonomy_block_rule_request.py — Added rule_check_kind field support to the request model (+9 lines)

Breaking Changes

  • Consumers relying on the existing serialization/deserialization shape of TaxonomyBlockRule should verify compatibility, as the model structure has been updated. If rule_check_kind is returned by the API, existing code that performs strict key validation may need updating.

Testing Notes

  • Verify that existing taxonomy block rule CRUD operations continue to function correctly without specifying rule_check_kind
  • Test creating and retrieving taxonomy block rules with the new rule_check_kind field populated
  • Confirm backward compatibility — requests and responses without rule_check_kind should still be handled gracefully
  • Validate that the updated model documentation renders correctly in any auto-generated API docs

Infrastructure Considerations

  • This is a client library model change — no infrastructure or deployment changes are required
  • Downstream services consuming this client should be updated to take advantage of the new rule_check_kind field when ready
  • The API backing this client should already support the rule_check_kind field before this client update is released to avoid deserialization issues

🤖 Generated with Claude Code

Branch Info:

  • Source: chore/update-taxonomy-block
  • Target: main
  • Type: feature

Co-Authored-By: Claude noreply@anthropic.com

@jfrench9 jfrench9 merged commit 1778b8e into main May 16, 2026
1 check passed
@jfrench9 jfrench9 deleted the chore/update-taxonomy-block branch May 16, 2026 05:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant