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

Renaming/broadening "source" to "topic", consolidating source-id/source-type into "subject" #95

Closed
wants to merge 4 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 35 additions & 19 deletions spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,32 +146,48 @@ that contains both context and data).
* REQUIRED
* MUST be a non-empty string

### source
* Type: Object
* Description: This describes the software instance that emits the event at
runtime (i.e. the producer). It contains sub-properties (listed below)
* Constraints:
* REQUIRED
* MUST contain at least one non-empty sub-property.

### source-type
### topic
* Type: String
* Description: Type of the event source. Providers define list of event
sources.
* Description: This expression is a classification of the event that
enables groupwise publishing of and subscription to events of the
described class. The classification might reflect the identity of
the party raising the event, and/or the context of where and/or why
the event was raised, and/or a structured classification of the
information contained in the event. The value SHOULD be a URI.
The value MAY be used to map directly to the "topic" concept found
in many middleware products. The value MAY also be a interpreted as
a URL. The topic property value's scope is set by the "namespace"
property.
* Constraints:
* REQUIRED
* MUST be a non-empty string
* Examples:
* s3

### source-id
* Resource path, relative URI reference:
/tenant/group/type/myresource
* Machine component, relative URI reference:
/robot/drives/3/temperature
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Request: add clarification for URI segments, like /namespaces/{namespaceId}/buckets/{bucketId}/objects or /robots/{robotId}/drives/{driveId}/temperature

* US City, relative URI reference:
/USA/Alaska/Juneau
* Virtual machine alerting, URI with custom scheme:
alerts://mymachine.example.com/
* Web service notification triggers, URI/URL network resolvable:
https://myservice.example.com, https://myservice.example.com/mytrigger

### subject
* Type: String
* Description: ID of the event source.
* Description: Identifies the subject of the event in relation to the topic.
For example, a notification about a new customer record being added to
a CRM system might identify a CRM system's tenant as the ´topic´, might
further qualify the ´event-type´ as 'new-customer-added', and then further
qualify the subject of the event (the new record) with the content of this
property. The subject is a free-form string defined by the publisher.
* Constraints:
* REQUIRED
* MUST be a non-empty string
OPTIONAL. The subject might already be self-evident from the "source" context.
* Examples:
* my.s3.bucket
* File system event, with `topic` reflecting the emitting storage container,
and the newly created file-name being the subject, a partial URI
relative to the source URI: `/data/app/alice.txt`.
* Customer relationship management (CRM) solution event, new customer record
being the subject, with fully qualified URI: https://example.com/crm/c/2662773

### event-id
* Type: String
Expand Down