Swagger document generation, required field is invalid

[eddycjy]

Hello,

I now have a problem that when the swagger document is generated, the required fields are invalid.

1. test.proto:

syntax = "proto3";

package test;

import "protoc-gen-swagger/options/annotations.proto";
import "google/api/annotations.proto";

service TestService {
    rpc GetProject(ProjectRequest) returns (ProjectResponse) {
        option (google.api.http) = {
            get : "/projects"
        };
    }
}

message ProjectRequest {
    option (grpc.gateway.protoc_gen_swagger.options.openapiv2_schema) = {
        json_schema: {
             required: [ "project_id" ];
        };
    };
    int64 project_id = 1;
}

message ProjectResponse {

}

2. command

protoc -I=. -I=$GOPATH/src/github.com/grpc-ecosystem/grpc-gateway \
                -I=$GOPATH/src/github.com/grpc-ecosystem/grpc-gateway/third_party/googleapis \
                --grpc-gateway_out=logtostderr=true:. \
                --go_out=plugins=grpc:. \
                --swagger_out=logtostderr=true:. \
                ./test.proto 

3. test.swagger.json:

{
  "swagger": "2.0",
  "info": {
    "title": "test.proto",
    "version": "version not set"
  },
  "schemes": [
    "http",
    "https"
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "paths": {
    "/projects": {
      "get": {
        "operationId": "GetProject",
        "responses": {
          "200": {
            "description": "",
            "schema": {
              "$ref": "#/definitions/testProjectResponse"
            }
          }
        },
        "parameters": [
          {
            "name": "project_id",
            "in": "query",
            "required": false,
            "type": "string",
            "format": "int64"
          }
        ],
        "tags": [
          "TestService"
        ]
      }
    }
  },
  "definitions": {
    "testProjectResponse": {
      "type": "object"
    }
  }
}

I hope parameters (project_id) is true, but got false...

Expected results, etc.

 "parameters": [
          {
            "name": "project_id",
            "in": "query",
            "required": true,
            "type": "string",
            "format": "int64"
          }
        ],

How can I solve this problem ?

[achew22]

I don't think the code actually supports that right now. That said, it shouldn't be super difficult to add it to the parser. It's already plumed with the appropriate types. You would just need to detect when it is in the list of required fields?

@ivucica, do you have any more specific tips than I just provided? Also, looking at it, why is required a property of the message instead of of the field?

[phamducmanh1989]

@eddycjy You can try

message ProjectRequest { int64 project_id = 1 [(grpc.gateway.protoc_gen_swagger.options.openapiv2_field) = { required: ["project_id"]; }]; }