aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--index.json24
1 files changed, 13 insertions, 11 deletions
diff --git a/index.json b/index.json
index 1c8ed0b..7162dd7 100644
--- a/index.json
+++ b/index.json
@@ -78,7 +78,7 @@
// "long_name" should be used to specify a user-friendly alternative
// to an identifier. It should generally not collide with a long
- // name of some resource with a different uuid and also shouldn't
+ // name of some resource with a different UUID and also shouldn't
// change in-between versions of the same resource, although
// exceptions to both rules might be considered. Long name is
// allowed to contain arbitrary unicode characters (within reason!).
@@ -95,13 +95,15 @@
// the same.
// Different versions (e.g. 1.0 and 1.3) of the same resource can be
// defined in separate index.json files. This makes it easy to
- // accidently cause an identifier clash. To help detect it, we
- // require that each resource has a uuid associated with it. Attempt
- // to define multiple resources with the same identifier and
- // different uuids will result in an error being reported. Defining
- // multiple resources with different identifiers and the same uuid
- // is disallowed for now (it may be later permitted if we consider
- // it good for some use-case).
+ // accidently cause an identifier clash. To help detect it, we allow
+ // each resource to have a UUID associated with it. Attempt to
+ // define multiple resources with the same identifier and different
+ // UUIDs will result in an error being reported. Defining multiple
+ // resources with different identifiers and the same UUID is
+ // disallowed for now (it may be later permitted if we consider it
+ // good for some use-case).
+ // As of package source schema version 1.0, UUIDs are optional and
+ // can be omitted.
"uuid": "a6754dcb-58d8-4b7a-a245-24fd7ad4cd68",
// Version should match the upstream version of the resource (e.g. a
@@ -157,9 +159,9 @@
"identifier": "helloapple",
// "long name" and "uuid" have the same meaning as in the case of
- // resources. Uuids of a resource and a mapping can technically be
- // the same, but it is recommended to avoid even this kind of
- // repetition.
+ // resources and "uuid" is also optional. UUIDs of a resource and a
+ // mapping can technically be the same but it is recommended to
+ // avoid even this kind of repetition.
"long_name": "Hello Apple",
"uuid": "54d23bba-472e-42f5-9194-eaa24c0e3ee7",