For a specific endpoint in our REST API I’d like to provide external documentation.
There is an argument external_docs
that can be passed to the extend_schema
, but I haven’t seen any example anywhere.
I passed just the URL to the external documentation:
@extend_schema_view(
my_specific_endpoint=extend_schema(
external_docs="https://documentation.example.com"
)
)
class MySpecificViewSet(ModelViewSet):
# class contents
The clients should use the external documentation to get instructions on using it.
This endpoint cannot be used through the Swagger UI and ideally the button “Try it out” should be disabled, if that’s possible.
Additionally, I’d like to disable the Parameters and the Response sections too.