Skip to content

feat: add descriptions for every types #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

feat: add descriptions for every types #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fbcae9b
wip: descriptions
Niraj-Kamdar Mar 7, 2023
c0c9b00
feat: add descriptions
Niraj-Kamdar Mar 7, 2023
30e4280
feat: add missing descriptions
Niraj-Kamdar Mar 7, 2023
da075e5
fix: grammer
Niraj-Kamdar Mar 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions manifest/abi/0.1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"id": "Abi",
"type": "object",
"unevaluatedProperties": false,
"description": "WRAP ABI that describes the interface of the WRAP module",
"properties": {
"version": {
"description": "ABI Version",
Expand Down Expand Up @@ -60,6 +61,7 @@
"definitions": {
"objectDefinition": {
"type": "object",
"description": "Object definition that describes the structure of the object",
"allOf": [
{
"$ref": "#/definitions/genericDefinition"
Expand Down Expand Up @@ -89,6 +91,7 @@
},
"moduleDefinition": {
"type": "object",
"description": "Module definition that describes the structure of the module",
"allOf": [
{
"$ref": "#/definitions/genericDefinition"
Expand Down Expand Up @@ -124,6 +127,7 @@
},
"interfaceImplementedDefinition": {
"type": "object",
"description": "Interface Implemented definition that describes the interface implemented by the module",
"allOf": [
{
"$ref": "#/definitions/genericDefinition"
Expand All @@ -133,6 +137,7 @@
},
"methodDefinition": {
"type": "object",
"description": "Method definition that describes the signature of the method",
"required": ["return"],
"allOf": [
{
Expand All @@ -151,6 +156,7 @@
},
"env": {
"type": "object",
"description": "Allows marking the env as required for the method",
"properties": {
"required": {
"type": "boolean"
Expand All @@ -169,6 +175,7 @@
},
"envDefinition": {
"type": "object",
"description": "Env definition that describes the structure of the env",
"allOf": [
{
"$ref": "#/definitions/objectDefinition"
Expand All @@ -177,6 +184,7 @@
},
"enumDefinition": {
"type": "object",
"description": "Enum definition that describes the structure of the enum",
"required": ["constants"],
"allOf": [
{
Expand All @@ -201,6 +209,7 @@
},
"interfaceDefinition": {
"type": "object",
"description": "Interface definition that describes the structure of the interface",
"required": ["capabilities"],
"allOf": [
{
Expand All @@ -222,9 +231,11 @@
},
"capabilityDefinition": {
"type": "object",
"description": "Capability definition that contains the list of capabilities",
"properties": {
"getImplementations": {
"type": "object",
"description": "Allows enabling/disabling the `getImplementations` capability",
"required": ["enabled"],
"properties": {
"enabled": {
Expand All @@ -238,6 +249,7 @@
},
"importedDefinition": {
"type": "object",
"description": "Imported definition that contains the information about the imported `definitions`",
"required": ["uri", "namespace", "nativeType"],
"properties": {
"uri": {
Expand All @@ -254,6 +266,7 @@
},
"importedObjectDefinition": {
"type": "object",
"description": "Imported object definition that describes the structure of the imported `object`",
"allOf": [
{
"$ref": "#/definitions/objectDefinition"
Expand All @@ -269,6 +282,7 @@
},
"importedModuleDefinition": {
"type": "object",
"description": "Imported module definition that describes the structure of the imported `module`",
"allOf": [
{
"$ref": "#/definitions/genericDefinition"
Expand Down Expand Up @@ -298,6 +312,7 @@
},
"importedEnumDefinition": {
"type": "object",
"description": "Imported enum definition that describes the structure of the imported `enum`",
"allOf": [
{
"$ref": "#/definitions/enumDefinition"
Expand All @@ -310,6 +325,7 @@
},
"importedEnvDefinition": {
"type": "object",
"description": "Imported env definition that describes the structure of the imported `env`",
"allOf": [
{
"$ref": "#/definitions/importedObjectDefinition"
Expand All @@ -319,6 +335,7 @@
},
"withKind": {
"type": "object",
"description": "With kind definition that describes the kind of the definition",
"properties": {
"kind": {
"type": "number"
Expand All @@ -329,6 +346,7 @@
},
"withComment": {
"type": "object",
"description": "With comment definition that describes the comment of the definition",
"properties": {
"comment": {
"type": "string"
Expand All @@ -338,6 +356,7 @@
},
"propertyDefinition": {
"type": "object",
"description": "Property definition that describes the structure of the property",
"allOf": [
{
"$ref": "#/definitions/withComment"
Expand All @@ -350,6 +369,7 @@
},
"genericDefinition": {
"type": "object",
"description": "Generic definition that describes the structure of the definition",
"allOf": [
{
"$ref": "#/definitions/withKind"
Expand All @@ -374,6 +394,7 @@
},
"anyDefinition": {
"type": "object",
"description": "Any definition that describes the structure of any `definition`",
"allOf": [
{
"$ref": "#/definitions/genericDefinition"
Expand Down Expand Up @@ -411,6 +432,7 @@
},
"arrayDefinition": {
"type": "object",
"description": "Array definition that describes the structure of the `array`",
"allOf": [
{
"$ref": "#/definitions/anyDefinition"
Expand All @@ -429,6 +451,7 @@
},
"scalarType": {
"type": "string",
"description": "Scalar type that describes the type of the `scalar`",
"enum": [
"UInt",
"UInt8",
Expand All @@ -448,6 +471,7 @@
},
"scalarDefinition": {
"type": "object",
"description": "Scalar definition that describes the structure of the `scalar` type",
"allOf": [
{
"$ref": "#/definitions/genericDefinition"
Expand All @@ -463,6 +487,7 @@
},
"mapKeyType": {
"type": "string",
"description": "Map key type that describes the type of the `map` key",
"enum": [
"UInt",
"UInt8",
Expand All @@ -477,6 +502,7 @@
},
"mapKeyDefinition": {
"type": "object",
"description": "Map key definition that describes the structure of the `map` key",
"allOf": [
{
"$ref": "#/definitions/anyDefinition"
Expand All @@ -495,6 +521,7 @@
},
"mapDefinition": {
"type": "object",
"description": "Map definition that describes the structure of the `map`",
"allOf": [
{
"$ref": "#/definitions/anyDefinition"
Expand All @@ -519,6 +546,7 @@
},
"objectRef": {
"type": "object",
"description": "Object reference that points to an object definition",
"allOf": [
{
"$ref": "#/definitions/genericDefinition"
Expand All @@ -528,6 +556,7 @@
},
"enumRef": {
"type": "object",
"description": "Enum reference that points to an enum definition",
"allOf": [
{
"$ref": "#/definitions/genericDefinition"
Expand All @@ -537,6 +566,7 @@
},
"unresolvedObjectOrEnumRef": {
"type": "object",
"description": "Unresolved object or enum reference that doesn't point to any object or enum definition",
"allOf": [
{
"$ref": "#/definitions/genericDefinition"
Expand All @@ -546,6 +576,7 @@
},
"importedModuleRef": {
"type": "object",
"description": "Imported module points that refers to an imported module",
"properties": {
"type": {
"type": "string"
Expand Down
3 changes: 2 additions & 1 deletion manifest/wrap.info/0.1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
"type",
"abi"
],
"description": "Wrap Manifest that contains metadata for the WRAP package",
"properties": {
"version": {
"description": "WRAP Standard Version",
Expand All @@ -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"
}
}
}