2 files changed, 54 insertions, 0 deletions
diff --git a/pttpi/README b/pttpi/README
new file mode 100644
index 00000000..8f60ff6c
--- /dev/null
+++ b/pttpi/README
@@ -0,0 +1,4 @@
+PTT Programming Interface
+
+這目前還是一個實驗性的東西,
+它還不穩定, 沒有效率, 沒有經過完整測試, 並且 spec 還在編修中.
diff --git a/pttpi/doc/spec b/pttpi/doc/spec
new file mode 100644
index 00000000..e1460030
--- /dev/null
+++ b/pttpi/doc/spec
@@ -0,0 +1,50 @@
+board.getBid	get bid from board name
+input	(s)
+	(board name)
+output	({s:i, s:s, s:i})
+	{errno   => errno,
+	 brdname => boardname,
+	 bid     => boardid} (bid = -1 if error)
+
+
+board.getBrdInfo
+get board information (by bid)
+input	(i)
+	(bid)
+output	({s:i,s:s,s:i,s:6,s:6,s:i})
+	{errno   => errno,
+	 brdname => boardname
+	 bid     => bid,
+	 title   => title (Base64),
+	 BM      => board manager(s) (Base64),
+	 nuser   => #users in this board,
+	}
+
+board.getNarticle
+get # articles in the board
+input	(i)
+	(bid)
+output	({s:i, s:s, s:i})
+	{errno    => errno,
+	 narticle => #articles in the board}
+
+article.list
+get article list of bid
+input	(ii)
+	(bid, from # article)
+output:	({s:i,s:s,s:i,s:s,s:s,s:6}...)
+	[{articleid => article id,
+	  filename  => file name,
+	  recommend => recommend,
+	  owner     => owner's userid,
+	  date      => date (format: mm/dd),
+	  title     => article title (Base64)},
+	 {...},...]
+
+article.readfn
+read article by bid and filename
+input	(is)
+	(bid, filename)
+output	({s:6})
+	{content => content}
+