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

Support GET for /allImages #954

Open
donaldgray opened this issue Feb 6, 2025 · 0 comments
Open

Support GET for /allImages #954

donaldgray opened this issue Feb 6, 2025 · 0 comments
Labels
API https://dlcs-book.readthedocs.io/en/latest/ refined Identify refined tickets in the backlog

Comments

@donaldgray
Copy link
Member

donaldgray commented Feb 6, 2025

See RFC-019 for more info.

Add GET support to GET /customers/{c}/allImages that returns paginated Hydra collection of images.

This supports the following query parameters:

  • ?q= for AssetQuery syntax as outlined in asset-query wip docs. E.g. ?q={"string1":"my-val"}
    • Space, String1-3, Number1-3 are already supported (see below)
    • Add support for filtering by Manifests ?q={"manifests":["manifest-a","manifest-b"]} (note that Asset gains "manifests" column #950 added 'manifests' with GIN index so queries should ensure they use this)
  • ?page= and ?pageSize= for pagination
  • ?orderBy= and ?orderByDescending= for ordering
    • Handling already supported, stick to existing fields

Prior Art

There is already AssetQuery support on GET /customers/{c}/spaces/{s}/images, see

public async Task<IActionResult> GetImages(

The model containing supported filters is:

With handling logic in AssetQueryX:

The following interfaces relate to above behaviour, applied to Mediatr requests: IAssetFilterableRequest, IPagedRequest, IOrderableRequest

@donaldgray donaldgray changed the title Add AssetQuery support to GET allImages Support GET for /allImages Feb 7, 2025
@donaldgray donaldgray added API https://dlcs-book.readthedocs.io/en/latest/ refined Identify refined tickets in the backlog labels Feb 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API https://dlcs-book.readthedocs.io/en/latest/ refined Identify refined tickets in the backlog
Projects
None yet
Development

No branches or pull requests

1 participant