Browse Source

Update schema and add docs for support

Jordi Boggiano 12 years ago
parent
commit
8c16c1bbef
2 changed files with 28 additions and 5 deletions
  1. 24 0
      doc/04-schema.md
  2. 4 5
      res/composer-schema.json

+ 24 - 0
doc/04-schema.md

@@ -200,6 +200,30 @@ An example:
 
 Optional, but highly recommended.
 
+### support
+
+Various information to get support about the project.
+
+Support information includes the following:
+
+* **email:** Email address for support.
+* **issues:** URL to the Issue Tracker.
+* **forum:** URL to the Forum.
+* **wiki:** URL to the Wiki.
+* **irc:** IRC channel for support, as irc://server/channel.
+* **source:** URL to browse or download the sources.
+
+An example:
+
+    {
+        "support": {
+            "email": "support@example.org",
+            "irc": "irc://irc.freenode.org/composer"
+        }
+    }
+
+Optional.
+
 ### Package links
 
 All of the following take an object which maps package names to

+ 4 - 5
res/composer-schema.json

@@ -209,11 +209,10 @@
         },
         "support": {
             "type": "object",
-            "additionalProperties": true,
             "properties": {
                 "email": {
                     "type": "string",
-                    "description": "Email address of the community.",
+                    "description": "Email address for support.",
                     "format": "email"
                 },
                 "issues": {
@@ -233,15 +232,15 @@
                 },
                 "irc": {
                     "type": "string",
-                    "description": "Irc support channel"
+                    "description": "IRC channel for support, as irc://server/channel.",
+                    "format": "uri"
                 },
                 "source": {
                     "type": "string",
-                    "description": "URL to the sources",
+                    "description": "URL to browse or download the sources.",
                     "format": "uri"
                 }
             }
         }
-
     }
 }