RapidAPI · Schema

EndpointParameter

API MarketplaceAPI ManagementAPI TestingAPI GatewayAPI DesignEnterprise

Properties

Name Type Description
name string Parameter name
type string Data type of the parameter
required boolean Whether the parameter is required
description string Description of the parameter
defaultValue string Default value for the parameter if not provided
location string Where the parameter is sent in the request
View JSON Schema on GitHub

JSON Schema

rapidapi-endpointparameter-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/EndpointParameter",
  "title": "EndpointParameter",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Parameter name"
    },
    "type": {
      "type": "string",
      "description": "Data type of the parameter"
    },
    "required": {
      "type": "boolean",
      "description": "Whether the parameter is required"
    },
    "description": {
      "type": "string",
      "description": "Description of the parameter"
    },
    "defaultValue": {
      "type": "string",
      "description": "Default value for the parameter if not provided"
    },
    "location": {
      "type": "string",
      "enum": [
        "query",
        "path",
        "header",
        "body"
      ],
      "description": "Where the parameter is sent in the request"
    }
  }
}