API auto complete end points

[JC5]

See title. Limited scope, limited search, so quick response.

[emansih]

Allow API consumers to decide the limit? Such as /api/search?type=transaction&limit=10

[JC5]

(notes to self)

1. A new controller to handle requests. Most auto complete code is already in this file so copy/paste away.
2. Needs routes in api.php
3. Needs Swagger documentation

Also needs some time spent on consistent returns. Always return "title", "id".. something else? Formatted title? raw data?

[emansih]

How would auto complete work in this context? web sockets or plain HTTP GET?

[JC5]

I'm thinking plain GET but I know very little about web sockets. Would that be a better idea?

[emansih]

i'm not sure about resource usage. For GET, a poorly configured client would be sending quite a bit of network data back to backend. Imagine searching for each char updates, "Fancy Restaurant @ White House" contains 30 characters, a badly configured client would send 30 requests to the backend for suggestions.

[JC5]

Yeah that's true.

[JC5]

New autocomplete endpoints will be available in the new release. They will, consistently, return array in the following format that you can use in any auto-complete thing. All internal Firefly III autocomplete fields will now also use these endpoints.

[
    {
        "id": 5,
        "name": "Object",
    }
]

This applies to ALL endpoints, regardless of the object. Some endpoints have extra fields.

• The endpoint for accounts exposes name_with_balance for asset accounts and liabilities, type for all accounts and currency_* for all accounts.
• A separate endpoint for currencies exposes the currency name as Euro (EUR) instead of Euro.
• Both piggy bank endpoints (see below) expose currency information in currency_* fields.
• A separate piggy bank endpoint exposes name_with_balance next to name which includes balance info for the piggy bank (ie. New couch ($300 / $500)).
• Two transaction endpoints. They both expose both description and name (for consistency).
• The second one exposes both name and description as #12: description.
• The transaction type endpoint will always return US English transaction types.

The API docs will be updated when the new release is out.

[JC5]

Will be fixed in the next release, closing now.

[psychowood]

For reference: #3748

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.