--- title: Campos description: Documente parâmetros de API e campos de resposta com os componentes ParamField e ResponseField, incluindo tipos, valores padrão e objetos aninhados. --- > **For AI agents:** the complete documentation index is at [llms.txt](/docs/llms.txt). Append `.md` to any page URL for its markdown version. Os campos ajudam a documentar parâmetros de API e campos de resposta em um formato claro e consistente. ## Uso ```mdx Maximum number of results to return. ``` ## ParamField Use `ParamField` para documentar parâmetros de solicitação da API. Especifique a localização do parâmetro usando um destes valores: `body`, `query`, `path` ou `header`. O identificador exclusivo do usuário. Número máximo de resultados a retornar. Token Bearer para autenticação. ```mdx The unique identifier for the user. Maximum number of results to return. Bearer token for authentication. ``` ### Parâmetros de caminho Identificador do recurso no caminho da URL. ```mdx Resource identifier in the URL path. ``` ### Propriedades de ParamField Nome do parâmetro para parâmetros do corpo. Nome do parâmetro para parâmetros da string de consulta. Nome do parâmetro para parâmetros do caminho da URL. Nome do parâmetro para parâmetros do cabeçalho. Tipo de dados (string, number, boolean, array, object). Exibe um selo "required". Valor padrão quando não fornecido. ## ResponseField Use `ResponseField` para documentar propriedades da resposta da API. Identificador exclusivo do recurso. Carimbo de data e hora ISO 8601 de quando o recurso foi criado. Status atual da solicitação. ```mdx Unique identifier for the resource. ISO 8601 timestamp of when the resource was created. Current status of the request. ``` ### Campos obsoletos Marque os campos como obsoletos para indicar que serão removidos em uma versão futura: Use `id` em vez disso. Este campo será removido na v2. ```mdx Use `id` instead. This field will be removed in v2. ``` ### Rótulos Adicione contexto com os rótulos `pre` e `post`: URL para receber notificações de Webhook. ```mdx URL to receive webhook notifications. ``` ### Objetos aninhados Combine com `Expandable` para documentar propriedades de objetos aninhados: O usuário que criou o recurso. Identificador exclusivo do usuário. Endereço de e-mail do usuário. Nome de exibição do usuário. ```mdx The user who created the resource. User's unique identifier. User's email address. User's display name. ``` ### Propriedades de ResponseField Nome do campo. Tipo de dados. Exibe um selo "required". Exibe o campo como obsoleto com texto tachado. Valor padrão. Rótulos exibidos antes do nome do campo. Rótulos exibidos depois do nome do campo. ## O que vem a seguir? Browse all available components Learn how to use components in MDX ```