@open-rpc/meta-schema
Advanced tools
Comparing version 1.14.6 to 1.14.7
@@ -128,3 +128,3 @@ export type Openrpc = "1.3.2" | "1.3.1" | "1.3.0" | "1.2.6" | "1.2.5" | "1.2.4" | "1.2.3" | "1.2.2" | "1.2.1" | "1.2.0" | "1.1.12" | "1.1.11" | "1.1.10" | "1.1.9" | "1.1.8" | "1.1.7" | "1.1.6" | "1.1.5" | "1.1.4" | "1.1.3" | "1.1.2" | "1.1.1" | "1.1.0" | "1.0.0" | "1.0.0-rc1" | "1.0.0-rc0"; | ||
export type Pattern = string; | ||
export type SchemaArray = Undefined[]; | ||
export type SchemaArray = JSONSchema[]; | ||
/** | ||
@@ -135,3 +135,3 @@ * | ||
*/ | ||
export type Items = Undefined | SchemaArray; | ||
export type Items = JSONSchema | SchemaArray; | ||
export type UniqueItems = boolean; | ||
@@ -163,3 +163,3 @@ export type StringDoaGddGA = string; | ||
export interface PatternProperties { [key: string]: any; } | ||
export type DependenciesSet = Undefined | StringArray; | ||
export type DependenciesSet = JSONSchema | StringArray; | ||
export interface Dependencies { [key: string]: any; } | ||
@@ -191,3 +191,3 @@ export type Enum = AlwaysTrue[]; | ||
pattern?: Pattern; | ||
additionalItems?: Undefined; | ||
additionalItems?: JSONSchema; | ||
items?: Items; | ||
@@ -197,7 +197,7 @@ maxItems?: NonNegativeInteger; | ||
uniqueItems?: UniqueItems; | ||
contains?: Undefined; | ||
contains?: JSONSchema; | ||
maxProperties?: NonNegativeInteger; | ||
minProperties?: NonNegativeIntegerDefaultZero; | ||
required?: StringArray; | ||
additionalProperties?: Undefined; | ||
additionalProperties?: JSONSchema; | ||
definitions?: Definitions; | ||
@@ -207,3 +207,3 @@ properties?: Properties; | ||
dependencies?: Dependencies; | ||
propertyNames?: Undefined; | ||
propertyNames?: JSONSchema; | ||
const?: AlwaysTrue; | ||
@@ -215,9 +215,9 @@ enum?: Enum; | ||
contentEncoding?: ContentEncoding; | ||
if?: Undefined; | ||
then?: Undefined; | ||
else?: Undefined; | ||
if?: JSONSchema; | ||
then?: JSONSchema; | ||
else?: JSONSchema; | ||
allOf?: SchemaArray; | ||
anyOf?: SchemaArray; | ||
oneOf?: SchemaArray; | ||
not?: Undefined; | ||
not?: JSONSchema; | ||
[k: string]: any; | ||
@@ -243,3 +243,3 @@ } | ||
summary?: ContentDescriptorObjectSummary; | ||
schema: Undefined; | ||
schema: JSONSchema; | ||
required?: ContentDescriptorObjectRequired; | ||
@@ -246,0 +246,0 @@ deprecated?: ContentDescriptorObjectDeprecated; |
"use strict"; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
exports.openrpcDocument = void 0; | ||
exports.openrpcDocument = { "$schema": "https://meta.json-schema.tools/", "$id": "https://meta.open-rpc.org/", "title": "openrpcDocument", "type": "object", "required": ["info", "methods", "openrpc"], "additionalProperties": false, "patternProperties": { "^x-": { "$ref": "#/definitions/specificationExtension" } }, "properties": { "openrpc": { "$ref": "#/definitions/openrpc" }, "info": { "$ref": "#/definitions/infoObject" }, "externalDocs": { "$ref": "#/definitions/externalDocumentationObject" }, "servers": { "$ref": "#/definitions/servers" }, "methods": { "$ref": "#/definitions/methods" }, "components": { "$ref": "#/definitions/components" }, "$schema": { "$ref": "#/definitions/metaSchema" } }, "definitions": { "openrpc": { "title": "openrpc", "type": "string", "enum": ["1.3.2", "1.3.1", "1.3.0", "1.2.6", "1.2.5", "1.2.4", "1.2.3", "1.2.2", "1.2.1", "1.2.0", "1.1.12", "1.1.11", "1.1.10", "1.1.9", "1.1.8", "1.1.7", "1.1.6", "1.1.5", "1.1.4", "1.1.3", "1.1.2", "1.1.1", "1.1.0", "1.0.0", "1.0.0-rc1", "1.0.0-rc0"] }, "infoObjectProperties": { "title": "infoObjectProperties", "type": "string" }, "infoObjectDescription": { "title": "infoObjectDescription", "type": "string" }, "infoObjectTermsOfService": { "title": "infoObjectTermsOfService", "type": "string", "format": "uri" }, "infoObjectVersion": { "title": "infoObjectVersion", "type": "string" }, "contactObjectName": { "title": "contactObjectName", "type": "string" }, "contactObjectEmail": { "title": "contactObjectEmail", "type": "string" }, "contactObjectUrl": { "title": "contactObjectUrl", "type": "string" }, "specificationExtension": { "title": "specificationExtension" }, "contactObject": { "title": "contactObject", "type": "object", "additionalProperties": false, "properties": { "name": { "$ref": "#/definitions/contactObjectName" }, "email": { "$ref": "#/definitions/contactObjectEmail" }, "url": { "$ref": "#/definitions/contactObjectUrl" } }, "patternProperties": { "^x-": { "$ref": "#/definitions/specificationExtension" } } }, "licenseObjectName": { "title": "licenseObjectName", "type": "string" }, "licenseObjectUrl": { "title": "licenseObjectUrl", "type": "string" }, "licenseObject": { "title": "licenseObject", "type": "object", "additionalProperties": false, "properties": { "name": { "$ref": "#/definitions/licenseObjectName" }, "url": { "$ref": "#/definitions/licenseObjectUrl" } }, "patternProperties": { "^x-": { "$ref": "#/definitions/specificationExtension" } } }, "infoObject": { "title": "infoObject", "type": "object", "additionalProperties": false, "required": ["title", "version"], "properties": { "title": { "$ref": "#/definitions/infoObjectProperties" }, "description": { "$ref": "#/definitions/infoObjectDescription" }, "termsOfService": { "$ref": "#/definitions/infoObjectTermsOfService" }, "version": { "$ref": "#/definitions/infoObjectVersion" }, "contact": { "$ref": "#/definitions/contactObject" }, "license": { "$ref": "#/definitions/licenseObject" } }, "patternProperties": { "^x-": { "$ref": "#/definitions/specificationExtension" } } }, "externalDocumentationObjectDescription": { "title": "externalDocumentationObjectDescription", "type": "string" }, "externalDocumentationObjectUrl": { "title": "externalDocumentationObjectUrl", "type": "string", "format": "uri" }, "externalDocumentationObject": { "title": "externalDocumentationObject", "type": "object", "additionalProperties": false, "description": "information about external documentation", "required": ["url"], "properties": { "description": { "$ref": "#/definitions/externalDocumentationObjectDescription" }, "url": { "$ref": "#/definitions/externalDocumentationObjectUrl" } }, "patternProperties": { "^x-": { "$ref": "#/definitions/specificationExtension" } } }, "serverObjectUrl": { "title": "serverObjectUrl", "type": "string", "format": "uri" }, "serverObjectName": { "title": "serverObjectName", "type": "string" }, "serverObjectDescription": { "title": "serverObjectDescription", "type": "string" }, "serverObjectSummary": { "title": "serverObjectSummary", "type": "string" }, "serverObjectVariableDefault": { "title": "serverObjectVariableDefault", "type": "string" }, "serverObjectVariableDescription": { "title": "serverObjectVariableDescription", "type": "string" }, "serverObjectVariableEnumItem": { "title": "serverObjectVariableEnumItem", "type": "string" }, "serverObjectVariableEnum": { "title": "serverObjectVariableEnum", "type": "array", "items": { "$ref": "#/definitions/serverObjectVariableEnumItem" } }, "serverObjectVariable": { "title": "serverObjectVariable", "type": "object", "required": ["default"], "properties": { "default": { "$ref": "#/definitions/serverObjectVariableDefault" }, "description": { "$ref": "#/definitions/serverObjectVariableDescription" }, "enum": { "$ref": "#/definitions/serverObjectVariableEnum" } } }, "serverObjectVariables": { "title": "serverObjectVariables", "type": "object", "patternProperties": { "[0-z]+": { "$ref": "#/definitions/serverObjectVariable" } } }, "serverObject": { "title": "serverObject", "type": "object", "required": ["url"], "additionalProperties": false, "properties": { "url": { "$ref": "#/definitions/serverObjectUrl" }, "name": { "$ref": "#/definitions/serverObjectName" }, "description": { "$ref": "#/definitions/serverObjectDescription" }, "summary": { "$ref": "#/definitions/serverObjectSummary" }, "variables": { "$ref": "#/definitions/serverObjectVariables" } }, "patternProperties": { "^x-": { "$ref": "#/definitions/specificationExtension" } } }, "AlwaysFalse": false, "servers": { "title": "servers", "type": "array", "additionalItems": false, "items": { "$ref": "#/definitions/serverObject" } }, "methodObjectName": { "title": "methodObjectName", "description": "The cannonical name for the method. The name MUST be unique within the methods array.", "type": "string", "minLength": 1 }, "methodObjectDescription": { "title": "methodObjectDescription", "description": "A verbose explanation of the method behavior. GitHub Flavored Markdown syntax MAY be used for rich text representation.", "type": "string" }, "methodObjectSummary": { "title": "methodObjectSummary", "description": "A short summary of what the method does.", "type": "string" }, "tagObjectName": { "title": "tagObjectName", "type": "string", "minLength": 1 }, "tagObjectDescription": { "title": "tagObjectDescription", "type": "string" }, "tagObject": { "title": "tagObject", "type": "object", "additionalProperties": false, "required": ["name"], "properties": { "name": { "$ref": "#/definitions/tagObjectName" }, "description": { "$ref": "#/definitions/tagObjectDescription" }, "externalDocs": { "$ref": "#/definitions/externalDocumentationObject" } }, "patternProperties": { "^x-": { "$ref": "#/definitions/specificationExtension" } } }, "$ref": { "title": "$ref", "type": "string", "format": "uri-reference" }, "referenceObject": { "title": "referenceObject", "type": "object", "additionalProperties": false, "required": ["$ref"], "properties": { "$ref": { "$ref": "#/definitions/$ref" } } }, "tagOrReference": { "title": "tagOrReference", "oneOf": [{ "$ref": "#/definitions/tagObject" }, { "$ref": "#/definitions/referenceObject" }] }, "methodObjectTags": { "title": "methodObjectTags", "type": "array", "items": { "$ref": "#/definitions/tagOrReference" } }, "methodObjectParamStructure": { "title": "methodObjectParamStructure", "type": "string", "description": "Format the server expects the params. Defaults to 'either'.", "enum": ["by-position", "by-name", "either"], "default": "either" }, "contentDescriptorObjectName": { "title": "contentDescriptorObjectName", "type": "string", "minLength": 1 }, "contentDescriptorObjectDescription": { "title": "contentDescriptorObjectDescription", "type": "string" }, "contentDescriptorObjectSummary": { "title": "contentDescriptorObjectSummary", "type": "string" }, "$id": { "title": "$id", "type": "string", "format": "uri-reference" }, "$schema": { "title": "$schema", "type": "string", "format": "uri" }, "$comment": { "title": "$comment", "type": "string" }, "title": { "title": "title", "type": "string" }, "description": { "title": "description", "type": "string" }, "AlwaysTrue": true, "readOnly": { "title": "readOnly", "type": "boolean", "default": false }, "examples": { "title": "examples", "type": "array", "items": true }, "multipleOf": { "title": "multipleOf", "type": "number", "exclusiveMinimum": 0 }, "maximum": { "title": "maximum", "type": "number" }, "exclusiveMaximum": { "title": "exclusiveMaximum", "type": "number" }, "minimum": { "title": "minimum", "type": "number" }, "exclusiveMinimum": { "title": "exclusiveMinimum", "type": "number" }, "nonNegativeInteger": { "title": "nonNegativeInteger", "type": "integer", "minimum": 0 }, "nonNegativeIntegerDefaultZero": { "title": "nonNegativeIntegerDefaultZero", "type": "integer", "minimum": 0, "default": 0 }, "pattern": { "title": "pattern", "type": "string", "format": "regex" }, "schemaArray": { "title": "schemaArray", "type": "array", "minItems": 1, "items": { "$ref": "#/definitions/undefined" } }, "items": { "title": "items", "anyOf": [{ "$ref": "#/definitions/undefined" }, { "$ref": "#/definitions/schemaArray" }], "default": true }, "uniqueItems": { "title": "uniqueItems", "type": "boolean", "default": false }, "string_doaGddGA": { "type": "string", "title": "string_doaGddGA" }, "stringArray": { "title": "stringArray", "type": "array", "items": { "$ref": "#/definitions/string_doaGddGA" }, "uniqueItems": true, "default": [] }, "definitions": { "title": "definitions", "type": "object", "additionalProperties": { "$ref": "#/definitions/undefined" }, "default": {} }, "properties": { "title": "properties", "type": "object", "additionalProperties": { "$ref": "#/definitions/undefined" }, "default": {} }, "patternProperties": { "title": "patternProperties", "type": "object", "additionalProperties": { "$ref": "#/definitions/undefined" }, "propertyNames": { "title": "propertyNames", "format": "regex" }, "default": {} }, "dependenciesSet": { "title": "dependenciesSet", "anyOf": [{ "$ref": "#/definitions/undefined" }, { "$ref": "#/definitions/stringArray" }] }, "dependencies": { "title": "dependencies", "type": "object", "additionalProperties": { "$ref": "#/definitions/dependenciesSet" } }, "enum": { "title": "enum", "type": "array", "items": true, "minItems": 1, "uniqueItems": true }, "simpleTypes": { "title": "simpleTypes", "enum": ["array", "boolean", "integer", "null", "number", "object", "string"] }, "arrayOfSimpleTypes": { "title": "arrayOfSimpleTypes", "type": "array", "items": { "$ref": "#/definitions/simpleTypes" }, "minItems": 1, "uniqueItems": true }, "type": { "title": "type", "anyOf": [{ "$ref": "#/definitions/simpleTypes" }, { "$ref": "#/definitions/arrayOfSimpleTypes" }] }, "format": { "title": "format", "type": "string" }, "contentMediaType": { "title": "contentMediaType", "type": "string" }, "contentEncoding": { "title": "contentEncoding", "type": "string" }, "JSONSchemaObject": { "title": "JSONSchemaObject", "type": "object", "properties": { "$id": { "$ref": "#/definitions/$id" }, "$schema": { "$ref": "#/definitions/$schema" }, "$ref": { "$ref": "#/definitions/$ref" }, "$comment": { "$ref": "#/definitions/$comment" }, "title": { "$ref": "#/definitions/title" }, "description": { "$ref": "#/definitions/description" }, "default": true, "readOnly": { "$ref": "#/definitions/readOnly" }, "examples": { "$ref": "#/definitions/examples" }, "multipleOf": { "$ref": "#/definitions/multipleOf" }, "maximum": { "$ref": "#/definitions/maximum" }, "exclusiveMaximum": { "$ref": "#/definitions/exclusiveMaximum" }, "minimum": { "$ref": "#/definitions/minimum" }, "exclusiveMinimum": { "$ref": "#/definitions/exclusiveMinimum" }, "maxLength": { "$ref": "#/definitions/nonNegativeInteger" }, "minLength": { "$ref": "#/definitions/nonNegativeIntegerDefaultZero" }, "pattern": { "$ref": "#/definitions/pattern" }, "additionalItems": { "$ref": "#/definitions/undefined" }, "items": { "$ref": "#/definitions/items" }, "maxItems": { "$ref": "#/definitions/nonNegativeInteger" }, "minItems": { "$ref": "#/definitions/nonNegativeIntegerDefaultZero" }, "uniqueItems": { "$ref": "#/definitions/uniqueItems" }, "contains": { "$ref": "#/definitions/undefined" }, "maxProperties": { "$ref": "#/definitions/nonNegativeInteger" }, "minProperties": { "$ref": "#/definitions/nonNegativeIntegerDefaultZero" }, "required": { "$ref": "#/definitions/stringArray" }, "additionalProperties": { "$ref": "#/definitions/undefined" }, "definitions": { "$ref": "#/definitions/definitions" }, "properties": { "$ref": "#/definitions/properties" }, "patternProperties": { "$ref": "#/definitions/patternProperties" }, "dependencies": { "$ref": "#/definitions/dependencies" }, "propertyNames": { "$ref": "#/definitions/undefined" }, "const": true, "enum": { "$ref": "#/definitions/enum" }, "type": { "$ref": "#/definitions/type" }, "format": { "$ref": "#/definitions/format" }, "contentMediaType": { "$ref": "#/definitions/contentMediaType" }, "contentEncoding": { "$ref": "#/definitions/contentEncoding" }, "if": { "$ref": "#/definitions/undefined" }, "then": { "$ref": "#/definitions/undefined" }, "else": { "$ref": "#/definitions/undefined" }, "allOf": { "$ref": "#/definitions/schemaArray" }, "anyOf": { "$ref": "#/definitions/schemaArray" }, "oneOf": { "$ref": "#/definitions/schemaArray" }, "not": { "$ref": "#/definitions/undefined" } } }, "JSONSchemaBoolean": { "title": "JSONSchemaBoolean", "description": "Always valid if true. Never valid if false. Is constant.", "type": "boolean" }, "JSONSchema": { "$schema": "https://meta.json-schema.tools/", "$id": "https://meta.json-schema.tools/", "title": "JSONSchema", "default": {}, "oneOf": [{ "$ref": "#/definitions/JSONSchemaObject" }, { "$ref": "#/definitions/JSONSchemaBoolean" }], "definitions": { "JSONSchemaBoolean": { "$ref": "#/definitions/JSONSchemaBoolean" }, "JSONSchemaObject": { "$ref": "#/definitions/JSONSchemaObject" }, "schemaArray": { "$ref": "#/definitions/schemaArray" }, "nonNegativeInteger": { "$ref": "#/definitions/nonNegativeInteger" }, "nonNegativeIntegerDefault0": { "$ref": "#/definitions/nonNegativeIntegerDefaultZero" }, "simpleTypes": { "$ref": "#/definitions/simpleTypes" }, "stringArray": { "$ref": "#/definitions/stringArray" } }, "isCycle": true }, "contentDescriptorObjectRequired": { "title": "contentDescriptorObjectRequired", "type": "boolean", "default": false }, "contentDescriptorObjectDeprecated": { "title": "contentDescriptorObjectDeprecated", "type": "boolean", "default": false }, "contentDescriptorObject": { "title": "contentDescriptorObject", "type": "object", "additionalProperties": false, "required": ["name", "schema"], "properties": { "name": { "$ref": "#/definitions/contentDescriptorObjectName" }, "description": { "$ref": "#/definitions/contentDescriptorObjectDescription" }, "summary": { "$ref": "#/definitions/contentDescriptorObjectSummary" }, "schema": { "$ref": "#/definitions/undefined" }, "required": { "$ref": "#/definitions/contentDescriptorObjectRequired" }, "deprecated": { "$ref": "#/definitions/contentDescriptorObjectDeprecated" } }, "patternProperties": { "^x-": { "$ref": "#/definitions/specificationExtension" } } }, "contentDescriptorOrReference": { "title": "contentDescriptorOrReference", "oneOf": [{ "$ref": "#/definitions/contentDescriptorObject" }, { "$ref": "#/definitions/referenceObject" }] }, "methodObjectParams": { "title": "methodObjectParams", "type": "array", "items": { "$ref": "#/definitions/contentDescriptorOrReference" } }, "methodObjectResult": { "title": "methodObjectResult", "oneOf": [{ "$ref": "#/definitions/contentDescriptorObject" }, { "$ref": "#/definitions/referenceObject" }] }, "errorObjectCode": { "title": "errorObjectCode", "description": "A Number that indicates the error type that occurred. This MUST be an integer. The error codes from and including -32768 to -32000 are reserved for pre-defined errors. These pre-defined errors SHOULD be assumed to be returned from any JSON-RPC api.", "type": "integer" }, "errorObjectMessage": { "title": "errorObjectMessage", "description": "A String providing a short description of the error. The message SHOULD be limited to a concise single sentence.", "type": "string" }, "errorObjectData": { "title": "errorObjectData", "description": "A Primitive or Structured value that contains additional information about the error. This may be omitted. The value of this member is defined by the Server (e.g. detailed error information, nested errors etc.)." }, "errorObject": { "title": "errorObject", "type": "object", "description": "Defines an application level error.", "additionalProperties": false, "required": ["code", "message"], "properties": { "code": { "$ref": "#/definitions/errorObjectCode" }, "message": { "$ref": "#/definitions/errorObjectMessage" }, "data": { "$ref": "#/definitions/errorObjectData" } } }, "errorOrReference": { "title": "errorOrReference", "oneOf": [{ "$ref": "#/definitions/errorObject" }, { "$ref": "#/definitions/referenceObject" }] }, "methodObjectErrors": { "title": "methodObjectErrors", "description": "Defines an application level error.", "type": "array", "items": { "$ref": "#/definitions/errorOrReference" } }, "linkObjectName": { "title": "linkObjectName", "type": "string", "minLength": 1 }, "linkObjectSummary": { "title": "linkObjectSummary", "type": "string" }, "linkObjectMethod": { "title": "linkObjectMethod", "type": "string" }, "linkObjectDescription": { "title": "linkObjectDescription", "type": "string" }, "linkObjectParams": { "title": "linkObjectParams" }, "linkObjectServer": { "title": "linkObjectServer", "type": "object", "required": ["url"], "additionalProperties": false, "properties": { "url": { "$ref": "#/definitions/serverObjectUrl" }, "name": { "$ref": "#/definitions/serverObjectName" }, "description": { "$ref": "#/definitions/serverObjectDescription" }, "summary": { "$ref": "#/definitions/serverObjectSummary" }, "variables": { "$ref": "#/definitions/serverObjectVariables" } }, "patternProperties": { "^x-": { "$ref": "#/definitions/specificationExtension" } } }, "linkObject": { "title": "linkObject", "type": "object", "additionalProperties": false, "properties": { "name": { "$ref": "#/definitions/linkObjectName" }, "summary": { "$ref": "#/definitions/linkObjectSummary" }, "method": { "$ref": "#/definitions/linkObjectMethod" }, "description": { "$ref": "#/definitions/linkObjectDescription" }, "params": { "$ref": "#/definitions/linkObjectParams" }, "server": { "$ref": "#/definitions/linkObjectServer" } }, "patternProperties": { "^x-": { "$ref": "#/definitions/specificationExtension" } } }, "linkOrReference": { "title": "linkOrReference", "oneOf": [{ "$ref": "#/definitions/linkObject" }, { "$ref": "#/definitions/referenceObject" }] }, "methodObjectLinks": { "title": "methodObjectLinks", "type": "array", "items": { "$ref": "#/definitions/linkOrReference" } }, "examplePairingObjectName": { "title": "examplePairingObjectName", "type": "string", "minLength": 1 }, "examplePairingObjectDescription": { "title": "examplePairingObjectDescription", "type": "string" }, "exampleObjectSummary": { "title": "exampleObjectSummary", "type": "string" }, "exampleObjectValue": { "title": "exampleObjectValue" }, "exampleObjectDescription": { "title": "exampleObjectDescription", "type": "string" }, "exampleObjectName": { "title": "exampleObjectName", "type": "string", "minLength": 1 }, "exampleObject": { "title": "exampleObject", "type": "object", "required": ["name", "value"], "properties": { "summary": { "$ref": "#/definitions/exampleObjectSummary" }, "value": { "$ref": "#/definitions/exampleObjectValue" }, "description": { "$ref": "#/definitions/exampleObjectDescription" }, "name": { "$ref": "#/definitions/exampleObjectName" } }, "patternProperties": { "^x-": { "$ref": "#/definitions/specificationExtension" } } }, "exampleOrReference": { "title": "exampleOrReference", "oneOf": [{ "$ref": "#/definitions/exampleObject" }, { "$ref": "#/definitions/referenceObject" }] }, "examplePairingObjectParams": { "title": "examplePairingObjectParams", "type": "array", "items": { "$ref": "#/definitions/exampleOrReference" } }, "examplePairingObjectResult": { "title": "examplePairingObjectResult", "oneOf": [{ "$ref": "#/definitions/exampleObject" }, { "$ref": "#/definitions/referenceObject" }] }, "examplePairingObject": { "title": "examplePairingObject", "type": "object", "required": ["name", "params"], "properties": { "name": { "$ref": "#/definitions/examplePairingObjectName" }, "description": { "$ref": "#/definitions/examplePairingObjectDescription" }, "params": { "$ref": "#/definitions/examplePairingObjectParams" }, "result": { "$ref": "#/definitions/examplePairingObjectResult" } } }, "examplePairingOrReference": { "title": "examplePairingOrReference", "oneOf": [{ "$ref": "#/definitions/examplePairingObject" }, { "$ref": "#/definitions/referenceObject" }] }, "methodObjectExamples": { "title": "methodObjectExamples", "type": "array", "items": { "$ref": "#/definitions/examplePairingOrReference" } }, "methodObjectDeprecated": { "title": "methodObjectDeprecated", "type": "boolean", "default": false }, "methodObject": { "title": "methodObject", "type": "object", "required": ["name", "params"], "additionalProperties": false, "properties": { "name": { "$ref": "#/definitions/methodObjectName" }, "description": { "$ref": "#/definitions/methodObjectDescription" }, "summary": { "$ref": "#/definitions/methodObjectSummary" }, "servers": { "$ref": "#/definitions/servers" }, "tags": { "$ref": "#/definitions/methodObjectTags" }, "paramStructure": { "$ref": "#/definitions/methodObjectParamStructure" }, "params": { "$ref": "#/definitions/methodObjectParams" }, "result": { "$ref": "#/definitions/methodObjectResult" }, "errors": { "$ref": "#/definitions/methodObjectErrors" }, "links": { "$ref": "#/definitions/methodObjectLinks" }, "examples": { "$ref": "#/definitions/methodObjectExamples" }, "deprecated": { "$ref": "#/definitions/methodObjectDeprecated" }, "externalDocs": { "$ref": "#/definitions/externalDocumentationObject" } }, "patternProperties": { "^x-": { "$ref": "#/definitions/specificationExtension" } } }, "methodOrReference": { "title": "methodOrReference", "oneOf": [{ "$ref": "#/definitions/methodObject" }, { "$ref": "#/definitions/referenceObject" }] }, "methods": { "title": "methods", "type": "array", "additionalItems": false, "items": { "$ref": "#/definitions/methodOrReference" } }, "schemaComponents": { "title": "schemaComponents", "type": "object", "patternProperties": { "[0-z]+": { "$ref": "#/definitions/undefined" } } }, "linkComponents": { "title": "linkComponents", "type": "object", "patternProperties": { "[0-z]+": { "$ref": "#/definitions/linkObject" } } }, "errorComponents": { "title": "errorComponents", "type": "object", "patternProperties": { "[0-z]+": { "$ref": "#/definitions/errorObject" } } }, "exampleComponents": { "title": "exampleComponents", "type": "object", "patternProperties": { "[0-z]+": { "$ref": "#/definitions/exampleObject" } } }, "examplePairingComponents": { "title": "examplePairingComponents", "type": "object", "patternProperties": { "[0-z]+": { "$ref": "#/definitions/examplePairingObject" } } }, "contentDescriptorComponents": { "title": "contentDescriptorComponents", "type": "object", "patternProperties": { "[0-z]+": { "$ref": "#/definitions/contentDescriptorObject" } } }, "tagComponents": { "title": "tagComponents", "type": "object", "patternProperties": { "[0-z]+": { "$ref": "#/definitions/tagObject" } } }, "components": { "title": "components", "type": "object", "properties": { "schemas": { "$ref": "#/definitions/schemaComponents" }, "links": { "$ref": "#/definitions/linkComponents" }, "errors": { "$ref": "#/definitions/errorComponents" }, "examples": { "$ref": "#/definitions/exampleComponents" }, "examplePairings": { "$ref": "#/definitions/examplePairingComponents" }, "contentDescriptors": { "$ref": "#/definitions/contentDescriptorComponents" }, "tags": { "$ref": "#/definitions/tagComponents" } } }, "metaSchema": { "title": "metaSchema", "description": "JSON Schema URI (used by some editors)", "type": "string", "default": "https://meta.open-rpc.org/" } } }; | ||
exports.openrpcDocument = { "$schema": "https://meta.json-schema.tools/", "$id": "https://meta.open-rpc.org/", "title": "openrpcDocument", "type": "object", "required": ["info", "methods", "openrpc"], "additionalProperties": false, "patternProperties": { "^x-": { "$ref": "#/definitions/specificationExtension" } }, "properties": { "openrpc": { "title": "openrpc", "type": "string", "enum": ["1.3.2", "1.3.1", "1.3.0", "1.2.6", "1.2.5", "1.2.4", "1.2.3", "1.2.2", "1.2.1", "1.2.0", "1.1.12", "1.1.11", "1.1.10", "1.1.9", "1.1.8", "1.1.7", "1.1.6", "1.1.5", "1.1.4", "1.1.3", "1.1.2", "1.1.1", "1.1.0", "1.0.0", "1.0.0-rc1", "1.0.0-rc0"] }, "info": { "$ref": "#/definitions/infoObject" }, "externalDocs": { "$ref": "#/definitions/externalDocumentationObject" }, "servers": { "title": "servers", "type": "array", "additionalItems": false, "items": { "$ref": "#/definitions/serverObject" } }, "methods": { "title": "methods", "type": "array", "additionalItems": false, "items": { "title": "methodOrReference", "oneOf": [{ "$ref": "#/definitions/methodObject" }, { "$ref": "#/definitions/referenceObject" }] } }, "components": { "title": "components", "type": "object", "properties": { "schemas": { "title": "schemaComponents", "type": "object", "patternProperties": { "[0-z]+": { "$ref": "#/definitions/JSONSchema" } } }, "links": { "title": "linkComponents", "type": "object", "patternProperties": { "[0-z]+": { "$ref": "#/definitions/linkObject" } } }, "errors": { "title": "errorComponents", "type": "object", "patternProperties": { "[0-z]+": { "$ref": "#/definitions/errorObject" } } }, "examples": { "title": "exampleComponents", "type": "object", "patternProperties": { "[0-z]+": { "$ref": "#/definitions/exampleObject" } } }, "examplePairings": { "title": "examplePairingComponents", "type": "object", "patternProperties": { "[0-z]+": { "$ref": "#/definitions/examplePairingObject" } } }, "contentDescriptors": { "title": "contentDescriptorComponents", "type": "object", "patternProperties": { "[0-z]+": { "$ref": "#/definitions/contentDescriptorObject" } } }, "tags": { "title": "tagComponents", "type": "object", "patternProperties": { "[0-z]+": { "$ref": "#/definitions/tagObject" } } } } }, "$schema": { "title": "metaSchema", "description": "JSON Schema URI (used by some editors)", "type": "string", "default": "https://meta.open-rpc.org/" } }, "definitions": { "specificationExtension": { "title": "specificationExtension" }, "JSONSchema": { "$ref": "https://raw.githubusercontent.com/json-schema-tools/meta-schema/1.5.9/src/schema.json" }, "referenceObject": { "title": "referenceObject", "type": "object", "additionalProperties": false, "required": ["$ref"], "properties": { "$ref": { "$ref": "https://raw.githubusercontent.com/json-schema-tools/meta-schema/1.5.9/src/schema.json#/definitions/JSONSchemaObject/properties/$ref" } } }, "errorObject": { "title": "errorObject", "type": "object", "description": "Defines an application level error.", "additionalProperties": false, "required": ["code", "message"], "properties": { "code": { "title": "errorObjectCode", "description": "A Number that indicates the error type that occurred. This MUST be an integer. The error codes from and including -32768 to -32000 are reserved for pre-defined errors. These pre-defined errors SHOULD be assumed to be returned from any JSON-RPC api.", "type": "integer" }, "message": { "title": "errorObjectMessage", "description": "A String providing a short description of the error. The message SHOULD be limited to a concise single sentence.", "type": "string" }, "data": { "title": "errorObjectData", "description": "A Primitive or Structured value that contains additional information about the error. This may be omitted. The value of this member is defined by the Server (e.g. detailed error information, nested errors etc.)." } } }, "licenseObject": { "title": "licenseObject", "type": "object", "additionalProperties": false, "properties": { "name": { "title": "licenseObjectName", "type": "string" }, "url": { "title": "licenseObjectUrl", "type": "string" } }, "patternProperties": { "^x-": { "$ref": "#/definitions/specificationExtension" } } }, "contactObject": { "title": "contactObject", "type": "object", "additionalProperties": false, "properties": { "name": { "title": "contactObjectName", "type": "string" }, "email": { "title": "contactObjectEmail", "type": "string" }, "url": { "title": "contactObjectUrl", "type": "string" } }, "patternProperties": { "^x-": { "$ref": "#/definitions/specificationExtension" } } }, "infoObject": { "title": "infoObject", "type": "object", "additionalProperties": false, "required": ["title", "version"], "properties": { "title": { "title": "infoObjectProperties", "type": "string" }, "description": { "title": "infoObjectDescription", "type": "string" }, "termsOfService": { "title": "infoObjectTermsOfService", "type": "string", "format": "uri" }, "version": { "title": "infoObjectVersion", "type": "string" }, "contact": { "$ref": "#/definitions/contactObject" }, "license": { "$ref": "#/definitions/licenseObject" } }, "patternProperties": { "^x-": { "$ref": "#/definitions/specificationExtension" } } }, "serverObject": { "title": "serverObject", "type": "object", "required": ["url"], "additionalProperties": false, "properties": { "url": { "title": "serverObjectUrl", "type": "string", "format": "uri" }, "name": { "title": "serverObjectName", "type": "string" }, "description": { "title": "serverObjectDescription", "type": "string" }, "summary": { "title": "serverObjectSummary", "type": "string" }, "variables": { "title": "serverObjectVariables", "type": "object", "patternProperties": { "[0-z]+": { "title": "serverObjectVariable", "type": "object", "required": ["default"], "properties": { "default": { "title": "serverObjectVariableDefault", "type": "string" }, "description": { "title": "serverObjectVariableDescription", "type": "string" }, "enum": { "title": "serverObjectVariableEnum", "type": "array", "items": { "title": "serverObjectVariableEnumItem", "type": "string" } } } } } } }, "patternProperties": { "^x-": { "$ref": "#/definitions/specificationExtension" } } }, "linkObject": { "title": "linkObject", "type": "object", "additionalProperties": false, "properties": { "name": { "title": "linkObjectName", "type": "string", "minLength": 1 }, "summary": { "title": "linkObjectSummary", "type": "string" }, "method": { "title": "linkObjectMethod", "type": "string" }, "description": { "title": "linkObjectDescription", "type": "string" }, "params": { "title": "linkObjectParams" }, "server": { "title": "linkObjectServer", "$ref": "#/definitions/serverObject" } }, "patternProperties": { "^x-": { "$ref": "#/definitions/specificationExtension" } } }, "externalDocumentationObject": { "title": "externalDocumentationObject", "type": "object", "additionalProperties": false, "description": "information about external documentation", "required": ["url"], "properties": { "description": { "title": "externalDocumentationObjectDescription", "type": "string" }, "url": { "title": "externalDocumentationObjectUrl", "type": "string", "format": "uri" } }, "patternProperties": { "^x-": { "$ref": "#/definitions/specificationExtension" } } }, "methodObject": { "title": "methodObject", "type": "object", "required": ["name", "params"], "additionalProperties": false, "properties": { "name": { "title": "methodObjectName", "description": "The cannonical name for the method. The name MUST be unique within the methods array.", "type": "string", "minLength": 1 }, "description": { "title": "methodObjectDescription", "description": "A verbose explanation of the method behavior. GitHub Flavored Markdown syntax MAY be used for rich text representation.", "type": "string" }, "summary": { "title": "methodObjectSummary", "description": "A short summary of what the method does.", "type": "string" }, "servers": { "title": "servers", "type": "array", "additionalItems": false, "items": { "$ref": "#/definitions/serverObject" } }, "tags": { "title": "methodObjectTags", "type": "array", "items": { "title": "tagOrReference", "oneOf": [{ "$ref": "#/definitions/tagObject" }, { "$ref": "#/definitions/referenceObject" }] } }, "paramStructure": { "title": "methodObjectParamStructure", "type": "string", "description": "Format the server expects the params. Defaults to 'either'.", "enum": ["by-position", "by-name", "either"], "default": "either" }, "params": { "title": "methodObjectParams", "type": "array", "items": { "title": "contentDescriptorOrReference", "oneOf": [{ "$ref": "#/definitions/contentDescriptorObject" }, { "$ref": "#/definitions/referenceObject" }] } }, "result": { "title": "methodObjectResult", "oneOf": [{ "$ref": "#/definitions/contentDescriptorObject" }, { "$ref": "#/definitions/referenceObject" }] }, "errors": { "title": "methodObjectErrors", "description": "Defines an application level error.", "type": "array", "items": { "title": "errorOrReference", "oneOf": [{ "$ref": "#/definitions/errorObject" }, { "$ref": "#/definitions/referenceObject" }] } }, "links": { "title": "methodObjectLinks", "type": "array", "items": { "title": "linkOrReference", "oneOf": [{ "$ref": "#/definitions/linkObject" }, { "$ref": "#/definitions/referenceObject" }] } }, "examples": { "title": "methodObjectExamples", "type": "array", "items": { "title": "examplePairingOrReference", "oneOf": [{ "$ref": "#/definitions/examplePairingObject" }, { "$ref": "#/definitions/referenceObject" }] } }, "deprecated": { "title": "methodObjectDeprecated", "type": "boolean", "default": false }, "externalDocs": { "$ref": "#/definitions/externalDocumentationObject" } }, "patternProperties": { "^x-": { "$ref": "#/definitions/specificationExtension" } } }, "tagObject": { "title": "tagObject", "type": "object", "additionalProperties": false, "required": ["name"], "properties": { "name": { "title": "tagObjectName", "type": "string", "minLength": 1 }, "description": { "title": "tagObjectDescription", "type": "string" }, "externalDocs": { "$ref": "#/definitions/externalDocumentationObject" } }, "patternProperties": { "^x-": { "$ref": "#/definitions/specificationExtension" } } }, "exampleObject": { "title": "exampleObject", "type": "object", "required": ["name", "value"], "properties": { "summary": { "title": "exampleObjectSummary", "type": "string" }, "value": { "title": "exampleObjectValue" }, "description": { "title": "exampleObjectDescription", "type": "string" }, "name": { "title": "exampleObjectName", "type": "string", "minLength": 1 } }, "patternProperties": { "^x-": { "$ref": "#/definitions/specificationExtension" } } }, "examplePairingObject": { "title": "examplePairingObject", "type": "object", "required": ["name", "params"], "properties": { "name": { "title": "examplePairingObjectName", "type": "string", "minLength": 1 }, "description": { "title": "examplePairingObjectDescription", "type": "string" }, "params": { "title": "examplePairingObjectParams", "type": "array", "items": { "title": "exampleOrReference", "oneOf": [{ "$ref": "#/definitions/exampleObject" }, { "$ref": "#/definitions/referenceObject" }] } }, "result": { "title": "examplePairingObjectResult", "oneOf": [{ "$ref": "#/definitions/exampleObject" }, { "$ref": "#/definitions/referenceObject" }] } } }, "contentDescriptorObject": { "title": "contentDescriptorObject", "type": "object", "additionalProperties": false, "required": ["name", "schema"], "properties": { "name": { "title": "contentDescriptorObjectName", "type": "string", "minLength": 1 }, "description": { "title": "contentDescriptorObjectDescription", "type": "string" }, "summary": { "title": "contentDescriptorObjectSummary", "type": "string" }, "schema": { "$ref": "#/definitions/JSONSchema" }, "required": { "title": "contentDescriptorObjectRequired", "type": "boolean", "default": false }, "deprecated": { "title": "contentDescriptorObjectDeprecated", "type": "boolean", "default": false } }, "patternProperties": { "^x-": { "$ref": "#/definitions/specificationExtension" } } } } }; | ||
exports.default = exports.openrpcDocument; |
{ | ||
"name": "@open-rpc/meta-schema", | ||
"version": "1.14.6", | ||
"version": "1.14.7", | ||
"description": "OpenRPC Specification JSON schemas", | ||
@@ -30,3 +30,3 @@ "author": { | ||
"@json-schema-tools/dereferencer": "^1.4.0", | ||
"@json-schema-tools/semantic-release-transpiler": "^1.6.14", | ||
"@json-schema-tools/semantic-release-transpiler": "^1.6.16", | ||
"@qiwi/semantic-release-gh-pages-plugin": "^5.2.4", | ||
@@ -33,0 +33,0 @@ "@semantic-release/changelog": "^6.0.2", |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
38411
427