-
Notifications
You must be signed in to change notification settings - Fork 37
add operation id field in documentation #146
base: master
Are you sure you want to change the base?
Conversation
src/apigility-ui/rest/rest.html
Outdated
<div class="form-group"> | ||
<label class="col-sm-2 control-label">Operation Id</label> | ||
<div class="col-sm-10"> | ||
<textarea class="form-control" ng-model="vm.rest.documentation.collection[http].operationId" placeholder="Insert the operation id here" ng-disabled="vm.disabled"></textarea> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There needs to be more information in the UI about what an "operation ID" is; not all users will know what it is, which will lead to support questions.
As an example: I had to look it up, as I wasn't sure what it was for, and what constituted valid values for the field. I eventually found this: https://swagger.io/docs/specification/paths-and-operations/#operationid
As such, I think we need a tooltip of some sort to allow folks to get that information, and it would then need to be applied anywhere you accept or display an operation ID parameter in the UI.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I also think we should likely auto-populate these values based on the current resource and operation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's a good idea I will try it on my side
Note: depends on zfcampus/zf-apigility-admin#393 |
This repository has been closed and moved to laminas-api-tools/api-tools-admin-ui; a new issue has been opened at laminas-api-tools/api-tools-admin-ui#1. |
This repository has been moved to laminas-api-tools/api-tools-admin-ui. If you feel that this patch is still relevant, please re-open against that repository, and reference this issue. To re-open, we suggest the following workflow:
|
I added this field to be able to personalized methods of the sdks generated with swagger-codegen and zf-apigility-documentation-swagger.