Ver código fonte

Planned resources

master
Chris Smith 12 anos atrás
pai
commit
fd24665e60
1 arquivos alterados com 25 adições e 0 exclusões
  1. 25
    0
      README.textile

+ 25
- 0
README.textile Ver arquivo

10
 
10
 
11
 Ideally, it will eventually be possible to write a full IRC client on top of
11
 Ideally, it will eventually be possible to write a full IRC client on top of
12
 the API without having to interact with IRC itself directly.
12
 the API without having to interact with IRC itself directly.
13
+
14
+h2. Resources
15
+
16
+These are the planned resources that RestIRC will expose. Methods that aren't
17
+yet implemented are -struck out-.
18
+
19
+* /version (GET)
20
+* /servers (-GET-, -POST-)
21
+* /servers/*server* (-GET-)
22
+* /servers/*server*/channels (-GET-, -POST-)
23
+* /servers/*server*/channels/*channel* (-GET-, -PUT-, -DELETE-)
24
+* /servers/*server*/channels/*channel*/topic (-GET-, -PUT-)
25
+* /servers/*server*/channels/*channel*/topic/author (-GET-)
26
+* /servers/*server*/channels/*channel*/messages (-GET-, -POST-)
27
+* /servers/*server*/channels/*channel*/users (-GET-)
28
+* /servers/*server*/users (-nothing?-)
29
+* /servers/*server*/users/*user* (-GET-)
30
+* /servers/*server*/users/*user*/messages (-GET-, -POST-)
31
+
32
+In addition, most resources will expose a hooks subresource to allow
33
+configuring WebHooks to be called:
34
+
35
+* /hooks (-GET-)
36
+* /hooks/*event-type* (-GET-, -PUT-, -POST-)
37
+* /hooks/*event-type*/*hook-id* (-GET-, -PUT-, -DELETE-)

Carregando…
Cancelar
Salvar