hoppscotch/docs

📖 Hoppscotch documentation - https://docs.hoppscotch.io

Hoppscotch Documentation

Local Development

Install dependencies:

npm i -g mintlify

Start development server with:

mintlify dev

docs's Issues

Incorrect casing of GitHub

In a few places in the docs for Hoppscotch, GitHub is referred to as Github, which is not the correct way to spell/type GitHub.

I am working on a PR to correct this issue.

On Authorization.md getting 404 error

On Authorization.md when we click on the image getting 404 error.

Sharing environments

How can I share an enviroment with a team/other users?

Throws 404 code when visiting any route directly

Description

When browsing the docs website a 404 error is returned if the entry point is anything apart from https://docs.hoppscotch.io/.

Scenario A:

1. Visit https://docs.hoppscotch.io/, browser loads the page.
2. Get code 200.
3. Click GraphQL (or anything else), Nuxt changes the route and renders the page.
4. Code is still 200.

Scenario B:

1. Visit https://docs.hoppscotch.io/graphql (or any other direct route), browser loads the page.
2. Get code 404.
3. Click Introduction (or anything else), Nuxt changes the route and renders the page.
4. Code is still 404.

Impact

⚠️ This will be hurting docs SEO quite badly, making it more difficult for people to find info on the project.

Cause

Here are some relevant results.

Issue on docs - Unable to find documentation for HOW TO TEST GRAPHQL Responses

Path: /documentation/getting-started/graphql/creating-a-query

Would like to know, how we can test GrapQL responses, similar to Rest endpoints

Thanks!

typo: misspelled content

the word nuxt-content is misspelled in the contributiors guide section in readme file

Image not shown in dark mode

Image not shown in dark mode but shown in light mode

Link for docs page

Problem

improper image file name

Screenshot

Solution

Rename image file name for dark mode

To make Environment dropdown always visible

Currently, to switch environments, the user needs to navigate from the Collections section to the Environments section, select the desired environment and return to Collections.
If the user works with 2-3 API requests and several environments that's quite a lot of extra clicks

Also in the Collection view user does not see current environment and needs to switch to the Environments section to check it

I think it would be more convenient if the environment selector was always visible - it does not take up much space and is logically part of the workspace.

Trouble Scrolling Through Value Input in Variable List

In the environments tab, adding a value with a long char length (e.x. Bearer Token ~700 chars) to a variable in the variable list can be hard to scroll through using the touchpad on a mac.

Would it be possible to increase the width of the value input and or wrap the value?

Broken Image link on body.md

We have broken link on body.md.

Issue on docs - Broken link

The link in "Select the Grant Type from Authorization Code (with or without PKCE), Client Credentials, Password Credentials, and Implicit" redirects to /documentation/getting-started/introduction.

It looks like the link should refer to #grant-types, locally editing this through the inspector doesn't fix the issue.

Docs need clarity on how to store payload values as Environment Variables

Is there an existing issue for this?

• I have searched the existing issues

Current behavior

As called out in a few issues, it is a common pattern to take values from a response payload and use these in subsequent API calls. The most common example is fetching a JWT and using that in an Authorization header for all subsequent calls.

Things are just different enough in Hoppscotch to make examples from Postman not compatible. Unless I'm missing something obvious, I was unable to get console output from the Tests tab to tell me where things were going wrong, but I did manage to figure it out eventually.

Some small doc additions can help others not run into the same friction.

Steps to reproduce

1. Review docs
2. Fail
3. Open Issue asking for help 😄

Environment

Production

Version

Local

Import api from swagger

How to Import api from swagger?

French translation

Hello !

I have started the translation of the document in French so if someone also wishes to participate thank you to let me know so that I add you as a collaborator in my fort
here is the link: https://github.com/Donfreddy/docs

Issue on docs multipart form im,age not upload

Path: /documentation/getting-started/rest/uploading-data

Page not found error.

Under https://github.com/hoppscotch/docs/blob/main/README.md when we click on @nuxt/content theme docs. getting below error.

I would love to fix this issue, if someone will help me with the correct url.

A way to run shell commands in pre-request script

I am building services in cloud-run that require tokens to invoke. The recommended way to fetch a token is via a cli command. https://cloud.google.com/sdk/gcloud/reference/auth/application-default/print-access-token

gcloud auth application-default print-access-token

curl -H "X-Goog-User-Project: your-project" -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" foo.googleapis.com

How would I accomplish this in hoppscotch? It doesn't appear I can kick off a sub-process in the pre-request script.

Getting Semantic unknown property env variables

@liyasthomas

Teams is not working

I'm experiencing following issue related to Teams

• Dialog box that popups when tapping Invite button shows an infinite loader.
• Plus Button (+ New) button under team collection is disabled.
• Add new Button on the same page shows tool tip with message:
  You do not have edit access to these collections.

Can't see the environment variables when in light mode

Translate documentation to spanish

Issue on docs

Path: /documentation/develop
Can we get instructions for running the desktop version locally?
My (fortune 100) company is looking at contributing features / fixing bugs in the desktop client and it would help us to have clear instructions for running locally

Spelling Mistake in docs.

• First sentence in the https://docs.hoppscotch.io/features/authorization - "REST_ APIs use authorizatiom to ensure that a client has secure access only to the resources permitted by their roles. "
• authorizatiom is in wrong spelling.

translations.md page having broken link

Translations page is having broken link.

Banner not shown in the readme file.

image of banner not shown up due to minor typo in the file name

Weird light mode dark mode monitor icon

I assume that this means to use preferred system but that is weird because usually you just have light and dark and it only defaults to system default. If you want to switch through it you are not interested in the system default.

Is there a default PostgreSQL DB included in the container?

In this line from 2.install-and-build.md

DATABASE_URL: This is where you add your Postgres database URL, you can also use our default database shipped within the docker container postgresql://postgres:testpass@hoppscotch-db:5432/hoppscotch

It mentions the existence of a default PostgreSQL database within the container. Is this correct, or was it actually meant to be within the Docker Compose?

There is some confusion regarding this matter, as discussed in hoppscotch/hoppscotch#3414 (comment)

collections.md image broken link

Missing Link on /docs/content/en/features/response.md

Last line on the page /docs/content/en/features/response.md says The response from the API endpoint can be viewed here

• 🔗 Either we need to add a link to here and associate sample data to that
• ❌ Or remove the reference here

Issue on docs

Path: /documentation/features/importer

Who has access to the firebase cloud storage when using hoppscotch.io cloud storage?

Hi there,

can you clarify how cloud storage works?

Hoppscotch uses Cloud Storage for Firebase, right?

I searched the documentation and read 1923 and 1817. As well as Cloud Storage for Firebase and Google Cloud Storage

Cloud Storage offers secure-by-design features to protect your data and advanced controls and capabilities to keep your data private and secure against leaks or compromises. Security features include access control policies, data encryption, retention policies, retention policy locks, and signed URLs.

That sound great.

But who has access to that storage and my data?

Is it only me and my team that I created with hoppscotch.io? Or is hoppscotch as the service provider also theoretically able to decrypt and read my data?

Thanks a lot, Best Leif

Missing documentation - contributors wanted

When we started using Hoppscotch today, we were not able to find documentation on how to use the environment variables correctly. In the end, we found hoppscotch/hoppscotch#1029 (comment) which solved the issue for us, but we lost certainly about 1 hour until we found that comment.

Describe the solution you'd like
It would be nice to have some kind of documentation on how to use the environment variable next to the place where you can configure them (Environments, probably where you can enter the values?).

Additional context
It might not be intuitive that it is not possible to use environment variables in Parameters but in the URL.

Synchronize history message keeps popping up

Every time I log in to hoppscotch and use the REST tool, the sync history message keeps popping up. In the video I show the case.

msedge_aX9DE9Apd6.mp4

Editing environment no longer possible

This button does nothing:

(was working a few days ago)

Lost "Test" and "Pre-request script" after import collection from Postman to Hopposcotch

Path: /support/solutions/community
Dear Team,
Could you please help to check that the information "Test" and "Pre-request script" are lost after import collection from Postman to Hopposcotch even exporting from Postman using "Collection v2" or "Collection v2.1"?

Exported files from Postman:
PHUC_TEST_NE_v2.1.postman_collection.json
PHUC_TEST_NE_v2.postman_collection.json

After importing to Hopposcotch:

Thanks!

The CLI client page returns 404

Set environment variable

How can I set the environment variable in the tests script?
I was used to setting variables in postman like this:

var jsonData = JSON.parse(responseBody);
postman.setEnvironmentVariable("TOKEN", jsonData.AuthenticationResult.IdToken);

Can I do something similar in hopscotch?

[help] Where to generate API docuementaition?

I don't see docs tab. How can I generate API doc?

"Runner" documentation

There exists a docs page about "runner", but there is no runner in the app

JSON formatting for non-json content type

Sometimes response comes in JSON format but with different content type (application/octet-stream for example)
In this case tab "JSON" is disabled and user cannot beautify the output
It would be useful to be able to format the response regardless of the value of the response content-type header.

Missing Image asset in /features/body Route

The image in the route https://docs.hoppscotch.io/features/body is missing. While on closer inspection, it was confirmed that the image specified in the path is in the asset directory, which is
https://github.com/hoppscotch/docs/blob/main/static/Features/body-dark.png.

Documentation for desktop is not generated properly

Hello, I noticed this issue while browsing doc site so wanted to report here.

doc: https://docs.hoppscotch.io/documentation/clients/desktop#download-hoppscotch-desktop-app
source: https://github.com/hoppscotch/docs/blob/main/content/1.documentation/2.clients/1.desktop.md

While in mark down it mentions instruction for installation, for some reason it's not generated

How can I send a binary message by websocket

Need to Change Twitter old logo with New x Logo in docs header and footer

unclear what "javaScript" to use

Path: /documentation/features/scripts

Current text: "Hoppscotch provides JavaScript APIs that can be used in writing pre-request scripts and building tests. You can enter your JavaScript code and run the necessary scripts."

Problem: there are a bazillion JavaScript languages. This needs to be clarified. For example use the standardized version called ECMA-Script.