fix: persons search

[joscha]

persons/search endpoint does not return organization_ids

Summary by CodeRabbit

• New Features

  • Enhanced the organization handling within the person data structure, streamlining how organizational affiliations are accessed in API responses.
  • Introduced new response types to improve clarity and usability when fetching individual person data.

• Bug Fixes

  • Corrected the representation of organizational identifiers to ensure they are still accessible and relevant in the response context.

[coderabbitai]

Walkthrough

The recent changes in the persons.ts file represent a significant reorganization of the Person type and associated response structures. Notably, the organization_ids field has been removed from the core Person type, while being retained in the SinglePersonResponseRaw. This shift aims to streamline the data structure, improve clarity, and enhance usability for API responses, reflecting a more organized approach to managing person-related data.

Changes

File	Change Summary
src/v1/persons.ts	- Removed organization_ids from Person type. - Added organization_ids to SinglePersonResponseRaw. - Updated SinglePersonResponse to use Replace type with SinglePersonResponseRaw. - Modified SimplePersonResponse to omit list_entries.

Poem

🐇 In fields of code where changes bloom,
The Person type sheds its old costume.
With organization_ids taken away,
Simplicity dances in a bright new way.
Responses now clearer, a joy to see,
Hopping along, we code with glee! 🌟

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 66ffd6f and 138c6f8.

Files selected for processing (1)

• src/v1/persons.ts (3 hunks)

Additional comments not posted (3)

src/v1/persons.ts (3)

107-108: Addition of organization_ids to SinglePersonResponseRaw looks good.

The inclusion of organization_ids in SinglePersonResponseRaw ensures that the relevant organization IDs are returned in the response.

---

113-122: Modification of SinglePersonResponse to use Replace utility type looks good.

The use of the Replace utility type with SinglePersonResponseRaw ensures that the response structure is dynamically updated based on the raw response.

---

188-188: Modification of SimplePersonResponse to omit list_entries looks good.

The omission of the list_entries field from SimplePersonResponse ensures that the simplified response does not include unnecessary data.