Fixed task webhook docs #1700
Fixed task webhook docs #1700
Conversation
Docs/reference/apidocs/models.md
Outdated
| | shellRequestId | [SingularityTaskShellCommandRequestId](models.md#model-SingularityTaskShellCommandRequestId) | optional | | | ||
|
|
||
|
|
||
| ## <a name="model-SingularityTaskWebhook"></a> SingularityTaskWebhook |
There was a problem hiding this comment.
A quick note that everything in the apidocs folder here is auto generated by swagger for us. What you'll want to do is add swagger annotations to the object, similar to what you see here. That should get swagger to include it in the models docs for us
| this.taskUpdate = taskUpdate; | ||
| } | ||
|
|
||
| @ApiModelProperty(required=false, value="The task this webhook refers to.") |
There was a problem hiding this comment.
Due to the fact that this is not a model returned by a specific endpoint, I don't think swagger will pick it up without an @ApiModel annotation on the class as a whole. You can test this out running something like mvn -Pbuild-swagger-documentation -DskipTests=true -B -q -fae install to generate the documentation and check if the model appears
There was a problem hiding this comment.
Hmm good catch. Even with the @ApiModel annotation it doesn't appear though. Google's not telling me much about this. I've compared against the other classes annotated with this in Singularity too and it seems okay. Any ideas?
There was a problem hiding this comment.
Update - added the link to github instead of the docs link since swagger still isn't building this even when marked with the annotation.
|
🚢 |
No description provided.