Log in
Skip to sidebar
Skip to main content
Linked Applications
Loading…
Confluence
Spaces
Questions
Terms
Hit enter to search
Help
Online Help
Keyboard Shortcuts
Feed Builder
What’s new
Available Gadgets
About Confluence
Log in
Developer Wiki
Pages
Blog
Terms
Questions
Space shortcuts
Shared links
File lists
Meeting notes
JIRA Reports
How-to articles
Retrospectives
Product requirements
Page tree
Browse pages
Configure
Space tools
A
t
tachments (1)
Page History
Page Information
Resolved comments
View in Hierarchy
View Source
Export to PDF
Export to Word
Export to Markdown
Copy Page Tree
Pages
…
Technical Steering Committee (TSC)
TSC Subcommittees
Modeling sub-committee
ONAP R6 Modeling working space
Developing ONAP API Documentation
Jira links
Viewtracker
API Style Validation Tool
Created by
Andy Mayer
, last modified on
Jan 08, 2020
Spectral
We have successfully applied Spectral along with custom rules to "lint" Swagger files based on the ONAP Swagger style guide!
Spectral may be found at:
https://github.com/stoplightio/spectral
Instructions to install Spectral may be found at:
https://stoplight.io/p/docs/gh/stoplightio/spectral/docs/getting-started/installation.md
With Spectral, ONAP can provide our own ruleset file extending the rules used by Spectral.
The Draft ONAP Swagger Specific Style Rules for Spectral may be found here:
ONAP Swagger Style Ruleset for Spectral
The Spectral CLI will look for a ruleset file called
.spectral.yml
or
.spectral.json
in the current working directory.
We could also use a different file by using the
CLI option
--ruleset
Additional information on Spectral Rulesets may be found at:
https://stoplight.io/p/docs/gh/stoplightio/spectral/docs/getting-started/rulesets.md
No labels
Overview
Content Tools
{"serverDuration": 145, "requestCorrelationId": "ad74c1b4e341023d"}