Skip to content

Mismatch on dialyzer types for create_key#96

Open
jaeyson wants to merge 4 commits intomainfrom
95-mismatch-on-dialyzer-types-for-create_key
Open

Mismatch on dialyzer types for create_key#96
jaeyson wants to merge 4 commits intomainfrom
95-mismatch-on-dialyzer-types-for-create_key

Conversation

@jaeyson
Copy link
Copy Markdown
Owner

@jaeyson jaeyson commented Apr 26, 2026

Fixes #95

Summary by Sourcery

Align type specifications and payload handling with actual usage, and update documentation and tooling for local Typesense development.

Bug Fixes:

  • Correct dialyzer typespecs for API functions such as create_key and other resource operations to match accepted payload types, including maps and structs.
  • Ensure Ecto-like structs have internal metadata fields (e.g. metadata) stripped before being sent as document bodies.

Enhancements:

  • Broaden typespecs across collections, analytics, synonyms, curations, conversation models, stopwords, presets, and natural language APIs to accept both raw maps and generated OpenApi schema structs.
  • Normalize keyword argument typespecs and parameter annotations for various retrieve, upsert, and delete functions for better static analysis and IDE support.

Build:

  • Bump the library version to 2.3.1 and record changes in the changelog.

Deployment:

  • Update the default docker-compose Typesense image version to 30.1 for local development.

Documentation:

  • Add example docker-compose configuration for running a local Typesense instance to the README and local running guide.
  • Document the expanded payload flexibility in typespecs implicitly via updated examples and references.

@jaeyson jaeyson self-assigned this Apr 26, 2026
@jaeyson jaeyson added the bug Something isn't working label Apr 26, 2026
@jaeyson jaeyson linked an issue Apr 26, 2026 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

Status: In Progress

Development

Successfully merging this pull request may close these issues.

Mismatch on dialyzer types for create_key

1 participant