How to define an optional parameter in path using swagger

by

Given that path parameter must be required according to the OpenAPI/Swagger spec, you can consider adding 2 separate endpoints with the following paths:

  • /get/{param1}/{param2} when param2 is provided
  • /get/{param1}/ when param2 is not provided

More Related Contents:

  1. Swagger: How to have a property reference a model in OpenAPI 2.0 (i.e. nest the models)?
  2. How to specify if a field is optional or required in OpenAPI/Swagger?
  3. How to return an array of objects in SwaggerHub?
  4. How to document dynamic query parameter names in OpenAPI (Swagger)?
  5. How to define a mixed-type array (with different element types) in OpenAPI 2.0?
  6. How to define a property that can be string or null in OpenAPI (Swagger)?
  7. Swagger schema properties ignored when using $ref – why?
  8. How to define mutually exclusive query parameters in Swagger (OpenAPI)?
  9. Swagger 2.0: Multiple Path objects with different paths but same request and response
  10. Swagger/OpenAPI – use $ref to pass a reusable defined parameter
  11. How to convert OpenAPI 2.0 to OpenAPI 3.0? [closed]
  12. Swagger: wildcard path parameters
  13. Swagger: “equivalent path already exists” despite different parameters
  14. Re-using model with different required properties
  15. How to write OpenAPI 3 (Swagger) specification for property name in `map` object?
  16. How not to copy-paste 3 generic error responses in almost all paths?
  17. How to define global parameters in OpenAPI?
  18. Schema object without a type attribute in Swagger 2.0
  19. Swagger: take one or more values from enum
  20. How to export swagger.json (or yaml)
  21. How to add multiple example values in swagger properties?
  22. How can I represent ‘Authorization: Bearer ‘ in a Swagger Spec (swagger.json)
  23. Swagger HashMap property type
  24. Post a json body with swagger
  25. Swagger API which is having query string
  26. OpenAPI query string parameter with list of objects
  27. How to add multiple example values for an array in OpenAPI/Swagger?
  28. OpenAPI path/query parameters nested structure serialization
  29. Sending cookie session id with Swagger 3.0
  30. Why `additionalProperties` is the way to represent Dictionary/Map in Swagger/OpenAPI 2.0

Leave a Comment