AutoBE
    Preparing search index...

    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"
        }
      ]
    }
    interface IParameter {
        description: string;
        name: string & CamelCasePattern;
        schema:
            | AutoBeOpenApi.IJsonSchema.IInteger
            | AutoBeOpenApi.IJsonSchema.INumber
            | AutoBeOpenApi.IJsonSchema.IString;
    }
    Index

    Properties

    description name schema

    Properties

    description: string

    Description about the path parameter.

    This is the standard OpenAPI description field that will be displayed in Swagger UI, SDK documentation, and other API documentation tools. Write a short, concise, and clear description that helps API consumers understand what this parameter represents.

    Implementation details for parameter handling are covered in the parent IOperation.specification field.

    MUST be written in English. Never use other languages.

    name: string & CamelCasePattern

    Identifier name of the path parameter.

    This name must match exactly with the parameter name in the route path. It must be corresponded to the API operation path.

    MUST use camelCase naming convention.

    schema:
        | AutoBeOpenApi.IJsonSchema.IInteger
        | AutoBeOpenApi.IJsonSchema.INumber
        | AutoBeOpenApi.IJsonSchema.IString

    Type schema of the path parameter.

    Path parameters are typically primitive types like strings, integers, numbers.

    If you need other types, please use request body instead with object type encapsulation.

    Settings

    Member Visibility

    On This Page

    Properties