Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Example response not working #73

Open
lepepe opened this issue Jul 27, 2021 · 13 comments
Open

Example response not working #73

lepepe opened this issue Jul 27, 2021 · 13 comments

Comments

@lepepe
Copy link

lepepe commented Jul 27, 2021

The example response is not show on the right panel:

2021-07-27_14-59

Response language tag:

{
  "ok": true,
  "data": [
    {
      "name": "Insomnia",
      "description": "REST client for humans"
    },
    {
      "name": "Insomnia Documenter",
      "description": "Documentation generator for Insomnia"
    }
  ]
}
@jozsefsallai
Copy link
Collaborator

Hello.

Try response:200 instead of response.

@lepepe
Copy link
Author

lepepe commented Jul 28, 2021

I clone your repo to see if I'm doing something wrong but still not getting the response on the right side panel:
2021-07-28_14-20

@jozsefsallai
Copy link
Collaborator

Just to confirm, does it work here? https://jozsefsallai.github.io/insomnia-documenter/#req_2a5bde603a3240b485d1b4877d53e6f3

Also can you tell me your browser (name + version) and the operating system you're using?

@lepepe
Copy link
Author

lepepe commented Jul 30, 2021

Yes I can see the documenter example without any issue. I'm using Brave 1.18.75 and Arch Linux. I did installed the package instead of using npx and now I get the response example on the right panel. Could be related with npx?

@jozsefsallai
Copy link
Collaborator

jozsefsallai commented Jul 30, 2021

That is... very odd (especially since I'm using the npx method for one of my projects and it works just fine), but I'll look into this!

@johan44co
Copy link

johan44co commented Aug 22, 2021

I have the same issue, I did compare your file insomnia.json in docs folser and apparently <!-- RESPONSE --> is not being replace with (```response) and this is could be the origin of the problem

@amirfaramarzi
Copy link

amirfaramarzi commented Sep 30, 2021

Hi, I have exactly the same problem, what should I do?

My operating system is Arch Linux and I use Chrome browser

Screenshot_20210930_093421
image

@johan44co
Copy link

johan44co commented Sep 30, 2021

@amirfaramarzi in your .json file you manually need to change <!-- RESPONSE --> for ```response

so your description block in the JSON should look something like this
"description": "```response\n{\n \"item\": {\n \"id\": 77,\n \"productName\": \"Original Frankfurter grüne Soße\",\n \"quantityPerUnit\": \"12 boxes\",\n \"unitPrice\": 130000,\n \"unitsInStock\": 32,\n \"unitsOnOrder\": 0,\n \"reorderLevel\": 15,\n \"discontinued\": 0,\n \"category\": {\n \"id\": 9,\n \"categoryName\": \"Demo\",\n \"description\": 0,\n \"picture\": 0\n },\n \"supplier\": {\n \"companyName\": \"Plutzer Lebensmittelgroßmärkte AG\",\n \"contactName\": \"Martin Bein\",\n \"contactTitle\": \"International Marketing Mgr.\",\n \"id\": 12,\n \"address\": {\n \"city\": \"Frankfurt\",\n \"country\": \"Germany\",\n \"phone\": \"(069) 992755\",\n \"postalCode\": 60439,\n \"region\": 0,\n \"street\": \"Bogenallee 51\"\n }\n }\n }\n}\n```"

@amirfaramarzi
Copy link

hi @johan44co

Is there no need to install the plugin ??

@johan44co
Copy link

johan44co commented Sep 30, 2021

amir just the insomnia documenter but for some reason the function that replaces <!-- RESPONSE --> and <!-- ENDRESPONSE --> does not work in some cases, it should work but also there is no error output when it fails, so if you to make it work in your documentation, just after you generate the .json file the next step with be replaced manually for (```response) and (```) respectly without the parenthesis as you see in the example above

@jozsefsallai
Copy link
Collaborator

<!-- RESPONSE --> and <!-- ENDRESPONSE --> is the old format which doesn't work anymore. Please use the new format.

```response:200
{
  "hello": "world"
}
```

@rajendrakumaryadav
Copy link

<!-- RESPONSE --> and <!-- ENDRESPONSE --> is the old format which doesn't work anymore. Please use the new format.

```response:200
{
  "hello": "world"
}

Really helpful, was looking for quite a long time... Search in number of blogs and videos. But none was having the proper information..

Thanks @jozsefsallai 🙏

@EsteveSegura
Copy link

Why this is not on the documentation?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

6 participants