Azure / autorest.python

Extension for AutoRest (https://github.com/Azure/autorest) that generates Python code
MIT License
76 stars 54 forks source link

Stop generating with JSON payload description comments #2635

Closed kristapratico closed 2 weeks ago

kristapratico commented 3 weeks ago

Our JSON docs currently break sphinx because the comments wrap to the next line and aren't valid in the python markdown:

image

In discussing how to format this correctly, we've come to the conclusion that we should just not generate with description comments given that model-less generation is uncommon now and the models themselves have the descriptions for each property.

So this issue is asking that for the example above, we generate with just properties and their types:

  # response body for status code(s): 200
  response == {
      "list": [
          {}
      ],
      "pageSize": "int",
      "sortBy": "str",
      "sortType": "str",
      "startIndex": "int",
      "totalCount": "int"
  }