Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package checker detects breaking changes and generates changelog messages between OpenAPI specifications.
|
Package checker detects breaking changes and generates changelog messages between OpenAPI specifications. |
|
coverage
oasdiff's ultimate objective is to detect breaking changes, so that its users can prevent them.
|
oasdiff's ultimate objective is to detect breaking changes, so that its users can prevent them. |
|
internal/deprecation
Package deprecation follows an element through the deprecation process: the stage its deprecated flag and x-sunset date put it in, and the id that reports that stage.
|
Package deprecation follows an element through the deprecation process: the stage its deprecated flag and x-sunset date put it in, and the id that reports that stage. |
|
internal/extension
Package extension reads the values of OpenAPI specification extensions.
|
Package extension reads the values of OpenAPI specification extensions. |
|
internal/location
Package location finds where a change is in a spec: the file, line and column of the operation, parameter, response, schema or field it concerns, on the base side and the revision side.
|
Package location finds where a change is in a spec: the file, line and column of the operation, parameter, response, schema or field it concerns, on the base side and the revision side. |
|
internal/schemawalk
Package schemawalk visits the sub-schemas of a schema diff and names each by its property path, the same path the checks use in their messages.
|
Package schemawalk visits the sub-schemas of a schema diff and names each by its property path, the same path the checks use in their messages. |
|
localizations
Package localizations provides localized messages for breaking change and changelog output.
|
Package localizations provides localized messages for breaking change and changelog output. |
|
metaschema
Package metaschema enumerates every possible edit of an OpenAPI document: each field location in the OpenAPI object model, paired with the syntactic edit actions applicable at that location.
|
Package metaschema enumerates every possible edit of an OpenAPI document: each field location in the OpenAPI object model, paired with the syntactic edit actions applicable at that location. |
|
rules
Package rules defines the metadata model of the backward-compatibility rules: the severity levels, the Direction/Area/Kind taxonomy, the Effect a rule concludes about the accepted-value set, the Guards that select the document state it applies to, and the claims tying each rule to the edits it covers (see checker/metaschema).
|
Package rules defines the metadata model of the backward-compatibility rules: the severity levels, the Direction/Area/Kind taxonomy, the Effect a rule concludes about the accepted-value set, the Guards that select the document state it applies to, and the claims tying each rule to the edits it covers (see checker/metaschema). |
|
Package colorize holds the color-output primitives shared by every package that renders to a terminal: the ColorMode setting (always, never, auto with piped-output detection) and the switch that decides whether color is enabled.
|
Package colorize holds the color-output primitives shared by every package that renders to a terminal: the ColorMode setting (always, never, auto with piped-output detection) and the switch that decides whether color is enabled. |
|
Package diff calculates the difference between two OpenAPI specifications.
|
Package diff calculates the difference between two OpenAPI specifications. |
|
flatten
|
|
|
allof
Package allof merges allOf schema compositions into single unified schemas.
|
Package allof merges allOf schema compositions into single unified schemas. |
|
commonparams
Package commonparams moves path-level parameters to individual operations.
|
Package commonparams moves path-level parameters to individual operations. |
|
headers
Package headers normalizes HTTP header names to lowercase.
|
Package headers normalizes HTTP header names to lowercase. |
|
Package formatters transforms oasdiff output into various formats for display and integration.
|
Package formatters transforms oasdiff output into various formats for display and integration. |
|
populatetest
Package populatetest fills reflect values with non-zero samples derived from their types.
|
Package populatetest fills reflect values with non-zero samples derived from their types. |
|
Package load provides functions to load OpenAPI specifications from various sources.
|
Package load provides functions to load OpenAPI specifications from various sources. |
|
Package report generates basic human-readable diff reports in text and HTML formats.
|
Package report generates basic human-readable diff reports in text and HTML formats. |
|
Package review builds the encrypted review bundle: the two specs, the computed changelog, and the per-change structural blocks of the specs.
|
Package review builds the encrypted review bundle: the two specs, the computed changelog, and the per-change structural blocks of the specs. |
|
Package utils provides common utilities for the use of other packages in oasdiff.
|
Package utils provides common utilities for the use of other packages in oasdiff. |
|
Package validate exposes spec validation as a public library API.
|
Package validate exposes spec validation as a public library API. |
Click to show internal directories.
Click to hide internal directories.