Interface IParameter

Path parameter information for API routes.

This interface defines a path parameter that appears in the URL of an API endpoint. Path parameters are enclosed in curly braces in the operation path and must be defined with their types and descriptions.

For example, if API operation path is /shoppings/customers/sales/{saleId}/questions/${questionId}/comments/${commentId}, the path parameters should be like below:

{
  "path": "/shoppings/customers/sales/{saleId}/questions/${questionId}/comments/${commentId}",
  "method": "get",
  "parameters": [
    {
      "name": "saleId",
      "in": "path",
      "schema": { "type": "string", "format": "uuid" },
      "description": "Target sale's ID"
    },
    {
      "name": "questionId",
      "in": "path",
      "schema": { "type": "string", "format": "uuid" },
      "description": "Target question's ID"
    },
    {
      "name": "commentId",
      "in": "path",
      "schema": { "type": "string", "format": "uuid" },
      "description": "Target comment's ID"
    }
  ]
}
Copy