node-grpc-gateway/swagger.proto at master · MinterTeam/node-grpc-gateway · GitHub

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
syntax = "proto3";

package api_pb;

option go_package = "github.com/MinterTeam/node-grpc-gateway/gen/go;api_pb";

import "protoc-gen-openapiv2/options/annotations.proto";

message ErrorBody {
    message Error {
        string code = 1;
        string message = 2;
        map<string,string> data = 3;
    }
    Error error = 1;
}

option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
    info: {
        title: "Minter Node API v2"
        license: {
            name: "MIT"
            url: 'https://github.com/MinterTeam/minter-go-node/blob/master/LICENSE'
        };
        version: "1.7.1"
        contact: {
            name: "Minter gRPC-Gateway"
            url: "https://github.com/MinterTeam/node-grpc-gateway"
            email: "sk@minter.org"
        };
    };
    base_path: "/v2"
    external_docs: {
        url: "https://www.minter.network/docs";
        description: "More about Minter blockchain";
    }
    consumes: "application/json"
    produces: "application/json"
    responses: {
        key: "default"
        value: {
            description: "An unexpected error response."
            schema: {
                json_schema: {
                    ref: ".api_pb.ErrorBody"
                };
                example: "{\"error\": {\"code\": \"504\", \"message\": \"context deadline exceeded\", \"data\": {\"operation\":\"ABC\"}}}"
            };
        };
    };
};