search

aws / aws-tools-for-powershell

The AWS Tools for PowerShell lets developers and administrators manage their AWS services from the PowerShell scripting environment.
Apache License 2.0
238 stars 79 forks source link

Provide link to the API on the CmdLet help page. #64

Closed ketanbhut closed 2 years ago

ketanbhut commented 4 years ago

Provide a general summary of the issue in the Title above.

Expected Behavior Inline with most of the help provided by AWSCLI, the API utilized in the CmdLet is mentioned on each help files but we have to search on that API and then land on the API page.

Current Behavior For each CmdLet help, we see don't see a clickable API page link.

Against AWSCLI - for instance, https://docs.aws.amazon.com/cli/latest/reference/storagegateway/update-smb-file-share.html There is a link for API : 'See also: AWS API Documentation'

Possible Solution We can add link for for the API page, where we mention the API call, under synopsys:

For instance, https://docs.aws.amazon.com/powershell/latest/reference/items/Update-SGSMBFileShare.html

Synopsis Calls the AWS Storage Gateway UpdateSMBFileShare API operation.

We do have some links under related help section, however it points to a generic API reference page. We can see in the same above help CmdLet link.

github-actions[bot] commented 2 years ago

We have noticed this issue has not recieved attention in 1 year. We will close this issue for now. If you think this is in error, please feel free to comment and reopen the issue.