Tipos de mídia personalizados são usados na API para permitir que os consumidores escolham o formato dos dados que desejam receber. Isso é feito adicionando um ou mais dos seguintes tipos ao cabeçalho Aceitar
quando você fizer uma solicitação. Os tipos de mídia são específicos para os recursos, permitindo-lhes alterar, de forma independente, e suportar formatos que outros recursos não suportam.
Todos os tipos de mídia de GitHub Enterprise Cloud se parecem com isto:
application/vnd.github.param[+json]
Os tipos mais básicos de mídia que a API suporta são:
application/vnd.github+json
application/json
Note: In the past, we recommended including v3
in your Accept
header. This is no longer required and will have no impact on your API requests.
If you're specifying a property (such as full/raw/etc defined below), put it after github
:
application/vnd.github.raw+json
Propriedades do texto do comentário
O texto de um comentário pode ser escrito no Linguagem de Markdown enriquecido, problemas, comentários do problema, comentários de pull request e as APIs dos comentários de gist aceitam todos esses mesmos tipos de mídia:
Sem processar
application/vnd.github.raw+json
Retorna o texto do markdown sem processar. A resposta incluirá o texto
. Este é o padrão se você não passar nenhum tipo de mídia específico.
Texto
application/vnd.github.text+json
Retorna uma representação única do texto do markdown. A resposta irá incluir body_text
.
HTML
application/vnd.github.html+json
Retorna um HTML interpretado a partir do markdown do texto. A resposta incluirá body_html
.
Completo
application/vnd.github.full+json
Retorna as representações de HTML e texto sem processar. A resposta incluirá texto
, body_text
e body_html
:
Propriedades do Git blob
Os seguintes tipos de mídia são permitidos ao receber um blob:
JSON
application/vnd.github+json
application/json
Retorna a representação do JSON do blob com conteúdo
como uma string codificada de base64. Este é o padrão, caso nada seja passado.
Sem processar
application/vnd.github.raw
Retorna os dados do blob sem processamento.
Commits, comparação de commit e pull requests
A API de commits e API de pull requests são compatíveis com os formatos diff e patch:
diff
application/vnd.github.diff
patch
application/vnd.github.patch
sha
application/vnd.github.sha
Conteúdo do repositório
Sem processar
application/vnd.github.raw
Retorna o conteúdo sem processamento de um arquivo. Este é o padrão se você não passar nenhum tipo de mídia específico.
HTML
application/vnd.github.html
Para arquivos de markup, como Markdown ou AsciiDoc, você pode recuperar o HTML interpretado usando o tipo de mídia .html
. As linguagens de markup são processadas em HTML usando nossa biblioteca de markup de código aberto.
Gists
Sem processar
application/vnd.github.raw
Retorna o conteúdo sem processar de um gist. Este é o padrão se você não passar nenhum tipo de mídia específico.
base64
application/vnd.github.base64
O conteúdo do gist é codificado em base64 antes de ser enviado. Isso pode ser útil se o seu gist contiver qualquer sequência de UTF-8 inválida.