How to handle non-required parameters in Swagger to avoid missing positional argument error?

Question

I have a Swagger file for my endpoints, one of my endpoints has several parameters. How do you handle non-required parameters? I'm having a challenge on how to handle it on my Python file if the non-required parameters have empty value.

Here is my Swagger definition:

/surveyData:
    get:
      operationId: "surveyData.read_surveydata"
      summary: Gets the survey data for the client insights tracker.
      parameters:
        - in: query
          name: startDate
          type: string
          required: true
          description: The start date of the survey data.
        - in: query
          name: endDate
          type: string
          required: true
          description: The end date of the survey data.
        - in: query
          name: country
          type: string
          description: The countries from which you would like to filter the survey data.
        - in: query
          name: market
          type: string

and here is my function which is written in Python (using Connexion):

def read_surveydata(startDate, endDate, country, market):

I believe not, this question is regarding the framework Connexion — Kevin Martins, Apr 23 '19 at 14:29

score 1 · Accepted Answer · answered Apr 23 '19 at 12:41

1

You can add the "Default" tag for example:

      parameters:
        - name: filtros
          in: "query"
          required: false
          description: Filter to query
          type: "string"
          default: "bndu"

Or add a default argument

def read_surveydata(startDate, endDate, country, market='store'):

answered Apr 23 '19 at 12:41

Kevin Martins

590
7
20

Hi @Kevin Martins, thank you! this give me some insights, but how's your approach in the query, by the way, do you use ORM or an SQL query? – GeekyDad Apr 23 '19 at 12:54
Hi @PaulCaballero I am using the sqlalchemy ORM https://www.sqlalchemy.org/ – Kevin Martins Apr 23 '19 at 14:27
Hi @Kevin Martins, yes, I'm using Stored Procedure though. Thank you! – GeekyDad Apr 24 '19 at 15:08
@PaulCaballero Good ! If you need anything, just talk :) – Kevin Martins Apr 24 '19 at 16:55

How to handle non-required parameters in Swagger to avoid missing positional argument error?

1 Answers1