teamforus/poc-ipfs

note: work in progress, beware of the dragons 🐉

This repository is maintained by: @jastam

api.forus.io-ipfs

Document store

The document store provides storage for arbitrary JSON documents. The id in the URL corresponds to the id field in the document. When there is a conflict between these, the value in the URL takes precedence.

/api/v1/docs/{document_type}/{id}

Get document [GET]

• Response 200 (application/json)
  • Body { "id": 1 "name": "message", "value": "Hello world!" }

Create or replace document [PUT]

• Request (application/json)

  • Body { "id": 1 (optional) "name": "message", "value": "Message to add" }

• Response 200

  • Body { "result":"true" }

• Response 400

  • Body { "result":"false","error":"No valid message given" }

• Response 500

  • Body { "result":"false","error":"Server error message" }

Delete document [DELETE]

• Response 200

  • Body { "result":"true" }

• Response 400

  • Body { "result":"false","error":"No valid message given" }

• Response 500

  • Body { "result":"false" }

/api/v1/docs/{document_type}

Get list of documents [GET]

• Response 200 (application/json)
  • Body [ { "id": 1 "name": "message 1", "value": "Something" } { "id": 2 "name": "message 2", "value": "Something else" } ]

Add documents [POST]

If no id field is given in the body of the document, a random value will be generated for the id field.

• Request (application/json)

  • Body { "name": "message", "value": "Message to add" }

• Response 200

  • Body { "result":"true", "id": "3" }

• Response 400

  • Body { "result":"false","error":"No valid message given" }

• Response 500

  • Body { "result":"false" }

poc-ipfs's Issues

change name to me-api-identity

we chose to change the repo structure to a not include a domain and programming language/frameworks

Please change it.

Structure is inside:
https://github.com/teamforus/organisation-internal/issues/16

Develop centralised IPFS node

At a discussion it became clear we want data in IPFS to be owned by the user. Until now we mostly viewed IPFS like a storage backend for the application (like a database). In this view the data is owned by the application instead of the user.

For this to work in an ideal situation, users will be running IPFS nodes on their own devices and using this nodes to store and retrieve in the me app (or another app). Unfortunately, at the current state of IPFS this is not an option; node software for mobile devices doesn't exist yet and pc/mac software is not user friendly enough.

Until IPFS software is mature enough a "temporary" solution is necessary. For this a centralised IPFS node should be developed which uses the current working IPFS software for storage. This node should be accessible to user applications via an api of some sort. To the user application it should behave like a personal node and in the future it should be easily replaceable by a real personal node.

IPFS Hello Zuidhorn Service

• Implement HTTP api
• Write api documentation
• Connect http api to IPFS storage
• Add app to docker container
• Run container on AWS