RAML resource accept multiple enums










0















I have a details trait with defined enums



details:
queryParams:
detail:
type: string
enum: [small, big, categories, box]


When I query endpoint, which uses this trait, example.com/api?detail=small,big, I get API validation error.



How to define enum so that I could query for example.com/api?detail=small and example.com/api?detail=small,big and example.com/api?detail=small,big,small and so on.










share|improve this question




























    0















    I have a details trait with defined enums



    details:
    queryParams:
    detail:
    type: string
    enum: [small, big, categories, box]


    When I query endpoint, which uses this trait, example.com/api?detail=small,big, I get API validation error.



    How to define enum so that I could query for example.com/api?detail=small and example.com/api?detail=small,big and example.com/api?detail=small,big,small and so on.










    share|improve this question


























      0












      0








      0








      I have a details trait with defined enums



      details:
      queryParams:
      detail:
      type: string
      enum: [small, big, categories, box]


      When I query endpoint, which uses this trait, example.com/api?detail=small,big, I get API validation error.



      How to define enum so that I could query for example.com/api?detail=small and example.com/api?detail=small,big and example.com/api?detail=small,big,small and so on.










      share|improve this question
















      I have a details trait with defined enums



      details:
      queryParams:
      detail:
      type: string
      enum: [small, big, categories, box]


      When I query endpoint, which uses this trait, example.com/api?detail=small,big, I get API validation error.



      How to define enum so that I could query for example.com/api?detail=small and example.com/api?detail=small,big and example.com/api?detail=small,big,small and so on.







      rest api-design raml






      share|improve this question















      share|improve this question













      share|improve this question




      share|improve this question








      edited Dec 11 '18 at 6:36









      Cœur

      17.5k9104145




      17.5k9104145










      asked Nov 12 '18 at 10:36









      TomeisterTomeister

      5713




      5713






















          1 Answer
          1






          active

          oldest

          votes


















          0














          For that use-case you can use a trait passing in a list of fields of allowed values like so:



          #%RAML 1.0
          ---
          title: test
          baseUri: https://mocksvc.qax.mulesoft.com/mocks/73ff2db5-abbf-4cad-aab1-80f6da9d6055
          version: v2
          protocols: [ HTTP ]
          mediaType: application/json

          traits:
          sparsable:
          queryParameters:
          detail?:
          type: string
          pattern: (<<fieldset>>),?

          /api:
          displayName: api
          get:
          is: [ sparsable: fieldset: small ]


          kudos: https://medium.com/raml-api/arrays-in-query-params-33189628fa68






          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',
            autoActivateHeartbeat: false,
            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%2f53260347%2framl-resource-accept-multiple-enums%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









            0














            For that use-case you can use a trait passing in a list of fields of allowed values like so:



            #%RAML 1.0
            ---
            title: test
            baseUri: https://mocksvc.qax.mulesoft.com/mocks/73ff2db5-abbf-4cad-aab1-80f6da9d6055
            version: v2
            protocols: [ HTTP ]
            mediaType: application/json

            traits:
            sparsable:
            queryParameters:
            detail?:
            type: string
            pattern: (<<fieldset>>),?

            /api:
            displayName: api
            get:
            is: [ sparsable: fieldset: small ]


            kudos: https://medium.com/raml-api/arrays-in-query-params-33189628fa68






            share|improve this answer



























              0














              For that use-case you can use a trait passing in a list of fields of allowed values like so:



              #%RAML 1.0
              ---
              title: test
              baseUri: https://mocksvc.qax.mulesoft.com/mocks/73ff2db5-abbf-4cad-aab1-80f6da9d6055
              version: v2
              protocols: [ HTTP ]
              mediaType: application/json

              traits:
              sparsable:
              queryParameters:
              detail?:
              type: string
              pattern: (<<fieldset>>),?

              /api:
              displayName: api
              get:
              is: [ sparsable: fieldset: small ]


              kudos: https://medium.com/raml-api/arrays-in-query-params-33189628fa68






              share|improve this answer

























                0












                0








                0







                For that use-case you can use a trait passing in a list of fields of allowed values like so:



                #%RAML 1.0
                ---
                title: test
                baseUri: https://mocksvc.qax.mulesoft.com/mocks/73ff2db5-abbf-4cad-aab1-80f6da9d6055
                version: v2
                protocols: [ HTTP ]
                mediaType: application/json

                traits:
                sparsable:
                queryParameters:
                detail?:
                type: string
                pattern: (<<fieldset>>),?

                /api:
                displayName: api
                get:
                is: [ sparsable: fieldset: small ]


                kudos: https://medium.com/raml-api/arrays-in-query-params-33189628fa68






                share|improve this answer













                For that use-case you can use a trait passing in a list of fields of allowed values like so:



                #%RAML 1.0
                ---
                title: test
                baseUri: https://mocksvc.qax.mulesoft.com/mocks/73ff2db5-abbf-4cad-aab1-80f6da9d6055
                version: v2
                protocols: [ HTTP ]
                mediaType: application/json

                traits:
                sparsable:
                queryParameters:
                detail?:
                type: string
                pattern: (<<fieldset>>),?

                /api:
                displayName: api
                get:
                is: [ sparsable: fieldset: small ]


                kudos: https://medium.com/raml-api/arrays-in-query-params-33189628fa68







                share|improve this answer












                share|improve this answer



                share|improve this answer










                answered Nov 14 '18 at 17:09









                Ryan CarterRyan Carter

                8,53621420




                8,53621420



























                    draft saved

                    draft discarded
















































                    Thanks for contributing an answer to Stack Overflow!


                    • Please be sure to answer the question. Provide details and share your research!

                    But avoid


                    • Asking for help, clarification, or responding to other answers.

                    • Making statements based on opinion; back them up with references or personal experience.

                    To learn more, see our tips on writing great answers.




                    draft saved


                    draft discarded














                    StackExchange.ready(
                    function ()
                    StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53260347%2framl-resource-accept-multiple-enums%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

                    Kleinkühnau

                    Makov (Slowakei)

                    Deutsches Schauspielhaus