Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Circuit Detail Interface (used in Bank and Personal Center) #18

Open
leasunhy opened this issue Sep 7, 2015 · 2 comments
Open

Circuit Detail Interface (used in Bank and Personal Center) #18

leasunhy opened this issue Sep 7, 2015 · 2 comments

Comments

@leasunhy
Copy link
Contributor

leasunhy commented Sep 7, 2015

TL;DR.
Data returned by the backend should be JSON, and should look like something like this:

{
    "id" : 233,
    "title" : "Some Epic Circuit That Will Help The Mankind",
    "progress" : 2, 
    "tags" : ["Share", "Public"],
    "img": "BASE64 encoded image data",
    "description" : "this is the long version of description: blablablablablablablablablabla",
    "introduction" : "this is the short version of description: blabla",
    "equations" : ["some MathJax equation", "another MathJax equation"],
    "references": "some very long multi-line text",
    "comments" : ["commenta", "commentb", "commentc"]
}

Among these key-value pairs, tags and progress are used only in personal center and can be safely ignored in Bank.

Since the Core-Bank and the personal database in personal center share this interface, I suggest the route for this interface be sth like GET /data/circuit_detail/<int:id>.

@leasunhy leasunhy changed the title Circuit Detail Interface Circuit Detail Interface (used in Bank and Personal Center) Sep 7, 2015
@Shaofanl
Copy link
Contributor

Shaofanl commented Sep 8, 2015

Does circuit have comments ?

@SylviaSHIY
Copy link

Yes, they have comments in CORE Bank.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants