Ajuda da API do MediaWiki
Esta é uma página de documentação da API do MediaWiki gerada automaticamente.
Documentação e exemplos: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
prop=description (desc)
- Este módulo é interno ou instável, e não deve ser usado. O funcionamento do mesmo pode ser alterado sem aviso prévio.
- Este módulo requer direitos de leitura.
- Fonte: WikibaseClient
- Licença: GPL-2.0-or-later
Obter uma descrição breve, isto é, um subtítulo que explica o objetivo da página de destino.
A descrição é texto simples, numa única linha, mas em tudo o resto arbitrária (possivelmente incluindo elementos de HTML puro, que também devem ser interpretados como texto simples). Não pode ser usada no interior de HTML sem escapes!
Parâmetros específicos:
Estão disponíveis outros parâmetros gerais.
- desccontinue
Quando houver mais resultados disponíveis, usar isto para continuar. Podem ser encontradas na wiki mediawiki.org mais informações sobre a aplicação da continuação a consultas.
- Tipo: inteiro
- Valor por omissão: 0
- descprefersource
Qual das fontes de descrições será a preferida, se existir:
- local
- Descrições locais, através da função
{{SHORTDESC:...}}
do analisador sintático no texto wiki da página. - central
- Descrições centralizadas, do elemento Wikibase associado.
- Um dos seguintes valores: central, local
- Valor por omissão: local
Exemplos:
- Obter a descrição para a página 'London'.
- api.php?action=query&prop=description&titles=London [abrir na página de testes]
- Obter a descrição para a página 'London', dando preferência à descrição centralizada se esta existir.
- api.php?action=query&prop=description&titles=London&descprefersource=central [abrir na página de testes]