n5i-plugin-proto 0.12.0-dev.2

Protobuf definitions for n5i plugins
Documentation 
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

// SPDX-FileCopyrightText: 2024-2026 The n5i Project
//
// SPDX-License-Identifier: AGPL-3.0-or-later

syntax = "proto3";

package n5i_plugin;
import "common.proto";

message ParseAppRequest {
  string app_id = 1;
  // The directory of the app as a compressed tar archive (compressed using gzip)
  bytes app_directory = 2;
  UserState user_state = 3;
  optional string initial_domain = 4;
  string app_seed_base = 5;
}

message ParseAppResponse {
  // The JSON-encoded parsed app in Nirvati's internal app format
  string parsed_app = 1;
}

message InstallAppRequest {
  string app_id = 1;
  // The directory of the app as a compressed tar archive (compressed using gzip)
  bytes app_directory = 2;
  UserState user_state = 3;
  optional string initial_domain = 4;
  string app_seed_base = 5;
}

message InstallAppResponse {}

message UninstallAppRequest {
  string app_id = 1;
  // The directory of the app as a compressed tar archive (compressed using gzip)
  bytes app_directory = 2;
  UserState user_state = 3;
  string app_seed_base = 4;
}

message UninstallAppResponse {}

message PauseAppRequest {
  string app_id = 1;
  // The directory of the app as a compressed tar archive (compressed using gzip)
  bytes app_directory = 2;
  UserState user_state = 3;
  optional string initial_domain = 4;
  string app_seed_base = 5;
}

message PauseAppResponse {}

message ResumeAppRequest {
  string app_id = 1;
  // The directory of the app as a compressed tar archive (compressed using gzip)
  bytes app_directory = 2;
  UserState user_state = 3;
  optional string initial_domain = 4;
  string app_seed_base = 5;
}

message ResumeAppResponse {}

message IsSupportedAppRequest {
  string app_id = 1;
  bytes app_directory = 2;
  UserState user_state = 3;
}

message IsSupportedAppResponse {
  bool supported = 1;
}

// A parser/runtime plugin adds a custom parser for app files
// It may also contain a custom runtime for the app and just proxy to it
service RuntimePlugin {
  rpc IsSupportedApp(IsSupportedAppRequest) returns (IsSupportedAppResponse) {}
  rpc ParseApp(ParseAppRequest) returns (ParseAppResponse) {}
  // Installs are also partially handled by Nirvati, but this lets the plugin know about it
  // so it can also do something on its part if needed for the particular format
  rpc InstallApp(InstallAppRequest) returns (InstallAppResponse) {}
  rpc UninstallApp(UninstallAppRequest) returns (UninstallAppResponse) {}
  rpc PauseApp(PauseAppRequest) returns (PauseAppResponse) {}
  rpc ResumeApp(ResumeAppRequest) returns (ResumeAppResponse) {}
}