package pluginapi.v1

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc FormatContent (FormatContentRequest, FormatContentResponse)

  plugin.proto:25

  message FormatContentRequest

  plugin.proto:59

  • string formatter = 1

  • string format = 2

  • optional Block args = 3

  • optional Block config = 4

  • optional MapData data_context = 5

  • optional MapData content = 6

  message FormatContentResponse

  plugin.proto:68

  • optional FormattedContent result = 1

  • repeated Diagnostic diagnostics = 2

• rpc GetSchema (GetSchemaRequest, GetSchemaResponse)

  plugin.proto:22

  message GetSchemaRequest

  plugin.proto:29

  (message has no fields)

  message GetSchemaResponse

  plugin.proto:31

  • optional Schema schema = 1

• rpc ProvideContent (ProvideContentRequest, ProvideContentResponse)

  plugin.proto:24

  message ProvideContentRequest

  plugin.proto:46

  • string provider = 1

  • optional Block args = 2

  • optional Block config = 3

  • optional MapData data_context = 4

  • uint32 content_id = 5

  message ProvideContentResponse

  plugin.proto:54

  • optional ContentProviderResult result = 1

  • repeated Diagnostic diagnostics = 2

• rpc Publish (PublishRequest, PublishResponse)

  plugin.proto:26

  message PublishRequest

  plugin.proto:73

  • string publisher = 1

  • optional Block args = 2

  • optional Block config = 3

  • optional MapData data_context = 4

  • optional FormattedContent formatted_content = 5

  • optional Content content = 6

  • string document_name = 7

  message PublishResponse

  plugin.proto:85

  • repeated Diagnostic diagnostics = 1

• rpc RetrieveData (RetrieveDataRequest, RetrieveDataResponse)

  plugin.proto:23

  message RetrieveDataRequest

  plugin.proto:35

  • string source = 1

  • optional Block args = 2

  • optional Block config = 3

  message RetrieveDataResponse

  plugin.proto:41

  • optional Data data = 1

  • repeated Diagnostic diagnostics = 2

Used in: Block

• string name = 1

• optional Range name_range = 2

• optional CtyValue value = 3

• optional Range value_range = 4

• bool secret = 5

Used in: BlockSpec

• string name = 1

• optional CtyType type = 2

• optional CtyValue default_val = 3

• optional CtyValue example_val = 4

• string doc = 5

• uint32 constraints = 7

• repeated CtyValue one_of = 8

• optional CtyValue min_inclusive = 9

• optional CtyValue max_inclusive = 10

• string deprecated = 11

• bool secret = 12

Used in: FormatContentRequest, ProvideContentRequest, PublishRequest, RetrieveDataRequest

• repeated string header = 1

• repeated Range header_ranges = 2

• map<string, Attr> attributes = 3

• repeated Block blocks = 4

• optional Range contents_range = 5

Used in: ContentElement, ContentSection

• string kind = 1

• string runner = 2

• string name = 3

• string id = 4

• uint32 depth = 5

Used in: ContentProviderSchema, DataSourceSchema, FormatterSchema, PublisherSchema

• repeated BlockSpec.NameMatcher headers_spec = 1

• bool required = 2

• bool repeatable = 3

• string doc = 4

• repeated BlockSpec block_specs = 5

• repeated AttrSpec attr_specs = 6

• bool allow_unspecified_blocks = 7

• bool allow_unspecified_attributes = 8

Used in: BlockSpec

• oneof matcher

  • NameMatcher.Exact exact = 1

Used in: NameMatcher

• repeated string matches = 1

Used in: ContentProviderResult, ContentSection, Document, PublishRequest

• oneof value

  • ContentElement element = 1

  • ContentSection section = 2

Used in: Content

• optional BlockDetails block_details = 1

• optional ExecDetails exec_details = 2

• optional MapData meta = 3

• string kind = 4

• optional MapData attrs = 5

• optional MapData data_context = 6

• bytes id = 7

Used in: ProvideContentResponse

• optional Content content = 1

Used in: Schema

• optional BlockSpec args = 1

• optional BlockSpec config = 2

• string doc = 3

• repeated string tags = 4

Used in: Content

• optional BlockDetails block_details = 1

• optional MapData meta = 2

• optional Content title = 3

• repeated Content children = 4

• bytes id = 5

Used in: Cty.Mapping, Cty.Object.Attr, Cty.Sequence, CtyType, CtyValue

• oneof data

  Cty with nil data is decoded as cty.NilVal

  • Cty.Primitive primitive = 1

  • Cty.Object object = 2

  • Cty.Mapping map = 3

  • Cty.Sequence list = 4

  • Cty.Sequence set = 5

  • Cty.Sequence tuple = 6

  • CtyType null = 7

    Specifies type of null value

  • Cty.Capsule caps = 8

  • CtyType unknown = 9

    Specifies type of the unknown value

  • Cty.Dynamic dyn = 10

    DynamicPseudoType

Used in: Cty

• oneof data

  • Data plugin_data = 1

Used in: Cty

(message has no fields)

Used in: Cty

• map<string, Cty> data = 1

• bool only_type = 2

  Original map is empty, element was added to preserve the type

Used in: Cty

• map<string, Object.Attr> data = 1

Used in: Object

• optional Cty data = 1

• bool optional = 2

Used in: Cty

• oneof data

  • string str = 1

  • bytes num = 2

    empty value is used for marking the type

  • bool bln = 3

Used in: Cty

• repeated Cty data = 1

• bool only_type = 2

  Original sequence is empty, element added to preserve the type Not true for empty tuples, since they are valid values

Forces decoding of the inner Cty as a type

Used in: AttrSpec, Cty

• optional Cty type = 1

Forces decoding of the inner Cty as a value

Used in: Attr, AttrSpec

• optional Cty value = 1

Used in: Cty.Capsule, Document, ListData, MapData, RetrieveDataResponse

• oneof data

  • string string_val = 1

  • double number_val = 2

  • bool bool_val = 3

  • ListData list_val = 4

  • MapData map_val = 5

  • google.protobuf.Timestamp time_val = 6

Used in: Schema

• optional BlockSpec args = 1

• optional BlockSpec config = 2

• string doc = 3

• repeated string tags = 4

Used in: FormatContentResponse, ProvideContentResponse, PublishResponse, RetrieveDataResponse

• int64 severity = 1

• string summary = 2

• string detail = 3

• optional Range subject = 4

• optional Range context = 5

• string template_name = 1

• optional Content content = 2

• optional Data data = 3

Used in: ContentElement, FormattedContent

• string plugin_name = 1

• string plugin_version = 2

• string runner = 3

Used in: FormatContentResponse, PublishRequest

• optional MapData meta = 1

• optional ExecDetails exec_details = 2

• string format = 3

• bytes content = 4

Used in: Schema

• optional BlockSpec args = 1

• optional BlockSpec config = 2

• string doc = 3

• string format = 4

• string file_ext = 5

Used in: Data

• repeated Data value = 1

Used in: ContentElement, ContentSection, Data, FormatContentRequest, FormattedContent, ProvideContentRequest, PublishRequest

• map<string, Data> value = 1

Used in: Range

• int64 line = 1

• int64 column = 2

• int64 byte = 3

Used in: Schema

• optional BlockSpec args = 1

• optional BlockSpec config = 2

• string doc = 3

• repeated string tags = 4

• repeated string formats = 5

Used in: Attr, Block, Diagnostic

• string filename = 1

• optional Pos start = 2

• optional Pos end = 3

Used in: GetSchemaResponse

• string name = 1

• string version = 2

• map<string, DataSourceSchema> data_sources = 3

  Plugin components

• map<string, ContentProviderSchema> content_providers = 4

• map<string, PublisherSchema> publishers = 7

• map<string, FormatterSchema> formatters = 8

• string doc = 5

• repeated string tags = 6