API Connect

API Connect

Join this online group to communicate across IBM product users and experts by sharing advice and best practices with peers and staying up to date regarding product enhancements.

 View Only
Back to discussions
Expand all | Collapse all

Checking for Required Headers and Query Parameters

  • 1.  Checking for Required Headers and Query Parameters

    Posted Tue October 18, 2022 10:46 AM
    Using IBM API Connect v 10.0.1.x

    In the API Connect Designer there are options for specifying if request headers and query parameters are required for the path/operation. 
    API Connect Designer - Required Header
    The out of the box validate policy does not validate the required-ness of these items even though they are declared. 

    Question: Is there a product feature that I am overlooking that will validate the declared required header and query param fields? 

    Does each IBM API Connect customer implement some common code to make this happen?  What would be nice is an API Connect context variable that would hold the required field names for header/query/path to allow for some generic code to be written to validate these items if it needs to be customer implemented.


    ------------------------------
    Steve Ruscik
    ------------------------------


  • 2.  RE: Checking for Required Headers and Query Parameters

    Posted Tue October 25, 2022 09:08 AM
    I will answer my own question.  I see that there is a Schema View button on the parameters form when I am at the path level:

    Schema View Button
    Clicking on that brings you to this menu:

    Schema Form

    Which appears to do what I want.

    Comment:  Our company is trying to use this tool in a decentralized fashion where application teams can create the APIs they need to expose.  When we try to use the online documentation for assistance it seems to be lacking.  For example, the ability to use the Schema Editor is not covered at all in the online documentation after traversing several menus deep:


    Question:  Is there a 3rd party document on using the API Designer and all of its features that I can buy or reference online?

    ------------------------------
    Steve Ruscik
    ------------------------------

    Original Message


Related Content