cloudevents / cloudevents/spec
[Subscription API] subscription.filter is not fully defined
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 5.9k
- Forks
- 613
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 3
Description
The spec is inconsistent on how it defines the subscription.filter property. It has a sub-section but the top-level object is not defined like the rest of the properties in the spec.
See : https://github.com/cloudevents/spec/blob/master/subscriptions-api.md
Example: look for the type definition of dialect or filters. They are missing.
Additionally, it would be more clear to call out that subscription.filter is intended to be this object that is .dialect and .filters
Question: Can we bump this object up one level and allow subscription.filterdialect and subscription.filters ?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with subscriptions-api.md and compare the subscription.filter definition with the top-level dialect and filters definitions. Determine whether filter should remain a nested object or be flattened, then update the specification so the structure and relationship are explicit and consistent.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100