Skip to content

[R225] Add description/example for eventTypeFilters param - #41

Open
b3nk4n wants to merge 3 commits into
masterfrom
events-api-event-type-filters
Open

[R225] Add description/example for eventTypeFilters param#41
b3nk4n wants to merge 3 commits into
masterfrom
events-api-event-type-filters

Conversation

@b3nk4n

Copy link
Copy Markdown
Contributor

What?

Add OpenAPI description and usage example for new query param added here:
https://github.ibm.com/instana/backend/pull/14882

@b3nk4n
b3nk4n requested a review from a teamApril 26, 2022 13:00
Comment threadspec/descriptions/getEvents.md Outdated
- **excludeTriggeredBefore:** Whether to exclude events that have been triggered before the requested timeframe in order to enable searching for events that have started within the given timeframe, excluding events that are previously active already. This is useful for 3rd party integrations that fetch events from Instana with a scheduled batch job in a fixed interval using tumbling windows, when you only care about new events.
This option is more restrictive than `filterEventUpdates` and does not inform about event state updates that got `CLOSED` in the timeframe of the query if not also the start time of the event is within that query timeframe.
- **filterEventUpdates:** Filters results to event updates only. This means that an event is only included when its event state changed in the given query timeframe. This is useful for 3rd party integrations that fetch events from Instana with a scheduled batch job in a fixed interval using a tumbling windows, when you care about event state updates.
- **filterEventUpdates:** Filters results to event updates only. This means that an event is only included when its event state changed in the given query timeframe. This is useful for 3rd party integrations that fetch events from Instana with a scheduled batch job in a fixed interval using a tumbling windows, when you care about event state updates.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This is probably duplicated by mistake

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Oh yes, indeed 🐒

Comment threadspec/descriptions/getEvents.md Outdated
@maratynsky
maratynsky self-requested a review April 26, 2022 14:48

@maratynskymaratynsky left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM :shipit:

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancementNew feature or requestpending-next-release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@b3nk4n@maratynsky