aboutsummaryrefslogtreecommitdiffstats
path: root/site/content/_index.md
diff options
context:
space:
mode:
authoralpaylan2021-04-16 16:17:55 +0300
committeralpaylan2021-04-16 16:17:55 +0300
commit1be1c3b87b06ee097828c1915eee63e3286cda00 (patch)
treed3c4330d9a6530d774a64922dc582e6665acd94b /site/content/_index.md
parent11d088faaa368fc0603e7ecdbc504c5687495ca5 (diff)
downloadgradecoin-1be1c3b87b06ee097828c1915eee63e3286cda00.tar.gz
gradecoin-1be1c3b87b06ee097828c1915eee63e3286cda00.tar.bz2
gradecoin-1be1c3b87b06ee097828c1915eee63e3286cda00.zip
update landing page.
Diffstat (limited to 'site/content/_index.md')
-rw-r--r--site/content/_index.md9
1 files changed, 7 insertions, 2 deletions
diff --git a/site/content/_index.md b/site/content/_index.md
index e3b798b..356a615 100644
--- a/site/content/_index.md
+++ b/site/content/_index.md
@@ -39,18 +39,22 @@ Gradecoin uses 2048 bit RSA keyspairs.
39- Downloads `Gradecoin`'s Public Key from [Moodle](https://odtuclass.metu.edu.tr/my/) 39- Downloads `Gradecoin`'s Public Key from [Moodle](https://odtuclass.metu.edu.tr/my/)
40- Encrypts their [JSON](https://www.json.org/json-en.html) wrapped `Public Key`, `Student ID` and one time `passwd` using Gradecoin's Public Key 40- Encrypts their [JSON](https://www.json.org/json-en.html) wrapped `Public Key`, `Student ID` and one time `passwd` using Gradecoin's Public Key
41- Their public key is now in our database and can be used to sign their JWT's during requests 41- Their public key is now in our database and can be used to sign their JWT's during requests
42- For more information, check our [register](@/register_docs.md) page.
42 43
43## /transaction 44## /transaction
44- You can offer a [Transaction](/transaction) - POST request 45- You can offer a [Transaction](@/transaction_docs.md) - POST request
45 - The request should have `Authorization` 46 - The request should have `Authorization`
46 - The request header should be signed by the Public Key of the `by` field in the transaction 47 - The request header should be signed by the Public Key of the `by` field in the transaction
47- fetch the list of `Transaction`s - GET request 48- fetch the list of `Transaction`s - GET request
49- For more information, check our [transaction](@/transaction_docs.md) page.
50
48 51
49## /block 52## /block
50- offer a [`schema::Block`] - POST request 53- offer a [Block](@/block_docs.md) - POST request
51 - The request should have `Authorization` 54 - The request should have `Authorization`
52 - The [`schema::Block::transaction_list`] of the block should be a subset of [`schema::Db::pending_transactions`] 55 - The [`schema::Block::transaction_list`] of the block should be a subset of [`schema::Db::pending_transactions`]
53- fetch the last accepted [`schema::Block`] - GET request 56- fetch the last accepted [`schema::Block`] - GET request
57- For more information, check our [block](@/block_docs.md) page.
54 58
55`Authorization`: The request header should have Bearer JWT.Token signed with Student Public Key 59`Authorization`: The request header should have Bearer JWT.Token signed with Student Public Key
56 60
@@ -60,6 +64,7 @@ Gradecoin uses 2048 bit RSA keyspairs.
60- Don't know where to start? Gradecoin uses RESTful API; simple `curl` commands or even your browser will work! [This website can help as well](https://curl.trillworks.com/). 64- Don't know where to start? Gradecoin uses RESTful API; simple `curl` commands or even your browser will work! [This website can help as well](https://curl.trillworks.com/).
61- [JWT Debugger](https://jwt.io) and the corresponding [RFC](https://tools.ietf.org/html/rfc7519) 65- [JWT Debugger](https://jwt.io) and the corresponding [RFC](https://tools.ietf.org/html/rfc7519)
62- Remember that you are absolutely encouraged to grab off-the-shelf implementations for every cryptography primitive you will use. You can start by finding a code snippet to generate a RSA keypair? 66- Remember that you are absolutely encouraged to grab off-the-shelf implementations for every cryptography primitive you will use. You can start by finding a code snippet to generate a RSA keypair?
67- Check out [misc](@/misc_docs.md) for everything else you might be curious about.
63 68
64## I found a bug! 69## I found a bug!
65Thank you! Please [let me know](mailto:yigit@ceng.metu.edu.tr) so we can solve it. 70Thank you! Please [let me know](mailto:yigit@ceng.metu.edu.tr) so we can solve it.