Api-blueprint: parâmetros com sublinhado que têm valores de amostra com sublinhado não funcionam

Criado em 12 fev. 2016 · 7Comentários · Fonte: apiaryio/api-blueprint

## Underscores [/somepath/{?template_type}]

### Get Underscores [GET]

Parameters
  + template_type: advocacy_post (string, required) the template type 
...

Não funciona. Sempre interpreta os sublinhados de ponta a ponta como algo estranho e causa erros de sintaxe. As tentativas de escapar deles com% 5f não funcionam porque o parâmetro não passa corretamente no console ao fazer a solicitação. A única coisa que descobri que funciona é tirar o segundo sublinhado e fazer com que o parâmetro seja este:
+ template_type: advocacy post (string, required) the template type
Eu posso sobreviver com isso, mas não é muito bom porque o exemplo deveria ter um sublinhado nele. Todos os valores válidos para esse parâmetro têm um sublinhado, então só posso fazer funcionar colocando um valor de amostra que nunca funcionaria.

Language Awaiting Validation Question

Fonte

bennettellis

👍2

Comentários muito úteis

Chaves de parâmetro e valores que contêm um caractere reservado ( _ ) devem ser escapados (envolvidos em crases).

+ Parameters
    + `template_type`: `advocacy_post` (string, required) the template type

Nota : _Há um problema conhecido [ desenhista # 123 ] com o uso de crases em parâmetros._

kylef em 12 fev. 2016

👍6 👎1

Todos 7 comentários

Chaves de parâmetro e valores que contêm um caractere reservado ( _ ) devem ser escapados (envolvidos em crases).

+ Parameters
    + `template_type`: `advocacy_post` (string, required) the template type

Nota : _Há um problema conhecido [ desenhista # 123 ] com o uso de crases em parâmetros._

kylef em 12 fev. 2016

👍6 👎1

backticks não resolvem o problema.

bennettellis em 12 fev. 2016

👍1

@kylef, pelo que vale a pena, se trata de parâmetros e não de atributos (os parâmetros estão, por enquanto, usando um mecanismo de análise diferente)

zdne em 15 fev. 2016

O comentário de @kylef deve estar funcionando agora no analisador de rascunho. Ele pode não ser implantado no Apiary se você não for convidado para a renderização MSON beta. Portanto, siga o # 191 para saber quando isso será implantado no Apiário para todos. Estou fechando isso. Obrigado.

pksunkara em 6 abr. 2016

Oi.

Este problema foi resolvido? Eu tenho um problema semelhante em que nosso id de sessão tem sublinhado e estou recebendo um aviso do Analisador de que

specifying parameter 'appointment_hub_session_id (string, required, `ejMPAfFLPd2W_NCieglc4Y4hfBlPE4xI-IpwYNJOKMdBbXqiZGAJXfVL0icgmROgIs5V7GWBe5SSuusb1MFEQw' as required supersedes its default value, declare the parameter as 'optional' to specify its default value on line 51

Projeto da API:

+ Parameters

    + appointment_hub_session_id (string, required, `ejMPAfFLPd2W_NCieglc4Y4hfBlPE4xI-IpwYNJOKMdBbXqiZGAJXfVL0icgmROgIs5V7GWBe5SSuusb1MFEQw==`) - Id of appointment hub session.

Se eu alterar " _ " para " - ", tudo funcionará bem e não recebo nenhum aviso.

Atenciosamente.

daniyel em 25 abr. 2018

Sim, creio que foi. No momento em que entrei neste problema, os crases não funcionavam para os parâmetros. Não tenho certeza de quando foi consertado, mas sei que funcionam. Você precisa fazer algo como o escape de crase referenciado acima, então para mim foi:

+ Parameters: 

    + `template_type`: `advocacy_post` (enum[string], required) - the template type

Porém, sua sintaxe está errada, então não se trata apenas dos crases, é também a maneira como você especificou o parâmetro. Você realmente quer algo assim (eu adicionei isso ao meu próprio documento apiário temporariamente para testar, e ele foi validado e funciona bem).

+ Parameters

    + `appointment_hub_session_id`: `ejMPAfFLPd2W_NCieglc4Y4hfBlPE4xI-IpwYNJOKMdBbXqiZGAJXfVL0icgmROgIs5V7GWBe5SSuusb1MFEQw==` (string, required) - Id of appointment hub session

Espero que ajude.

Ah, você também NÃO deve escapar dos crases em seu modelo de URI.

bennettellis em 25 abr. 2018

👍1

@bennettellis Obrigado pela pronta resposta. Sua solução funcionou.

daniyel em 25 abr. 2018

Esta página foi útil?

0 / 5 - 0 avaliações