Documentation for operation groups
See original GitHub issueCurrently there is no place in Swagger specs to add documentation for enum labels or operation groups. The end result is missing documentation in the generated code. For example, the operation group property ISearchManagementClient.Services
used to have a comment and URL that referred to the corresponding section of the REST API docs on MSDN, but there is no home for this documentation in the Swagger spec.
Our users deserve awesome docs. We should consider a Swagger extension for adding documentation for operation groups and enum labels (also URL references; see related issue: https://github.com/Azure/autorest/issues/288).
Issue Analytics
- State:
- Created 8 years ago
- Comments:7 (6 by maintainers)
Top Results From Across the Web
Written Documents for Community Groups: Policies ... - Ohioline
Policies and procedures, or standard operating procedures, are essential documents for ongoing organizations. To ensure equality, fairness and ...
Read more >Group Operation | TestComplete Documentation
Use the Group operation to create logical groups of operations and organize operations within a keyword test. For instance, you can include all...
Read more >How to Document and Share Your Content Operations ...
Clear, accessible documentation empowers stakeholders to use new processes and advocate them. It prevents content bottlenecks and mistakes from happening.
Read more >Creating a Standard Operating Procedure: A Step-by- ...
Learn how to create and implement effective SOPs in your organization with our comprehensive guide that covers everything you need to know.
Read more >Operations Manual Template
Provide a brief description of the operation of the system, including its purpose and uses. Provide an inventory of the system's programs.
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
Documentation for enum values is a thing now as such:
It was implemented by #2308
I’ve changed the title of this issue accordingly.
Adding operation group docs to vNext design