[Checks API] Request params description is misleading


#1

For conclusion it says:

Required if you provide a status of completed.

It makes me think that if there’s no status, then conclusion is optional (still accepted). However, it turns out that API does not accept conclusion if status is not provided.
I think, this needs more clarifying words.

Also, it looks like actions is marked as object, while from description it looks like an array of up to 3 objects. Where’s the truth?


#2

Thanks for opening this topic @webknjaz

Also, it looks like actions is marked as object, while from description it looks like an array of up to 3 objects. Where’s the truth?

I apologize for the confusion here – actions is an array of up to three objects.

I’ve passed the feedback along to the team.

Cheers,

Lizz


#3

Please also handle ambiguity of the conclusion and actions dependency.


#4

Please also handle ambiguity of the conclusion and actions dependency.

@webknjaz can you help me understand what is ambiguous so that I can provide it to the team?


#5

Well, the doc says to always pass conclusion when status=='completed' that’s understandable.

But if I pass conclusion with no status, for example, I get API error. Doc describes the case when conclusion is required, not telling anything about when it’s forbidden.


#6

Please also handle ambiguity of the conclusion and actions dependency.

Well, the doc says to always pass conclusion when status==‘completed’ that’s understandable.

My apologies, I thought you were referring to additional ambiguities in your reply. I opened an issue internally for the feedback you provided for the conclusion and actions parameters.

Thanks again,

Lizz