Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FEATURE: Add option to disable resolving nested entities #3864

Open
tillprochaska opened this issue Sep 16, 2024 · 0 comments
Open

FEATURE: Add option to disable resolving nested entities #3864

tillprochaska opened this issue Sep 16, 2024 · 0 comments
Labels
backend Issues related to Aleph’s backend, API, CLI etc. feature-request Requests for new features or enhancements of existing features Moderate Issue that may require attention

Comments

@tillprochaska
Copy link
Contributor

Is your feature request related to a problem? Please describe.
API endpoints that return entities (such as search, fetching individual entities) automatically resolve nested entities. For example, the entity ID 456def in the following entity would be resolved:

{
  "id": "123abc",
  "schema": "Company",
  "properties": {
    "name": ["ACME, Inc."],
    "addressEntity": ["456def"]
  }
}

The resolved API response will look like this:

{
  "id": "123abc",
  "schema": "Company",
  "properties": {
    "name": ["ACME, Inc."],
    "addressEntity": [
      {
        "id": "456def",
        "schema": "Address",
        "properties": {
          "country": ["us"],
          "city": ["Anytown"],
          "full": ["123 Main St, Anytown 12345"],
        }
      }
    ]
  }
}

In many cases, this is useful (e.g. it’s heavily relied on by the UI). However, in some cases it may be preferred to return the unresolved entity IDs instead (e.g. when exporting a subset of the entity graph).

Describe the solution you'd like
I suggest adding an optional query parameter to relevant endpoints (e.g. resolve or nested) that defaults to the current behavior, but can be used to optionally disable automatic resolution.

Describe alternatives you've considered
Manually replacing resolved entity objects with their IDs. This works, but it adds overhead, especially when implementing one-off scripts for analysis.

Additional context
It should be fairly easy to implement this in the Serializer class.

@tillprochaska tillprochaska added backend Issues related to Aleph’s backend, API, CLI etc. feature-request Requests for new features or enhancements of existing features Moderate Issue that may require attention labels Sep 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend Issues related to Aleph’s backend, API, CLI etc. feature-request Requests for new features or enhancements of existing features Moderate Issue that may require attention
Projects
None yet
Development

No branches or pull requests

1 participant