This repo can be added as a design document in Insomnia by using the Git Sync feature and cloning this repo. These design documents, however, are OpenAPI specs which Insomnia does not have a visual editor for.
A better option for editing would be to import/export collections. You can import the hightouch-collection.json file in this repo using Insomnia's file import feature.
This collection requires a password variable in the environment. To configure this variable:
- Click on the environment name, then Manage Environments
- Click the + button to create a new Private Environment; this ensures the passwords are not saved to the JSON file when exporting.
- Name the environment and add the token variable. The actual value from this token is stored in 1Password in the Secrets field for the "Fivetran Hightouch Connector Settings" login.
- Once the token variable is set, click Close.
- Switch to the environment you just created.
- You'll now be able to make requests and use the variable(s) from the environment in any new requests (by using the
{{variableName}}convention)
To save the requests to GitHub, this would require exporting the request collection as JSON after making the necessary changes.
Bad news: This does not allow for real-time collaboration. If you re-import the file after making changes in Insomnia, your changes would be overwritten.
Good (i.e. neutral) news: The file contains a unique ID which Insomnia uses to know if the collection had already imported. If you already had a previous version of the collection, your private environment variables would not be overwritten; you can simply import the latest version of the collection and use it (unless it requires new variables).