Skip to content
This repository has been archived by the owner on Jan 21, 2020. It is now read-only.

add operation id field in documentation #146

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

add operation id field in documentation #146

wants to merge 1 commit into from

Conversation

garygitton
Copy link

I added this field to be able to personalized methods of the sdks generated with swagger-codegen and zf-apigility-documentation-swagger.

<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>
Copy link
Member

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.

Copy link
Member

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.

Copy link
Author

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

@weierophinney
Copy link
Member

Note: depends on zfcampus/zf-apigility-admin#393

@weierophinney
Copy link
Member

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.

@weierophinney
Copy link
Member

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:

  • Squash all commits in your branch (git rebase -i origin/{branch})
  • Make a note of all changed files (`git diff --name-only origin/{branch}...HEAD
  • Run the laminas/laminas-migration tool on the code.
  • Clone laminas-api-tools/api-tools-admin-ui to another directory.
  • Copy the files from the second bullet point to the clone of laminas-api-tools/api-tools-admin-ui.
  • In your clone of laminas-api-tools/api-tools-admin-ui, commit the files, push to your fork, and open the new PR.
    We will be providing tooling via laminas/laminas-migration soon to help automate the process.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants