Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Stop generating with JSON payload description comments #2635

Closed
kristapratico opened this issue Jun 12, 2024 · 0 comments · Fixed by #2650
Closed

Stop generating with JSON payload description comments #2635

kristapratico opened this issue Jun 12, 2024 · 0 comments · Fixed by #2650
Assignees

Comments

@kristapratico
Copy link
Member

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"
  }
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants