search

ansible / django-ansible-base

Apache License 2.0
18 stars 45 forks source link

Use dynamic docstrings for sublists #419

Closed AlanCoding closed 5 months ago

AlanCoding commented 5 months ago

Previously the associate and disassociate docstring was getting rendered in the "description" of OPTIONS and in the browsable API. It wasn't the worst in terms of documentation, but it was a little awkward and out-of-place.

Result of this patch:

Screenshot from 2024-05-28 15-06-10

You'll see this in the code, but if it's read-only, and only shows list, the POST options won't be included. This doesn't give specific docstrings for each endpoint, because I think the bigger picture is more important for usability here.

sonarcloud[bot] commented 5 months ago

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud