adobe / adobe/spacecat-api-service

feat(api): filters for retrieving lists of orgs/sites

Open
#4 0 comments 0 reactions 0 assignees View on GitHub
question
Dominant language
JavaScript
Stars
10
Forks
15
Avg merge
1d 9h
Merged PRs (30d)
150

Description

## Overview
Star Catalogue has the ability and goal to track and audit across AEM CS, Edge Delivery, and even non-Adobe (or pre-Adobe) sites, live and not live, licensed and not licensed, and various other aspects. However, most dashboards, lists, and counts that are likely to be requested will focus on one segment at a time -- all licensed, or all live Edge Delivery, or some other filter more precise than "everything in Star Catalogue".

## Details
It is unclear from the initial API draft at https://scaling-robot-wovlqzk.pages.github.io/#tag/organizations that we plan to offer filtering capabilities. We may also want to crawl across the Site to Organization relationship for some queries -- for example show sites where organization is licensed, how would such an API look, and where would it live?

## Proposed Actions
Let's discuss in this issue, then work on the API updates. We do not require these filters in the first iteration of the API, but I believe we'll need a few basic ones before the API will be widely adopted.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the Organizations section of the linked API draft and the proposed Site-to-Organization queries. Clarify which list filters are required and where relationship-based filters belong, then document the agreed API changes and acceptance criteria before implementation.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.