Skip to content

Commit

Permalink
update json schema documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@fetsorn
fetsorn committed Jun 17, 2022
1 parent e8d00e3 commit cd3a92b
Show file tree
Hide file tree
Showing 20 changed files with 167 additions and 20 deletions.
6 changes: 6 additions & 0 deletions packages/manifest-schemas/formats/polywrap.app/0.0.1-prealpha.1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,28 +9,34 @@
],
"properties": {
"format": {
"description": "Polywrap app manifest format version.",
"type": "string",
"const": "0.0.1-prealpha.1"
},
"language": {
"description": "Language in which the source code is written.",
"type": "string",
"format": "appLanguage"
},
"schema": {
"description": "Path to graphql schema.",
"type": "string",
"format": "file"
},
"import_redirects": {
"description": "Redirects enabling the import of plugins.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"uri": {
"description": "URI resolving to the plugin schema.",
"type": "string",
"format": "polywrapUri"
},
"schema": {
"description": "Graphql schema for imported plugin.",
"type": "string",
"format": "schemaFile"
}
Expand Down
7 changes: 7 additions & 0 deletions packages/manifest-schemas/formats/polywrap.app/0.0.1-prealpha.2.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,32 +10,39 @@
],
"properties": {
"format": {
"description": "Polywrap app manifest format version.",
"type": "string",
"const": "0.0.1-prealpha.2"
},
"name": {
"description": "Name of this wrapper package.",
"type": "string",
"format": "packageName"
},
"language": {
"description": "Language in which the source code is written.",
"type": "string",
"format": "appLanguage"
},
"schema": {
"description": "Path to graphql schema.",
"type": "string",
"format": "file"
},
"import_redirects": {
"description": "Redirects enabling the import of plugins.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"uri": {
"description": "URI resolving to the plugin schema.",
"type": "string",
"format": "polywrapUri"
},
"schema": {
"description": "Graphql schema for imported plugin.",
"type": "string",
"format": "schemaFile"
}
Expand Down
14 changes: 14 additions & 0 deletions packages/manifest-schemas/formats/polywrap.build/0.0.1-prealpha.3.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"required": ["format"],
"properties": {
"format": {
"description": "Polywrap build manifest format version.",
"type": "string",
"const": "0.0.1-prealpha.3"
},
Expand All @@ -13,55 +14,68 @@
"additionalProperties": false,
"properties": {
"name": {
"description": "Docker image name.",
"type": "string",
"format": "dockerImageName"
},
"dockerfile": {
"description": "Docker image file name.",
"type": "string",
"format": "dockerfileName"
},
"buildImageId": {
"description": "Id of the docker image.",
"type": "string",
"format": "dockerImageId"
},
"buildx": {
"description": "Configuration options for Docker Buildx, set to true for default value.",
"type": ["object", "boolean"],
"additionalProperties": false,
"properties": {
"cache": {
"description": "Path to cache directory, set to true for default value, set to false to disable caching.",
"type": ["string", "boolean"],
"format": "directory"
},
"output": {
"description": "Path to cache directory, set to true or false for default value.",
"type": ["string", "boolean"],
"format": "buildxOutput"
},
"removeBuilder": {
"description": "Remove a builder instance.",
"type": "boolean"
}
}
},
"removeImage": {
"description": "Remove the image.",
"type": "boolean"
}
}
},
"config": {
"description": "Custom configuration.",
"type": "object"
},
"linked_packages": {
"description": "Locally linked packages into docker build image.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Package name.",
"type": "string"
},
"path": {
"description": "Path to linked package directory.",
"type": "string"
},
"filter": {
"description": "Ignore files matching this regex in linked package directory.",
"type": "string",
"format": "regexString"
}
Expand Down
6 changes: 6 additions & 0 deletions packages/manifest-schemas/formats/polywrap.deploy/0.0.1-prealpha.1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,32 @@
],
"properties": {
"format": {
"description": "Polywrap deployment manifest format version.",
"type": "string",
"const": "0.0.1-prealpha.1"
},
"stages": {
"patternProperties": {
"^.*$": {
"description": "Deployment stage.",
"type": "object",
"additionalProperties": false,
"required": ["package"],
"properties": {
"package": {
"description": "Name of the publisher plugin.",
"type": "string"
},
"config": {
"description": "Custom configuration.",
"type": "object"
},
"depends_on": {
"description": "Name of the required stage.",
"type": "string"
},
"uri": {
"description": "URI resolving to the publisher plugin.",
"type": "string",
"format": "polywrapUri"
}
Expand Down
8 changes: 8 additions & 0 deletions packages/manifest-schemas/formats/polywrap.infra/0.0.1-prealpha.1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,12 @@
"required": ["format", "modules"],
"properties": {
"format": {
"description": "Polywrap infra manifest format version.",
"type": "string",
"const": "0.0.1-prealpha.1"
},
"dockerCompose": {
"description": "Path to docker compose manifest.",
"type": "string"
},
"env": {
Expand All @@ -32,19 +34,24 @@
},
"definitions": {
"remoteModule": {
"description": "A remote docker-compose package.",
"type": "object",
"additionalProperties": false,
"properties": {
"package": {
"description": "Package name.",
"type": "string"
},
"registry": {
"description": "Package registry name.",
"type": "string"
},
"version": {
"description": "Package version.",
"type": "string"
},
"dockerComposePath": {
"description": "Path to docker-compose file in the package directory.",
"type": "string"
}
},
Expand All @@ -55,6 +62,7 @@
"additionalProperties": false,
"properties": {
"path": {
"description": "Path to the package.",
"type": "string"
}
},
Expand Down
10 changes: 10 additions & 0 deletions packages/manifest-schemas/formats/polywrap.infra/0.0.1-prealpha.2.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,12 @@
"required": ["format", "modules"],
"properties": {
"format": {
"description": "Polywrap infra manifest format version.",
"type": "string",
"const": "0.0.1-prealpha.2"
},
"dockerCompose": {
"description": "Path to docker compose manifest.",
"type": "string"
},
"env": {
Expand All @@ -33,35 +35,43 @@
},
"definitions": {
"remoteModule": {
"description": "A remote package with a docker-compose file.",
"type": "object",
"additionalProperties": false,
"properties": {
"package": {
"description": "Package name.",
"type": "string"
},
"registry": {
"description": "Package registry name.",
"type": "string"
},
"version": {
"description": "Package version.",
"type": "string"
},
"dockerComposePath": {
"description": "Path to docker-compose file in the package directory.",
"type": "string"
}
},
"required": ["package", "version", "registry"]
},
"localModule": {
"description": "A local package with a docker-compose file.",
"type": "object",
"additionalProperties": false,
"properties": {
"path": {
"description": "Path to the package.",
"type": "string"
}
},
"required": ["path"]
},
"defaultModule": {
"description": "A module available by default.",
"type": "string",
"const": "default"
}
Expand Down
2 changes: 1 addition & 1 deletion packages/manifest-schemas/formats/polywrap.meta/0.0.1-prealpha.1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@
"format": "graphqlFile"
},
"vars": {
"description": "Query variables",
"description": "Query parameters.",
"type": "string",
"format": "jsonFile"
}
Expand Down
15 changes: 15 additions & 0 deletions packages/manifest-schemas/formats/polywrap.meta/0.0.1-prealpha.2.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,40 +7,50 @@
],
"properties": {
"format": {
"description": "Polywrap wrapper metadata manifest format version.",
"type": "string",
"const": "0.0.1-prealpha.2"
},
"displayName": {
"description": "Name of the wrapper.",
"type": "string"
},
"subtext": {
"description": "Short or summary description of the wrapper.",
"type": "string"
},
"description": {
"description": "Long description for the wrapper.",
"type": "string"
},
"repository": {
"description": "Reference to the repository holding source code.",
"type": "string",
"format": "websiteUrl"
},
"icon": {
"description": "Path to wrapper icon.",
"type": "string",
"format": "imageFile"
},
"links": {
"description": "Relevant web links.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Web link name.",
"type": "string"
},
"icon": {
"description": "Web link icon.",
"type": "string",
"format": "imageFile"
},
"url": {
"description": "Url to the web link.",
"type": "string",
"format": "websiteUrl"
}
Expand All @@ -52,22 +62,27 @@
}
},
"queries": {
"description": "List of example queries.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Query name.",
"type": "string"
},
"description": {
"description": "Query description.",
"type": "string"
},
"query": {
"description": "Path to graph ql file.",
"type": "string",
"format": "graphqlFile"
},
"vars": {
"description": "Query parameters.",
"type": "string",
"format": "jsonFile"
}
Expand Down
Loading

0 comments on commit cd3a92b

Please sign in to comment.