Summary

Add a @webapi_docs decorator to store docs on the function.

Review Request #14046 — Created July 17, 2024 and updated Sept. 10, 2024, 8:23 a.m.

Information

Owner

david

Repository

Djblets

Branch

release-6.x

Bugs

Depends On

Reviewers

Groups

djblets

People

Description

This change adds a new decorator for us to use for attaching

public-facing documentation to HTTP methods, rather than putting it into

the docstring. This will let us have internal codebase docs in the docstring

instead, which is much more appropriate.

Testing Done

Used along with a change to our webapidocs Sphinx extension to pull this
data out.

Commits

Summary	ID
Add a @webapi_docs decorator to store docs on the function. This change adds a new decorator for us to use for attaching public-facing documentation to HTTP methods, rather than putting it into the docstring. This will let us have internal codebase docs in the docstring instead, which is much more appropriate. Testing Done: Used along with a change to our webapidocs Sphinx extension to pull this data out.	099af51e231f815a6a1a877c200ceef753422b24

Summary

Add a @webapi_docs decorator to store docs on the function.

This change adds a new decorator for us to use for attaching public-facing documentation to HTTP methods, rather than putting it into the docstring. This will let us have internal codebase docs in the docstring instead, which is much more appropriate. Testing Done: Used along with a change to our webapidocs Sphinx extension to pull this data out.

099af51e231f815a6a1a877c200ceef753422b24

Issues

Description	From	Last Updated
Can you add a unit test in test_decorators.py for this, and make sure that other state from other decorators (including …	chipx86	Sept. 10, 2024, 8:23 a.m.

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

The issue has been resolved. Show all issues

Can you add a unit test in test_decorators.py for this, and make sure that other state from other decorators (including name, type hints, etc.) are retained?

Change Summary:


Add a unit test for state preservation.
Clean up test_decorators a bit and update for modern world.

Commits:

	Summary	ID
	Add a @webapi_docs decorator to store docs on the function. This change adds a new decorator for us to use for attaching public-facing documentation to HTTP methods, rather than putting it into the docstring. This will let us have internal codebase docs in the docstring instead, which is much more appropriate. Testing Done: Used along with a change to our webapidocs Sphinx extension to pull this data out.	ab2fbc43320257bdf92d0b34edbe5e1242150c85
	Add a @webapi_docs decorator to store docs on the function. This change adds a new decorator for us to use for attaching public-facing documentation to HTTP methods, rather than putting it into the docstring. This will let us have internal codebase docs in the docstring instead, which is much more appropriate. Testing Done: Used along with a change to our webapidocs Sphinx extension to pull this data out.	099af51e231f815a6a1a877c200ceef753422b24

Diff:

Revision 2 (+262 -186)

Show changes

	djblets/webapi/decorators.py
	djblets/webapi/tests/test_decorators.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.