Skip to content

Commit

Permalink
#58 tweak command and event docu linking
Browse files Browse the repository at this point in the history
  • Loading branch information
xeronimus committed Jan 2, 2023
1 parent 6b65c52 commit 32082c7
Showing 1 changed file with 52 additions and 29 deletions.
81 changes: 52 additions & 29 deletions docu/commandAndEventDocu.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Poinz Command and Event Docu
This is an autogenerated docu. 1/2/2023, 10:45:19 AM (Poinz version 0.17.6)
This is an autogenerated docu. 1/2/2023, 10:47:32 AM (Poinz version 0.17.6)

* Jump to [commands](#commands)
* Jump to [events](#events)
Expand Down Expand Up @@ -43,6 +43,7 @@ A user adds a story to the estimation backlog of the room

Produces: **[storyAdded](#event-storyAdded)**, **[storySelected](#event-storySelected)**,


<details>
<summary>Schema</summary>
<p>
Expand Down Expand Up @@ -97,6 +98,7 @@ A user changes the title and/or description of a story

Produces: **[storyChanged](#event-storyChanged)**,


<details>
<summary>Schema</summary>
<p>
Expand Down Expand Up @@ -157,6 +159,7 @@ Users may only clear estimation for the currently selected story.

Produces: **[storyEstimateCleared](#event-storyEstimateCleared)**,


<details>
<summary>Schema</summary>
<p>
Expand Down Expand Up @@ -207,6 +210,7 @@ Story will be completely removed from room.

Produces: **[storyDeleted](#event-storyDeleted)**,


<details>
<summary>Schema</summary>
<p>
Expand Down Expand Up @@ -259,6 +263,7 @@ As soon as all users (that can estimate) estimated the story, a "revealed" event

Produces: **[consensusAchieved](#event-consensusAchieved)**, **[revealed](#event-revealed)**, **[storyEstimateGiven](#event-storyEstimateGiven)**,


<details>
<summary>Schema</summary>
<p>
Expand Down Expand Up @@ -317,6 +322,7 @@ Will trigger "storySelected" event, if no story is selected

Produces: **[consensusAchieved](#event-consensusAchieved)**, **[importFailed](#event-importFailed)**, **[storyAdded](#event-storyAdded)**, **[storySelected](#event-storySelected)**,


<details>
<summary>Schema</summary>
<p>
Expand Down Expand Up @@ -370,6 +376,7 @@ For password protected rooms, we will create a Json Web Token (JWT) with an expi

Produces: **[avatarSet](#event-avatarSet)**, **[emailSet](#event-emailSet)**, **[excludedFromEstimations](#event-excludedFromEstimations)**, **[joinedRoom](#event-joinedRoom)**, **[roomCreated (restricted)](#event-roomCreated)**, **[storyAdded](#event-storyAdded)**, **[storySelected](#event-storySelected)**, **[tokenIssued (restricted)](#event-tokenIssued)**, **[usernameSet](#event-usernameSet)**,


<details>
<summary>Schema</summary>
<p>
Expand Down Expand Up @@ -432,6 +439,7 @@ A user removes a disconnected user from the room.

Produces: **[kicked](#event-kicked)**,


<details>
<summary>Schema</summary>
<p>
Expand Down Expand Up @@ -481,6 +489,7 @@ Is also produced by the socketServer itself on connection lost!

Produces: **[connectionLost](#event-connectionLost)**, **[leftRoom](#event-leftRoom)**,


<details>
<summary>Schema</summary>
<p>
Expand Down Expand Up @@ -529,6 +538,7 @@ Can only be done for the currently selected story.

Produces: **[newEstimationRoundStarted](#event-newEstimationRoundStarted)**,


<details>
<summary>Schema</summary>
<p>
Expand Down Expand Up @@ -579,6 +589,7 @@ Story will no longer be marked as "trashed".

Produces: **[storyRestored](#event-storyRestored)**, **[storySelected](#event-storySelected)**,


<details>
<summary>Schema</summary>
<p>
Expand Down Expand Up @@ -629,6 +640,7 @@ If story is already revealed, reject command.

Produces: **[consensusAchieved](#event-consensusAchieved)**, **[revealed](#event-revealed)**,


<details>
<summary>Schema</summary>
<p>
Expand Down Expand Up @@ -677,6 +689,7 @@ A user selected a story (marked it as the "current" story to estimate)

Produces: **[storySelected](#event-storySelected)**,


<details>
<summary>Schema</summary>
<p>
Expand Down Expand Up @@ -727,6 +740,7 @@ Currently, 0 is the "anonymous" avatar and used by default.

Produces: **[avatarSet](#event-avatarSet)**,


<details>
<summary>Schema</summary>
<p>
Expand Down Expand Up @@ -774,6 +788,7 @@ A user sets a custom card configuration on the room.

Produces: **[cardConfigSet](#event-cardConfigSet)**,


<details>
<summary>Schema</summary>
<p>
Expand Down Expand Up @@ -847,6 +862,7 @@ A user sets his email address (used for Gravatar image fetching. See https://en.

Produces: **[emailSet](#event-emailSet)**,


<details>
<summary>Schema</summary>
<p>
Expand Down Expand Up @@ -896,6 +912,7 @@ Note: All currently valid JWT will still be valid even after password is edited.

Produces: **[passwordCleared](#event-passwordCleared)**, **[passwordSet](#event-passwordSet)**,


<details>
<summary>Schema</summary>
<p>
Expand Down Expand Up @@ -951,6 +968,7 @@ This is by default "off". If enabled, users can specify their estimation "confid

Produces: **[roomConfigSet](#event-roomConfigSet)**,


<details>
<summary>Schema</summary>
<p>
Expand Down Expand Up @@ -1010,6 +1028,7 @@ Trashed stories will not be affected. (sortOrder = undefined).

Produces: **[sortOrderSet](#event-sortOrderSet)**,


<details>
<summary>Schema</summary>
<p>
Expand Down Expand Up @@ -1061,6 +1080,7 @@ A user sets his username.

Produces: **[usernameSet](#event-usernameSet)**,


<details>
<summary>Schema</summary>
<p>
Expand Down Expand Up @@ -1111,6 +1131,7 @@ This saves the team the time to start a new round where everybody has to estimat

Produces: **[consensusAchieved](#event-consensusAchieved)**,


<details>
<summary>Schema</summary>
<p>
Expand Down Expand Up @@ -1165,6 +1186,7 @@ As of #200, every user can "exclude" every other user -> we pass the userId in t

Produces: **[excludedFromEstimations](#event-excludedFromEstimations)**, **[includedInEstimations](#event-includedInEstimations)**,


<details>
<summary>Schema</summary>
<p>
Expand Down Expand Up @@ -1214,6 +1236,7 @@ If the story that is "trashed" is the selectedStory in the room, an additional "

Produces: **[storySelected](#event-storySelected)**, **[storyTrashed](#event-storyTrashed)**,


<details>
<summary>Schema</summary>
<p>
Expand Down Expand Up @@ -1253,34 +1276,34 @@ Produces: **[storySelected](#event-storySelected)**, **[storyTrashed](#event-sto

## Events

* [storyAdded](#event-storyadded-)
* [storySelected](#event-storyselected-)
* [storyChanged](#event-storychanged-)
* [storyEstimateCleared](#event-storyestimatecleared-)
* [storyDeleted](#event-storydeleted-)
* [consensusAchieved](#event-consensusachieved-)
* [revealed](#event-revealed-)
* [storyEstimateGiven](#event-storyestimategiven-)
* [importFailed](#event-importfailed-)
* [avatarSet](#event-avatarset-)
* [emailSet](#event-emailset-)
* [excludedFromEstimations](#event-excludedfromestimations-)
* [joinedRoom](#event-joinedroom-)
* [roomCreated](#event-roomcreated-)
* [tokenIssued](#event-tokenissued-)
* [usernameSet](#event-usernameset-)
* [kicked](#event-kicked-)
* [connectionLost](#event-connectionlost-)
* [leftRoom](#event-leftroom-)
* [newEstimationRoundStarted](#event-newestimationroundstarted-)
* [storyRestored](#event-storyrestored-)
* [cardConfigSet](#event-cardconfigset-)
* [passwordCleared](#event-passwordcleared-)
* [passwordSet](#event-passwordset-)
* [roomConfigSet](#event-roomconfigset-)
* [sortOrderSet](#event-sortorderset-)
* [includedInEstimations](#event-includedinestimations-)
* [storyTrashed](#event-storytrashed-)
* [storyAdded](#event-storyadded)
* [storySelected](#event-storyselected)
* [storyChanged](#event-storychanged)
* [storyEstimateCleared](#event-storyestimatecleared)
* [storyDeleted](#event-storydeleted)
* [consensusAchieved](#event-consensusachieved)
* [revealed](#event-revealed)
* [storyEstimateGiven](#event-storyestimategiven)
* [importFailed](#event-importfailed)
* [avatarSet](#event-avatarset)
* [emailSet](#event-emailset)
* [excludedFromEstimations](#event-excludedfromestimations)
* [joinedRoom](#event-joinedroom)
* [roomCreated](#event-roomcreated)
* [tokenIssued](#event-tokenissued)
* [usernameSet](#event-usernameset)
* [kicked](#event-kicked)
* [connectionLost](#event-connectionlost)
* [leftRoom](#event-leftroom)
* [newEstimationRoundStarted](#event-newestimationroundstarted)
* [storyRestored](#event-storyrestored)
* [cardConfigSet](#event-cardconfigset)
* [passwordCleared](#event-passwordcleared)
* [passwordSet](#event-passwordset)
* [roomConfigSet](#event-roomconfigset)
* [sortOrderSet](#event-sortorderset)
* [includedInEstimations](#event-includedinestimations)
* [storyTrashed](#event-storytrashed)


### Event "storyAdded"
Expand Down

0 comments on commit 32082c7

Please sign in to comment.