-
Notifications
You must be signed in to change notification settings - Fork 0
/
registry.schema.json
150 lines (150 loc) · 7.54 KB
/
registry.schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
{
"$id": "https://grafana.github.io/k6registry/registry.schema.json",
"$ref": "#/$defs/registry",
"$defs": {
"registry": {
"description": "k6 Extension Registry.\n\nThe k6 extension registry contains the most important properties of registered extensions.\n",
"type": "array",
"items": {
"$ref": "#/$defs/extension"
},
"additionalProperties": false
},
"extension": {
"type": "object",
"description": "Properties of the registered k6 extension.\n\nOnly those properties of the extensions are registered, which either cannot be detected automatically, or delegation to the extension is not allowed.\n\nProperties that are available using the repository manager API are intentionally not registered.\n\nThe string like properties that are included in the generated Grafana documentation are intentionally not accessed via the API of the repository manager. It is not allowed to inject arbitrary text into the Grafana documentation site without approval. Therefore, these properties are registered (eg `description`)\n",
"properties": {
"module": {
"type": "string",
"description": "The extension's go module path.\n\nThis is the unique identifier of the extension.\nMore info about module paths: https://go.dev/ref/mod#module-path\n\nThe extension has no name property, the module path or part of it can be used as the extension name. For example, using the first two elements of the module path after the host name, the name `grafana/xk6-dashboard` can be formed from the module path `github.com/grafana/xk6-dashboard`. This is typically the repository owner name and the repository name in the repository manager.\n\nThe extension has no URL property, a URL can be created from the module path that refers to the extension within the repository manager.\n",
"examples": [
"github.com/grafana/xk6-dashboard",
"github.com/szkiba/xk6-top"
]
},
"imports": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of JavaScript import paths registered by the extension.\n\nCurrently, paths must start with the prefix `k6/x/`.\n\nThe extensions used by k6 scripts are automatically detected based on the values specified here, therefore it is important that the values used here are consistent with the values registered by the extension at runtime.\n",
"examples": [
[
"k6/x/csv",
"k6/x/csv/stream"
],
[
"k6/x/toml"
]
]
},
"outputs": {
"type": "array",
"items": {
"type": "string"
},
"example": null,
"description": "List of output names registered by the extension.\n\nThe extensions used by k6 scripts are automatically detected based on the values specified here, therefore it is important that the values used here are consistent with the values registered by the extension at runtime.\n",
"examples": [
[
"dashboard"
],
[
"plugin"
]
]
},
"description": {
"type": "string",
"description": "Brief description of the extension.\n"
},
"repo": {
"$ref": "#/$defs/repository",
"description": "Repository metadata.\n\nMetadata provided by the extension's git repository manager. Repository metadata are not registered, they are queried at runtime using the repository manager API.\n"
},
"official": {
"type": "boolean",
"default": "false",
"description": "Officially supported extension flag.\n\nThe `true` value of the `official` flag indicates that the extension is officially supported by Grafana.\n\nExtensions owned by the `grafana` GitHub organization are not officially supported by Grafana by default. There are several k6 extensions owned by the `grafana` GitHub organization, which were created for experimental or example purposes only. The `official` flag is needed so that officially supported extensions can be distinguished from them.\n"
},
"cloud": {
"type": "boolean",
"default": "false",
"description": "Cloud-enabled extension flag.\n\nThe `true` value of the `cloud` flag indicates that the extension is also available in the Grafana k6 cloud.\n\nThe use of certain extensions is not supported in a cloud environment. There may be a technological reason for this, or the extension's functionality is meaningless in the cloud.\n"
}
},
"required": [
"module",
"description"
],
"additionalProperties": false
},
"repository": {
"type": "object",
"description": "Repository metadata.\n\nMetadata provided by the extension's git repository manager. Repository metadata are not registered, they are queried at runtime using the repository manager API.\n",
"required": [
"name",
"owner",
"url"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the repository.\n"
},
"owner": {
"type": "string",
"description": "The owner of the repository.\n"
},
"url": {
"type": "string",
"description": "URL of the repository.\n\nThe URL is provided by the repository manager and can be displayed in a browser.\n"
},
"homepage": {
"type": "string",
"default": "",
"description": "The URL to the project homepage.\n\nIf no homepage is set, the value is the same as the url property.\n"
},
"description": {
"type": "string",
"default": "",
"description": "Repository description.\n"
},
"stars": {
"type": "integer",
"default": "0",
"description": "The number of stars in the extension's repository.\n\nThe extension's popularity is indicated by how many users have starred the extension's repository.\n"
},
"topics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Repository topics.\n\nTopics make it easier to find the repository. It is recommended to set the xk6 topic to the extensions repository.\n"
},
"versions": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of supported versions.\n\nVersions are tags whose format meets the requirements of semantic versioning. Version tags often start with the letter `v`, which is not part of the semantic version.\n"
},
"public": {
"type": "boolean",
"default": "false",
"description": "Public repository flag.\n\nA `true` value indicates that the repository is public, available to anyone.\n"
},
"license": {
"type": "string",
"default": "",
"description": "The SPDX ID of the extension's license.\n\nFor more information about SPDX, visit https://spdx.org/licenses/\n"
},
"archived": {
"type": "boolean",
"default": "false",
"description": "Archived repository flag.\n\nA `true` value indicates that the repository is archived, read only.\n\nIf a repository is archived, it usually means that the owner has no intention of maintaining it. Such extensions should be removed from the registry.\n"
}
}
}
}
}