clearlydefined / clearlydefined/service

Need Definition data event stream

Open
#388 0 comments 0 reactions 0 assignees View on GitHub
design
Dominant language
TypeScript
Stars
51
Forks
46
PR merge metrics
No merged PRs in 30d

Description

There are several scearios where users of ClearlyDefined want to proactively hear about changes in the set of definitions. See #386 and #387

* Recheck pending or prior business logic runs in the face of new information
* Vet the changes
* Replicate the public data locally

This could be something akin to a webhook service or could be more of an event queue with a cursor or some such. Let's not implement much here, rather find some existing mechanism (e.g, EventBus) that just does this. Trick will be that the events should include the full definitions (can be large)

Contributor guide

Open the contributing guide

Research direction

Review issues #386 and #387 first to understand the requested definition-change notifications. Then inspect the service's existing EventBus or other event-delivery mechanism, if present, and compare webhook and cursor-based approaches. Done should be a selected mechanism that exposes events containing the full definitions.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
backend, distributed-systems
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.