Unetus Docs
  • Documentation
  • Download
    • Introduction
    • Install
    • Send Your First Request
    • Import and Export Data
    • Environment Variables
    • Workspaces
    • Requests
    • Responses
    • Request Collections
    • Request Timeouts
    • Chaining Requests
    • Post CSV Data
    • SOAP Requests
    • gRPC
    • WebSocket Support
    • Get Started with Documents
    • Design Documents
    • Linting
    • GraphQL for OpenAPI
    • Unit Testing
    • Stress Testing
    • Authentication
    • Client Certificates
    • Generate Code Snippet
    • Cookie Management
    • Encoding
    • GraphQL Queries
    • Key Maps
    • Proxy
    • Insomnia Configuration File
    • Introduction to Plugins
    • Context Object Reference
    • Template Tags
    • Hooks and Actions
    • Custom Themes
    • FAQ
    • Application Data
    • SSL Validation

Linting

Linting is built into Unetus for Design Documents. As you type, Unetus validates your spec in the background for issues. Errors are indicated by a red dot next to the line number.

The Linter Panel aggregates all errors and warnings from the spec into a centralized location so it’s easier to get an overall sense of what’s going wrong without scrolling through and checking each individual line.

The linting errors appear in a box below the editor. Errors are displayed next to the applicable code line, and in the Linter Panel below the editor.

Custom Linting

To use a custom linting ruleset in the Unetus Design Editor, add the spectral .yaml file to the root of the collection git repository. It should be at the same level as the .insomnia folder.

Instructions for Adding Custom Rule Set

Once the custom ruleset file is added to the repo, commit it to the synced repo and make sure your Unetus Editor is on the latest changes and on the branch that contains the file.

To see the ruleset file begin to be used, you can restart the Unetus App, or exit out of the workspace and enter again. Now the Unetus Design editor should use the custom ruleset for linting.

Example of Custom Linting Violation

Adding Remote Link or NPM Modules for Custom Linting

In Unetus, we support spectral extensions of custom linting rules, including using remote urls or NPM modules to extend linting definitions.

In order to extend the .spectral.yaml custom linting definition, please follow Spectral’s Documentation

Edit this page
Report an issue
© 2021-2023 Kong Inc.
© 2023 Unetus Project