I suggest you ...

Bring Azure API Docs in line with Windows API docs

Bring documentation in line with WindowsAPI docs.

For example:

Windows API generally specifies a link to the return type of a method. (We have to actually run it in Azure powershell, and sniff the methods and members, which although very possible thanks to the wonders of Powershell, takes extra time).

A lot of Azure API options don't sufficiently mention the possible values. For example: New-AzureStorageFileSASToken has a permission parameter which it clearly states is a String value. What are the valid values to be passed as a string? One must guess, and guess correctly. This takes time. You might think any competent dev would guess correctly, but this is a poor assumption when documenting an API.

Documentation should be sufficiently robust that it removes obvious roadblocks between writing code, and having it run successfully. The Azure API docs do not succeed at this. The aforementioned improvements would reduce the number of times a Dev has to modify their code before it works.

1 vote
Vote
Sign in
Check!
(thinking…)
Reset
or sign in with
  • facebook
  • google
    Password icon
    I agree to the terms of service
    Signed in as (Sign out)
    You have left! (?) (thinking…)
    Anonymous shared this idea  ·   ·  Flag idea as inappropriate…  ·  Admin →

    0 comments

    Sign in
    Check!
    (thinking…)
    Reset
    or sign in with
    • facebook
    • google
      Password icon
      I agree to the terms of service
      Signed in as (Sign out)
      Submitting...

      Feedback and Knowledge Base