Is it possible to use whole raw string as parameter in swagger









up vote
1
down vote

favorite












there is a url like
http://someservice.com/confirm?token



Is this any way how to describe this endpoint in terms of swagger notation



if use as query parameter then you get



 /confirm:
get:
summary: ...
parameters:
- in: query
name: token
...


http://someservice.com/confirm?token=value that is not OK



from other side it is not possible to use url notation in follow way:



 /confirm?token:
get:
summary: ...
parameters:
- in: path
name: token
...


due to query strings in paths are not allowed.










share|improve this question

























    up vote
    1
    down vote

    favorite












    there is a url like
    http://someservice.com/confirm?token



    Is this any way how to describe this endpoint in terms of swagger notation



    if use as query parameter then you get



     /confirm:
    get:
    summary: ...
    parameters:
    - in: query
    name: token
    ...


    http://someservice.com/confirm?token=value that is not OK



    from other side it is not possible to use url notation in follow way:



     /confirm?token:
    get:
    summary: ...
    parameters:
    - in: path
    name: token
    ...


    due to query strings in paths are not allowed.










    share|improve this question























      up vote
      1
      down vote

      favorite









      up vote
      1
      down vote

      favorite











      there is a url like
      http://someservice.com/confirm?token



      Is this any way how to describe this endpoint in terms of swagger notation



      if use as query parameter then you get



       /confirm:
      get:
      summary: ...
      parameters:
      - in: query
      name: token
      ...


      http://someservice.com/confirm?token=value that is not OK



      from other side it is not possible to use url notation in follow way:



       /confirm?token:
      get:
      summary: ...
      parameters:
      - in: path
      name: token
      ...


      due to query strings in paths are not allowed.










      share|improve this question













      there is a url like
      http://someservice.com/confirm?token



      Is this any way how to describe this endpoint in terms of swagger notation



      if use as query parameter then you get



       /confirm:
      get:
      summary: ...
      parameters:
      - in: query
      name: token
      ...


      http://someservice.com/confirm?token=value that is not OK



      from other side it is not possible to use url notation in follow way:



       /confirm?token:
      get:
      summary: ...
      parameters:
      - in: path
      name: token
      ...


      due to query strings in paths are not allowed.







      swagger swagger-ui swagger-2.0






      share|improve this question













      share|improve this question











      share|improve this question




      share|improve this question










      asked Nov 9 at 21:28









      Rinat

      349212




      349212






















          1 Answer
          1






          active

          oldest

          votes

















          up vote
          0
          down vote













          This is currently not supported, neither in OpenAPI 2.0 nor in OpenAPI 3.0. Here's the corresponding feature request:



          Support for arbitrary query strings






          share|improve this answer




















            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%2f53233481%2fis-it-possible-to-use-whole-raw-string-as-parameter-in-swagger%23new-answer', 'question_page');

            );

            Post as a guest















            Required, but never shown

























            1 Answer
            1






            active

            oldest

            votes








            1 Answer
            1






            active

            oldest

            votes









            active

            oldest

            votes






            active

            oldest

            votes








            up vote
            0
            down vote













            This is currently not supported, neither in OpenAPI 2.0 nor in OpenAPI 3.0. Here's the corresponding feature request:



            Support for arbitrary query strings






            share|improve this answer
























              up vote
              0
              down vote













              This is currently not supported, neither in OpenAPI 2.0 nor in OpenAPI 3.0. Here's the corresponding feature request:



              Support for arbitrary query strings






              share|improve this answer






















                up vote
                0
                down vote










                up vote
                0
                down vote









                This is currently not supported, neither in OpenAPI 2.0 nor in OpenAPI 3.0. Here's the corresponding feature request:



                Support for arbitrary query strings






                share|improve this answer












                This is currently not supported, neither in OpenAPI 2.0 nor in OpenAPI 3.0. Here's the corresponding feature request:



                Support for arbitrary query strings







                share|improve this answer












                share|improve this answer



                share|improve this answer










                answered Nov 9 at 21:34









                Helen

                31.7k471126




                31.7k471126



























                     

                    draft saved


                    draft discarded















































                     


                    draft saved


                    draft discarded














                    StackExchange.ready(
                    function ()
                    StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53233481%2fis-it-possible-to-use-whole-raw-string-as-parameter-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