Skip to content

Commit

Permalink
chore(release): 1.0.0 [skip ci]
Browse files Browse the repository at this point in the history
# 1.0.0 (2020-12-10)

### Bug Fixes

* **README:** add space ([c8a98f1](c8a98f1))
* add titles + fix params array items ([fa144f2](fa144f2))
  • Loading branch information
semantic-release-bot committed Dec 10, 2020
1 parent fa144f2 commit 4718fd9
Show file tree
Hide file tree
Showing 6 changed files with 973 additions and 0 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# 1.0.0 (2020-12-10)


### Bug Fixes

* **README:** add space ([c8a98f1](https://github.com/etclabscore/rpcflow-meta-schema/commit/c8a98f13babb52bc9e762d80476000d2e408a267))
* add titles + fix params array items ([fa144f2](https://github.com/etclabscore/rpcflow-meta-schema/commit/fa144f2392f19cae69e9798c218996b027b7eeae))
324 changes: 324 additions & 0 deletions flow_meta_schema.go

Large diffs are not rendered by default.

209 changes: 209 additions & 0 deletions index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,209 @@
/**
*
* **REQUIRED**. This string MUST be the semantic version number of the Specification that the document uses.
*
*/
export type FlowVersion = "0.0.0-development";
/**
*
* **REQUIRED** Name of the Flow
*
* @example
* `foobarbaz`
*
*/
export type FlowName = string;
export type Namespace = string;
export type Transport = "postmessageiframe" | "postmessagewindow" | "http" | "websocket";
export type Url = string;
export interface StepProvider {
namespace: Namespace;
transport: Transport;
url: Url;
[k: string]: any;
}
export type StepProviders = StepProvider[];
/**
*
* Markdown description describing the specification extension.
*
*/
export type FlowDescription = string;
/**
*
* A short summary of what the flow is.
*
*/
export type FlowSummary = string;
export type $Id = string;
export type $Schema = string;
export type $Ref = string;
export type $Comment = string;
export type Title = string;
export type Description = string;
type AlwaysTrue = any;
export type ReadOnly = boolean;
export type Examples = AlwaysTrue[];
export type MultipleOf = number;
export type Maximum = number;
export type ExclusiveMaximum = number;
export type Minimum = number;
export type ExclusiveMinimum = number;
export type NonNegativeInteger = number;
export type NonNegativeIntegerDefaultZero = number;
export type Pattern = string;
export type SchemaArray = JSONSchema[];
/**
*
* @default true
*
*/
export type Items = JSONSchema | SchemaArray;
export type UniqueItems = boolean;
export type StringDoaGddGA = string;
/**
*
* @default []
*
*/
export type StringArray = StringDoaGddGA[];
/**
*
* @default {}
*
*/
export interface Definitions { [key: string]: any; }
/**
*
* @default {}
*
*/
export interface Properties { [key: string]: any; }
/**
*
* @default {}
*
*/
export interface PatternProperties { [key: string]: any; }
export type DependenciesSet = JSONSchema | StringArray;
export interface Dependencies { [key: string]: any; }
export type Enum = AlwaysTrue[];
export type SimpleTypes = any;
export type ArrayOfSimpleTypes = SimpleTypes[];
export type Type = SimpleTypes | ArrayOfSimpleTypes;
export type Format = string;
export type ContentMediaType = string;
export type ContentEncoding = string;
export interface JSONSchemaObject {
$id?: $Id;
$schema?: $Schema;
$ref?: $Ref;
$comment?: $Comment;
title?: Title;
description?: Description;
default?: AlwaysTrue;
readOnly?: ReadOnly;
examples?: Examples;
multipleOf?: MultipleOf;
maximum?: Maximum;
exclusiveMaximum?: ExclusiveMaximum;
minimum?: Minimum;
exclusiveMinimum?: ExclusiveMinimum;
maxLength?: NonNegativeInteger;
minLength?: NonNegativeIntegerDefaultZero;
pattern?: Pattern;
additionalItems?: JSONSchema;
items?: Items;
maxItems?: NonNegativeInteger;
minItems?: NonNegativeIntegerDefaultZero;
uniqueItems?: UniqueItems;
contains?: JSONSchema;
maxProperties?: NonNegativeInteger;
minProperties?: NonNegativeIntegerDefaultZero;
required?: StringArray;
additionalProperties?: JSONSchema;
definitions?: Definitions;
properties?: Properties;
patternProperties?: PatternProperties;
dependencies?: Dependencies;
propertyNames?: JSONSchema;
const?: AlwaysTrue;
enum?: Enum;
type?: Type;
format?: Format;
contentMediaType?: ContentMediaType;
contentEncoding?: ContentEncoding;
if?: JSONSchema;
then?: JSONSchema;
else?: JSONSchema;
allOf?: SchemaArray;
anyOf?: SchemaArray;
oneOf?: SchemaArray;
not?: JSONSchema;
[k: string]: any;
}
/**
*
* Always valid if true. Never valid if false. Is constant.
*
*/
export type JSONSchemaBoolean = boolean;
/**
*
* @default {}
*
*/
export type JSONSchema = JSONSchemaObject | JSONSchemaBoolean;
/**
*
* Additional context provided to the flow
*
*/
export interface FlowContext { [key: string]: any; }
export interface ObjectHAgrRKSz { [key: string]: any; }
export type SetOfAnykhpArGaq = AlwaysTrue[];
export type OneOfObjectHAgrRKSzSetOfAnykhpArGaqQYzyujLV = ObjectHAgrRKSz | SetOfAnykhpArGaq;
export interface FlowObject {
method: StringDoaGddGA;
params: OneOfObjectHAgrRKSzSetOfAnykhpArGaqQYzyujLV;
[k: string]: any;
}
export interface Flow { [key: string]: any; }
/**
*
* external documentation description.
*
*/
export type FlowExternalDocumentationObjectDescription = string;
/**
*
* external documentation description.
*
*/
export type FlowExternalDocumentationObjectUrl = string;
/**
*
* Information about external documentation.
*
*/
export interface FlowExternalDocumentationObject {
description?: FlowExternalDocumentationObjectDescription;
url: FlowExternalDocumentationObjectUrl;
}
/**
*
* A standard way to define JSON-RPC flows
*
*/
export interface FlowMetaSchema {
rpcflow: FlowVersion;
name: FlowName;
stepProviders: StepProviders;
description?: FlowDescription;
summary?: FlowSummary;
contextSchema?: JSONSchema;
context?: FlowContext;
flow: Flow;
externalDocumentation?: FlowExternalDocumentationObject;
[k: string]: any;
}
5 changes: 5 additions & 0 deletions index.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 4718fd9

Please sign in to comment.