diff --git a/docs/api.rst b/docs/api.rst index d26bc215..f7f6404b 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,6 +1,8 @@ Ticket API ========== -django-helpdesk includes an API accessible via HTTP POST requests, allowing you to create and alter tickets from 3rd party software and systems. +*Warning*: The django-helpdesk API is deprecated, and no longer maintained. See https://github.com/rossp/django-helpdesk/issues/198 for more details. -For usage instructions and command syntax, see the file ``templates/helpdesk/api_help.html``, or visit http://helpdesk/api/help/. +The API will be removed in January 2016 - you should instead build an integration with eg django-rest-framework. + +For details on the current API including usage instructions and command syntax, see the file ``templates/helpdesk/api_help.html``, or visit http://helpdesk/api/help/. diff --git a/helpdesk/templates/helpdesk/base.html b/helpdesk/templates/helpdesk/base.html index 433c825c..d5dcd2f2 100644 --- a/helpdesk/templates/helpdesk/base.html +++ b/helpdesk/templates/helpdesk/base.html @@ -60,7 +60,7 @@
diff --git a/helpdesk/templates/helpdesk/help_api.html b/helpdesk/templates/helpdesk/help_api.html index bcb7cb92..a73ca5a9 100644 --- a/helpdesk/templates/helpdesk/help_api.html +++ b/helpdesk/templates/helpdesk/help_api.html @@ -23,6 +23,12 @@ +This API has been deprecated and will be removed in January 2016. Please See the GitHub Issue Tracker for more details.
+Do not build new integrations using this API.
+ +We recommend using django-rest-framework or similar for all integrations.