question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Documentation for operation groups

See original GitHub issue

Currently 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:closed
  • Created 8 years ago
  • Comments:7 (6 by maintainers)

github_iconTop GitHub Comments

2reactions
olydiscommented, Jun 1, 2017

Documentation for enum values is a thing now as such:

x-ms-enum:
  name: <name for generated type>
  modelAsString: true|false
  values:  <array of one or more enum-values:>
    - value: <wire-value>
      description: <description of that value>
      name: <generated enum member name (defaults to ‘value’)>

It was implemented by #2308

I’ve changed the title of this issue accordingly.

0reactions
fearthecowboycommented, Jul 18, 2017

Adding operation group docs to vNext design

Read more comments on GitHub >

github_iconTop 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 >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found