Permalink
Browse files

note about how interfaces are referenced

  • Loading branch information...
1 parent 54279bd commit 5d09cca1cc166b816affa391f433ea0ca4cdbd97 @dcramer dcramer committed Nov 1, 2012
Showing with 13 additions and 2 deletions.
  1. +13 −2 docs/developer/interfaces/index.rst
@@ -3,8 +3,19 @@ Interfaces
Sentry implements data interfaces for storing structured data. At it's core, an interface describes what it's storing, and optionally how it's data should be rendered.
-Bundled Interfaces
-------------------
+Within the client, interfaces are referenced by their full Python module path. For example, if you were sending data
+for the ``sentry.interfaces.Message`` class, it would look like this in your JSON packet::
+
+ {
+ // etc.
+ "message": "Hello world"
+ "sentry.interfaces.Message": {
+ "message": "Hello world"
+ }
+ }
+
+Provided Interfaces
+-------------------
.. autoclass:: sentry.interfaces.Message

0 comments on commit 5d09cca

Please sign in to comment.