From fbcae9bae1535be89221209adb8b47165d16866d Mon Sep 17 00:00:00 2001 From: Niraj Kamdar Date: Tue, 7 Mar 2023 14:10:39 +0400 Subject: [PATCH 1/4] wip: descriptions --- manifest/abi/0.1.json | 1 + manifest/wrap.info/0.1.json | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/manifest/abi/0.1.json b/manifest/abi/0.1.json index fd3e425..134f441 100644 --- a/manifest/abi/0.1.json +++ b/manifest/abi/0.1.json @@ -2,6 +2,7 @@ "id": "Abi", "type": "object", "unevaluatedProperties": false, + "description": "ABI JSON Schema", "properties": { "version": { "description": "ABI Version", diff --git a/manifest/wrap.info/0.1.json b/manifest/wrap.info/0.1.json index 43a7363..b8cfdde 100644 --- a/manifest/wrap.info/0.1.json +++ b/manifest/wrap.info/0.1.json @@ -8,6 +8,7 @@ "type", "abi" ], + "description": "Wrap Manifest", "properties": { "version": { "description": "WRAP Standard Version", @@ -26,7 +27,7 @@ }, "abi": { "description": "Information of modules", - "$ref": "https://raw.githubusercontent.com/polywrap/wrap/master/manifest/abi/0.1.json" + "$ref": "https://raw.githubusercontent.com/polywrap/wrap/nk/wrap-0-1-docs/manifest/abi/0.1.json" } } } From c0c9b00c93a35b81601345b4d833de0aa74f8d85 Mon Sep 17 00:00:00 2001 From: Niraj Kamdar Date: Tue, 7 Mar 2023 14:25:04 +0400 Subject: [PATCH 2/4] feat: add descriptions --- manifest/abi/0.1.json | 30 +++++++++++++++++++++++++++++- manifest/wrap.info/0.1.json | 2 +- 2 files changed, 30 insertions(+), 2 deletions(-) diff --git a/manifest/abi/0.1.json b/manifest/abi/0.1.json index 134f441..994d6da 100644 --- a/manifest/abi/0.1.json +++ b/manifest/abi/0.1.json @@ -2,7 +2,7 @@ "id": "Abi", "type": "object", "unevaluatedProperties": false, - "description": "ABI JSON Schema", + "description": "WRAP ABI that describes the interface of the WRAP module", "properties": { "version": { "description": "ABI Version", @@ -61,6 +61,7 @@ "definitions": { "objectDefinition": { "type": "object", + "description": "Object definition that describes the structure of the object", "allOf": [ { "$ref": "#/definitions/genericDefinition" @@ -90,6 +91,7 @@ }, "moduleDefinition": { "type": "object", + "description": "Module definition that describes the structure of the module", "allOf": [ { "$ref": "#/definitions/genericDefinition" @@ -125,6 +127,7 @@ }, "interfaceImplementedDefinition": { "type": "object", + "description": "Interface Implemented definition that describes the interface implemented by the module", "allOf": [ { "$ref": "#/definitions/genericDefinition" @@ -134,6 +137,7 @@ }, "methodDefinition": { "type": "object", + "description": "Method definition that describes the signature of the method", "required": ["return"], "allOf": [ { @@ -170,6 +174,7 @@ }, "envDefinition": { "type": "object", + "description": "Env definition that describes the structure of the env", "allOf": [ { "$ref": "#/definitions/objectDefinition" @@ -178,6 +183,7 @@ }, "enumDefinition": { "type": "object", + "description": "Enum definition that describes the structure of the enum", "required": ["constants"], "allOf": [ { @@ -202,6 +208,7 @@ }, "interfaceDefinition": { "type": "object", + "description": "Interface definition that describes the structure of the interface", "required": ["capabilities"], "allOf": [ { @@ -223,6 +230,7 @@ }, "capabilityDefinition": { "type": "object", + "description": "Capability definition that contains the list of capabilities", "properties": { "getImplementations": { "type": "object", @@ -239,6 +247,7 @@ }, "importedDefinition": { "type": "object", + "description": "Imported definition that contains the information about the imported `definitions`", "required": ["uri", "namespace", "nativeType"], "properties": { "uri": { @@ -255,6 +264,7 @@ }, "importedObjectDefinition": { "type": "object", + "description": "Imported object definition that describes the structure of the imported `object`", "allOf": [ { "$ref": "#/definitions/objectDefinition" @@ -270,6 +280,7 @@ }, "importedModuleDefinition": { "type": "object", + "description": "Imported module definition that describes the structure of the imported `module`", "allOf": [ { "$ref": "#/definitions/genericDefinition" @@ -299,6 +310,7 @@ }, "importedEnumDefinition": { "type": "object", + "description": "Imported enum definition that describes the structure of the imported `enum`", "allOf": [ { "$ref": "#/definitions/enumDefinition" @@ -311,6 +323,7 @@ }, "importedEnvDefinition": { "type": "object", + "description": "Imported env definition that describes the structure of the imported `env`", "allOf": [ { "$ref": "#/definitions/importedObjectDefinition" @@ -320,6 +333,7 @@ }, "withKind": { "type": "object", + "description": "With kind definition that describes the kind of the definition", "properties": { "kind": { "type": "number" @@ -330,6 +344,7 @@ }, "withComment": { "type": "object", + "description": "With comment definition that describes the comment of the definition", "properties": { "comment": { "type": "string" @@ -339,6 +354,7 @@ }, "propertyDefinition": { "type": "object", + "description": "Property definition that describes the structure of the property", "allOf": [ { "$ref": "#/definitions/withComment" @@ -351,6 +367,7 @@ }, "genericDefinition": { "type": "object", + "description": "Generic definition that describes the structure of the definition", "allOf": [ { "$ref": "#/definitions/withKind" @@ -375,6 +392,7 @@ }, "anyDefinition": { "type": "object", + "description": "Any definition that describes the structure of any `definition`", "allOf": [ { "$ref": "#/definitions/genericDefinition" @@ -412,6 +430,7 @@ }, "arrayDefinition": { "type": "object", + "description": "Array definition that describes the structure of the `array`", "allOf": [ { "$ref": "#/definitions/anyDefinition" @@ -430,6 +449,7 @@ }, "scalarType": { "type": "string", + "description": "Scalar type that describes the type of the `scalar`", "enum": [ "UInt", "UInt8", @@ -449,6 +469,7 @@ }, "scalarDefinition": { "type": "object", + "description": "Scalar definition that describes the structure of the `scalar` type", "allOf": [ { "$ref": "#/definitions/genericDefinition" @@ -464,6 +485,7 @@ }, "mapKeyType": { "type": "string", + "description": "Map key type that describes the type of the `map` key", "enum": [ "UInt", "UInt8", @@ -478,6 +500,7 @@ }, "mapKeyDefinition": { "type": "object", + "description": "Map key definition that describes the structure of the `map` key", "allOf": [ { "$ref": "#/definitions/anyDefinition" @@ -496,6 +519,7 @@ }, "mapDefinition": { "type": "object", + "description": "Map definition that describes the structure of the `map`", "allOf": [ { "$ref": "#/definitions/anyDefinition" @@ -520,6 +544,7 @@ }, "objectRef": { "type": "object", + "description": "Object reference that points to an object definition", "allOf": [ { "$ref": "#/definitions/genericDefinition" @@ -529,6 +554,7 @@ }, "enumRef": { "type": "object", + "description": "Enum reference that points to an enum definition", "allOf": [ { "$ref": "#/definitions/genericDefinition" @@ -538,6 +564,7 @@ }, "unresolvedObjectOrEnumRef": { "type": "object", + "description": "Unresolved object or enum reference that doesn't point to any object or enum definition", "allOf": [ { "$ref": "#/definitions/genericDefinition" @@ -547,6 +574,7 @@ }, "importedModuleRef": { "type": "object", + "description": "Imported module points that refers to an imported module", "properties": { "type": { "type": "string" diff --git a/manifest/wrap.info/0.1.json b/manifest/wrap.info/0.1.json index b8cfdde..5aaacf2 100644 --- a/manifest/wrap.info/0.1.json +++ b/manifest/wrap.info/0.1.json @@ -8,7 +8,7 @@ "type", "abi" ], - "description": "Wrap Manifest", + "description": "Wrap Manifest that contains metadata for the WRAP package", "properties": { "version": { "description": "WRAP Standard Version", From 30e42806715156a1c4364ff811e0f8fcd5d1246d Mon Sep 17 00:00:00 2001 From: Niraj Kamdar Date: Tue, 7 Mar 2023 15:50:51 +0400 Subject: [PATCH 3/4] feat: add missing descriptions --- manifest/abi/0.1.json | 2 ++ 1 file changed, 2 insertions(+) diff --git a/manifest/abi/0.1.json b/manifest/abi/0.1.json index 994d6da..48e8e4d 100644 --- a/manifest/abi/0.1.json +++ b/manifest/abi/0.1.json @@ -156,6 +156,7 @@ }, "env": { "type": "object", + "description": "Allows marking the env as required for the method", "properties": { "required": { "type": "boolean" @@ -234,6 +235,7 @@ "properties": { "getImplementations": { "type": "object", + "description": "Allows to enbale/disable the `getImplementations` capability", "required": ["enabled"], "properties": { "enabled": { From da075e550029088980282c5e172f05089d401930 Mon Sep 17 00:00:00 2001 From: Niraj Kamdar Date: Tue, 7 Mar 2023 15:52:25 +0400 Subject: [PATCH 4/4] fix: grammer --- manifest/abi/0.1.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/manifest/abi/0.1.json b/manifest/abi/0.1.json index 48e8e4d..d4004ea 100644 --- a/manifest/abi/0.1.json +++ b/manifest/abi/0.1.json @@ -235,7 +235,7 @@ "properties": { "getImplementations": { "type": "object", - "description": "Allows to enbale/disable the `getImplementations` capability", + "description": "Allows enabling/disabling the `getImplementations` capability", "required": ["enabled"], "properties": { "enabled": {