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

feat: add events #182

Merged
merged 24 commits into from
May 15, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
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
2 changes: 1 addition & 1 deletion specification.json
Original file line number Diff line number Diff line change
Expand Up @@ -682,7 +682,7 @@
{
"id": "Requirement 5.2.4",
"machine_id": "requirement_5_2_4",
"content": "The `event handler` function MUST accept a `event details` or `error event metadata` parameter.",
"content": "The `event handler` function MUST accept a `event details` parameter.",
"RFC 2119 keyword": "MUST",
"children": []
},
Expand Down
4 changes: 2 additions & 2 deletions specification/sections/05-events.md
toddbaert marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@ This is particularly relevant for `event handler functions` which are attached t

#### Requirement 5.2.4

> The `event handler` function **MUST** accept a `event details` or `error event metadata` parameter.
> The `event handler` function **MUST** accept a `event details` parameter.

see: [`event details`](../types.md#event-details), [`error event metadata`](../types.md#error-event-details)
see: [`event details`](../types.md#event-details)

#### Requirement 5.2.5

Expand Down
17 changes: 2 additions & 15 deletions specification/types.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,29 +109,16 @@ An enumeration of possible provider states.
A structure defining a provider event payload, including:

- flags changed (string[], optional)
- message (string, optional)
toddbaert marked this conversation as resolved.
Show resolved Hide resolved
- event metadata ([event metadata](#event-metadata))

### Provider Error Event Details

A structure defining a provider error event payload, including:

- error message (string, required)
- event metadata ([flag metadata](#event-metadata))

### Event Details

A structure defining an event payload, including:

- client name (string, required)
- flags changed (string[], optional)
- event metadata ([event metadata](#event-metadata))

### Error Event Details

A structure defining an error event payload, including:

- client name (string, required)
- error message (string, required)
- message (string, optional)
- event metadata ([event metadata](#event-metadata))

### Event Metadata
Expand Down