EZPPFarm/ripple-api
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Remove documentation endpoints

Browse Source 
The documentation system is getting changed, https://github.com/osuripple/website-docs is going to be used for documentation instead of the database.
This commit is contained in:
Morgan Bazalgette 2017-05-01 18:22:18 +02:00
parent 8a3dae0592
commit e766e951a5
No known key found for this signature in database
GPG Key ID: 40D328300D245DA5
2 changed files with 0 additions and 97 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
app/start.go
View File

@ -86,9 +86,6 @@ func Start(conf common.Conf, dbO *sqlx.DB) *fhr.Router {
// Auth-free API endpoints (public data)
r.Method("/api/v1/ping", v1.PingGET)
r.Method("/api/v1/surprise_me", v1.SurpriseMeGET)
r.Method("/api/v1/doc", v1.DocGET)
r.Method("/api/v1/doc/content", v1.DocContentGET)
r.Method("/api/v1/doc/rules", v1.DocRulesGET)
r.Method("/api/v1/users", v1.UsersGET)
r.Method("/api/v1/users/whatid", v1.UserWhatsTheIDGET)
r.Method("/api/v1/users/full", v1.UserFullGET)

94
app/v1/doc.go
View File

@ -1,94 +0,0 @@
package v1
import (
"database/sql"
"zxq.co/ripple/rippleapi/common"
)
type docFile struct {
ID int `json:"id"`
DocName string `json:"doc_name"`
Public bool `json:"public"`
IsRule bool `json:"is_rule"`
}
type docResponse struct {
common.ResponseBase
Files []docFile `json:"files"`
}
// DocGET retrieves a list of documentation files.
func DocGET(md common.MethodData) common.CodeMessager {
var wc string
if md.User.TokenPrivileges&common.PrivilegeBlog == 0 || md.Query("public") == "1" {
wc = "WHERE public = '1'"
}
rows, err := md.DB.Query("SELECT id, doc_name, public, is_rule FROM docs " + wc)
if err != nil {
md.Err(err)
return Err500
}
var r docResponse
for rows.Next() {
var f docFile
err := rows.Scan(&f.ID, &f.DocName, &f.Public, &f.IsRule)
if err != nil {
md.Err(err)
continue
}
r.Files = append(r.Files, f)
}
r.Code = 200
return r
}
type docContentResponse struct {
common.ResponseBase
Title string `json:"title"`
Content string `json:"content"`
}
// DocContentGET retrieves the raw markdown file of a doc file
func DocContentGET(md common.MethodData) common.CodeMessager {
docID := common.Int(md.Query("id"))
if docID == 0 {
return common.SimpleResponse(404, "Documentation file not found!")
}
var wc string
if md.User.TokenPrivileges&common.PrivilegeBlog == 0 || md.Query("public") == "1" {
wc = "AND public = '1'"
}
var r docContentResponse
err := md.DB.QueryRow("SELECT doc_name, doc_contents FROM docs WHERE id = ? "+wc+" LIMIT 1", docID).Scan(&r.Title, &r.Content)
switch {
case err == sql.ErrNoRows:
r.Code = 404
r.Message = "Documentation file not found!"
case err != nil:
md.Err(err)
return Err500
default:
r.Code = 200
}
return r
}
// DocRulesGET gets the rules.
func DocRulesGET(md common.MethodData) common.CodeMessager {
var r docContentResponse
r.Title = "Rules"
err := md.DB.QueryRow("SELECT doc_contents FROM docs WHERE is_rule = '1' LIMIT 1").Scan(&r.Content)
const ruleFree = "# This Ripple instance is rule-free! Yay!"
switch {
case err == sql.ErrNoRows:
r.Content = ruleFree
case err != nil:
md.Err(err)
return Err500
case len(r.Content) == 0:
r.Content = ruleFree
}
r.Code = 200
return r
}