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

Datahose doc update: add-on availability #171

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

pierreneu
Copy link
Contributor

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Apr 4, 2023

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: pierreneu / name: Pierre Neu (94f730b)

@pierreneu
Copy link
Contributor Author

Ready to test

description: |
_Available on Agent 22.5.1 and above.This endpoint provides
_Available on Agent 22.5.1 and above. This endpoint provides
Copy link
Contributor

Choose a reason for hiding this comment

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

22.5.1 was never released, so we could say 22.6 BTW

Events list (see definition on top of the file). The ackId sent as parameter
can be empty for the first call. In the response an ackId will be sent back
and it can be used for the next call: in this way you acknowledge that
you have received the events that came with that ackId.
If you have several instances of the same bot, they must share the same feed so
that events are spread across all bot instances. To do so, you must: share the same
service account provide the same "tag" and same "filters" values
service account provide the same "tag" and same "filters" values.
Copy link
Contributor

Choose a reason for hiding this comment

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

"filters" was renamed into "eventTypes"

messages and events from all conversations that the user is in or events
from the whole pod depending on the "type" field value.
When "type":"fanout" is provided in the body, then only events from streams
the accountbelongs to are returned. Otherwise, if "type": "datahose" is provided
the account belongs to are returned. Otherwise, if "type": "datahose" is provided
in the body, then events returned are not limited to the streams user
belongs to. In this case, at least one event type must be provided in the
"filters" field. In case you are using a datahose feed and retrieving
Copy link
Contributor

Choose a reason for hiding this comment

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

"filters" was renamed into "eventTypes"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants