Skip to content

Commit

Permalink
fix: Split play intent into play-entity and play-query
Browse files Browse the repository at this point in the history
  • Loading branch information
jlacivita committed Aug 15, 2023
1 parent 5aed451 commit be435d9
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 9 deletions.
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Intent Context
# Intents

Document Status: Working Draft

Expand All @@ -9,14 +9,22 @@ See [Firebolt Requirements Governance](../../governance.md) for more info.
| Jeremy LaCivita | Comcast |

## 1. Overview
All intents have a `context` property to provide context on the origination of the intent.
All intents have an `action`, `data`, and `context` property.

## 2. Table of Contents
- [1. Overview](#1-overview)
- [2. Table of Contents](#2-table-of-contents)
- [3. Intent Context](#3-intent-context)
- [3. Intent Action](#3-intent-action)
- [4. Intent Data](#4-intent-data)
- [5. Intent Context](#5-intent-context)

## 3. Intent Context
## 3. Intent Action
TBD

## 4. Intent Data
TBD

## 5. Intent Context
This is a placeholder, to be cleaned up later.

```
Expand Down
6 changes: 3 additions & 3 deletions requirements/specifications/intents/play.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,11 @@ The `play-entity` intent **MUST** have a `data` object property, which is an obj

> The `data` object **MUST** have an `entity` object property.
>
> The `entity` object, **MUST** be an [Entity](../entities/index.md).
> The `entity` object, **MUST** be an [Entity](../entities/).
>
> The `data` object **MAY** have an `options` object property that conforms to [Play Entity Options](#31-play-entity-options).
The `play-entity` intent **MUST** have a `context` object property that conforms to the [Intent Context](./context.md).
The `play-entity` intent **MUST** have a `context` object property that conforms to the [Intent Context](./#5-intent-context).

An example play-entity intent:

Expand Down Expand Up @@ -146,7 +146,7 @@ The `play-query` intent **MUST** have `data` property, which is an object confor
>
> The `data` object **MAY** have an `options` object property that conforms to [Play Options](#41-play-options-for-query).
The `play-query` intent **MUST** have a `context` object property that conforms to the [Intent Context](./context.md).
The `play-query` intent **MUST** have a `context` object property that conforms to the [Intent Context](./index.md#5-intent-context).

An example play intent:

Expand Down

0 comments on commit be435d9

Please sign in to comment.