add endpoint spec to get events from a test run #2255
Conversation
api/testEvents.yaml
Outdated
| PollingInfo: | ||
| type: object | ||
| properties: | ||
| numberSpans: |
There was a problem hiding this comment.
can these properties be generalized in a way that's not so tied to the timing profile? Meaning: right now, we only support time based polling profile, but we know we'll support different strategies in the near future. Is there a way we could model this so it's more "polymorphic"?
There was a problem hiding this comment.
we could add a type field and then add objects to represent each type, would that be enough?
There was a problem hiding this comment.
makes sense, that's the approach we took on all similar situations
| - warning | ||
| - error |
There was a problem hiding this comment.
Should we include a info type?
There was a problem hiding this comment.
I don't think it's worth unless we want to show in the event log what are the values for each output after they were resolved. @xoscar what do you think?
There was a problem hiding this comment.
I think the info type is not something we'll be using in the near future so I think its fine to not have it
There was a problem hiding this comment.
Yeah, makes sense @mathnogueira
|
Actually, can we consider adding the specs for this as well? #2183 |
added it |
This PR adds the openAPI spec to get events generated from a test run. The model is based on diagram on #2040
classDiagram Event <|-- DataStoreConnection Event <|-- Polling Event <|-- Output Event : string type Event : enum[trigger, trace, test] stage Event : string description Event : date created_at Event : string test_id Event : string run_id class DataStoreConnection{ DataStoreTestConnection info } class Polling{ int number_of_spans int iteration_number string reason_of_next_iteration boolean is_complete } class Output{ string warning string error string output_name }Checklist