Add homepage_url to manifests

reputation-network · Sep 26, 2018 · 18bdf20 · 18bdf20
1 parent ffe909a
commit 18bdf20
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git a/docs/contents/reference/registry.rst b/docs/contents/reference/registry.rst
@@ -18,9 +18,10 @@ A sample manifest file looks as follows:
   { "version": "1.0",
     "name": "Super Scoring App",
     "description": "This app provides great risk scores",
+    "homepage_url": "http://example.com/super-scoring-app",
     "picture_url": "http://example.com/logo-square.png",
     "address": "0xc25b4ff9eb6f52392eef1e103daacc7519795f01",
-    "app_url": "http://api.example.com/super-scoring-app",
+    "app_url": "http://api.example.com/super-scoring-app/data",
     "app_reward": 10,
     "app_schema": "{\"score\":5}",
     "app_dependencies": [
@@ -37,6 +38,8 @@ The manifest file must be serialized as JSON and has the following fields:
 
 - Description: a human-readable description for the actor, which will be used in permission dialogs along with the name.
 
+- Homepage URL: a URL where a user can get more information about the app, opt-in, and opt-out.
+
 - Picture URL: a square picture that represents the actor, which will be used in permission dialogs along with the name and description.
 
 - Address: the public key of the app.

diff --git a/docs/contents/tutorial/hello_world.rst b/docs/contents/tutorial/hello_world.rst
@@ -56,6 +56,7 @@ We'll build a simple Ruby service that computes the magic number given a subject
     version: '1.0',
     name: 'Hello World',
     description: 'Returns a magic number',
+    homepage_url: "http://localhost:8081",
     address: '0x88032398beab20017e61064af3c7c8bd38f4c968',
     app_url: 'http://localhost:8081/data',
     app_reward: 0,
@@ -97,6 +98,7 @@ This will launch a server that listens on port 8080 and has two endpoints:
     "name": "Hello World",
     "description": "Returns a magic number",
     "address": "0x88032398beab20017e61064af3c7c8bd38f4c968",
+    "homepage_url": "http://localhost:8081",
     "app_url": "http://localhost:8081/data",
     "app_reward": 0,
     "app_dependencies": []

diff --git a/docs/contents/tutorial/risk_score.rst b/docs/contents/tutorial/risk_score.rst
@@ -79,6 +79,7 @@ We'll build a service in Node.js that makes some computation out of the magic nu
     "name": "Risk Score",
     "description": "Returns a risk score based on your data",
     "address": "0x6d644c57247de51da20797f14dceedfbc4ef6561",
+    "homepage_url": "http://localhost:8083",
     "app_url": "http://localhost:8083/data",
     "app_reward": 0,
     "app_dependencies": ['0x88032398beab20017e61064af3c7c8bd38f4c968'],
@@ -113,6 +114,7 @@ This will launch a server that listens on port 8082 and has two endpoints:
     "name": "Risk Score",
     "description": "Returns a risk score based on your data",
     "address": "0x6d644c57247de51da20797f14dceedfbc4ef6561",
+    "homepage_url": "http://localhost:8083",
     "app_url": "http://localhost:8083/data",
     "app_reward": 0,
     "app_dependencies": ['0x88032398beab20017e61064af3c7c8bd38f4c968']