adobe / adobe/spacecat-api-service

API to list sites/orgs for which an audit/report/import type is enabled/disabled

Open
#211 1 comment 0 reactions 0 assignees View on GitHub
automation enhancement good first issue seo
Dominant language
JavaScript
Stars
10
Forks
15
Avg merge
1d 9h
Merged PRs (30d)
150

Description

**Is your feature request related to a problem? Please describe.**
Currently in order to get a list of sites/orgs that have a specified audit/report/import type enabled, we need to manually inspect the config or auditConfig for the whole list of sites/orgs.
We cannot filter in DynamoDB after subfields of a map field, hence cannot get the list.
The alternative is to import the JSON from the get all sites/orgs response in Excel and transform it so that we have those flags as columns and can filter by them.

**Describe the solution you'd like**
API endpoint that returns the list of sites specifying audits/reports/imports enabled/disabled in CSV format.
It should be visible if an audit/report/import type has been disabled for a specific site or organization.

**Asks that could have been solved by the feature**
https://cq-dev.slack.com/archives/C05A45JBP9N/p1710871764208859

Contributor guide

Open the contributing guide

Research direction

Start by inspecting the existing API that returns all sites and organizations, along with how DynamoDB map fields such as config and auditConfig are handled. Done means a new endpoint returns sites and organizations in CSV format with each requested audit, report, or import type shown as enabled or disabled.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api, backend, database
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.