How to define multipart/form-data on proto upload in swagger









up vote
0
down vote

favorite












I'm having a hard time figuring this out.



We have defined some proto files as our contract for swagger, and I can't quite figure out how to define a multipart/form-data field on the request object.



We are using proto3 and Swagger 2.0



The request object is pretty straight forward.



message ImportRequest 
bytes file = 1;



The above isn't the result I'm looking for ... it results in this



Swagger file import result



What I need to generate from the proto file above is a swagger output like so..



 paths:
/upload:
post:
summary: Uploads a file.
consumes:
- multipart/form-data
parameters:
- in: formData
name: upfile
type: file
description: The file to upload.


The above is from here -> https://swagger.io/docs/specification/2-0/file-upload/



Any thoughts?










share|improve this question



























    up vote
    0
    down vote

    favorite












    I'm having a hard time figuring this out.



    We have defined some proto files as our contract for swagger, and I can't quite figure out how to define a multipart/form-data field on the request object.



    We are using proto3 and Swagger 2.0



    The request object is pretty straight forward.



    message ImportRequest 
    bytes file = 1;



    The above isn't the result I'm looking for ... it results in this



    Swagger file import result



    What I need to generate from the proto file above is a swagger output like so..



     paths:
    /upload:
    post:
    summary: Uploads a file.
    consumes:
    - multipart/form-data
    parameters:
    - in: formData
    name: upfile
    type: file
    description: The file to upload.


    The above is from here -> https://swagger.io/docs/specification/2-0/file-upload/



    Any thoughts?










    share|improve this question

























      up vote
      0
      down vote

      favorite









      up vote
      0
      down vote

      favorite











      I'm having a hard time figuring this out.



      We have defined some proto files as our contract for swagger, and I can't quite figure out how to define a multipart/form-data field on the request object.



      We are using proto3 and Swagger 2.0



      The request object is pretty straight forward.



      message ImportRequest 
      bytes file = 1;



      The above isn't the result I'm looking for ... it results in this



      Swagger file import result



      What I need to generate from the proto file above is a swagger output like so..



       paths:
      /upload:
      post:
      summary: Uploads a file.
      consumes:
      - multipart/form-data
      parameters:
      - in: formData
      name: upfile
      type: file
      description: The file to upload.


      The above is from here -> https://swagger.io/docs/specification/2-0/file-upload/



      Any thoughts?










      share|improve this question















      I'm having a hard time figuring this out.



      We have defined some proto files as our contract for swagger, and I can't quite figure out how to define a multipart/form-data field on the request object.



      We are using proto3 and Swagger 2.0



      The request object is pretty straight forward.



      message ImportRequest 
      bytes file = 1;



      The above isn't the result I'm looking for ... it results in this



      Swagger file import result



      What I need to generate from the proto file above is a swagger output like so..



       paths:
      /upload:
      post:
      summary: Uploads a file.
      consumes:
      - multipart/form-data
      parameters:
      - in: formData
      name: upfile
      type: file
      description: The file to upload.


      The above is from here -> https://swagger.io/docs/specification/2-0/file-upload/



      Any thoughts?







      go swagger protocol-buffers multipartform-data






      share|improve this question















      share|improve this question













      share|improve this question




      share|improve this question








      edited Nov 10 at 10:10









      Flimzy

      36.1k96496




      36.1k96496










      asked Nov 9 at 20:46









      Nicholas

      1,51821927




      1,51821927



























          active

          oldest

          votes











          Your Answer






          StackExchange.ifUsing("editor", function ()
          StackExchange.using("externalEditor", function ()
          StackExchange.using("snippets", function ()
          StackExchange.snippets.init();
          );
          );
          , "code-snippets");

          StackExchange.ready(function()
          var channelOptions =
          tags: "".split(" "),
          id: "1"
          ;
          initTagRenderer("".split(" "), "".split(" "), channelOptions);

          StackExchange.using("externalEditor", function()
          // Have to fire editor after snippets, if snippets enabled
          if (StackExchange.settings.snippets.snippetsEnabled)
          StackExchange.using("snippets", function()
          createEditor();
          );

          else
          createEditor();

          );

          function createEditor()
          StackExchange.prepareEditor(
          heartbeatType: 'answer',
          convertImagesToLinks: true,
          noModals: true,
          showLowRepImageUploadWarning: true,
          reputationToPostImages: 10,
          bindNavPrevention: true,
          postfix: "",
          imageUploader:
          brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
          contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
          allowUrls: true
          ,
          onDemand: true,
          discardSelector: ".discard-answer"
          ,immediatelyShowMarkdownHelp:true
          );



          );













           

          draft saved


          draft discarded


















          StackExchange.ready(
          function ()
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53233038%2fhow-to-define-multipart-form-data-on-proto-upload-in-swagger%23new-answer', 'question_page');

          );

          Post as a guest















          Required, but never shown






























          active

          oldest

          votes













          active

          oldest

          votes









          active

          oldest

          votes






          active

          oldest

          votes















           

          draft saved


          draft discarded















































           


          draft saved


          draft discarded














          StackExchange.ready(
          function ()
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53233038%2fhow-to-define-multipart-form-data-on-proto-upload-in-swagger%23new-answer', 'question_page');

          );

          Post as a guest















          Required, but never shown





















































          Required, but never shown














          Required, but never shown












          Required, but never shown







          Required, but never shown

































          Required, but never shown














          Required, but never shown












          Required, but never shown







          Required, but never shown







          Popular posts from this blog

          Use pre created SQLite database for Android project in kotlin

          Darth Vader #20

          Ondo