feat: annotate each path with other release versions #89
Conversation
cmars
force-pushed
the
feat/path-change-versions
branch
from
8f1e665
to
009f0f9
Compare
resource.go
Outdated
| // versions affecting the path. This supports navigation across versions. | ||
| for _, rc := range resourceVersions.versions { | ||
| for path, pathInfo := range rc.Paths { | ||
| pathInfo.ExtensionProps.Extensions[ExtSnykApiReleases] = pathReleases[path].Strings() |
There was a problem hiding this comment.
Is there a bit of code that's automatically adding extension sections to the spec output? I see the data added here, and I see a string representation utility function at the end of the PR, but no updates to have this put in spec, so guessing that's automatic?
There was a problem hiding this comment.
These extensions are basically being added on load, which gets merged into the compiled result by vervet.Merge.
The utility function is used to read the value of extensions provided in the source OpenAPI spec.
resource.go
Outdated
| @@ -139,31 +144,49 @@ func LoadResourceVersions(epPath string) (*ResourceVersions, error) { | |||
| } | |||
|
|
|||
| func LoadResourceVersionsFileset(specYamls []string) (*ResourceVersions, error) { | |||
| var eps ResourceVersions | |||
| var resourceVersions ResourceVersions | |||
There was a problem hiding this comment.
Good renaming; what was eps for?
resource.go
Outdated
| @@ -139,31 +144,49 @@ func LoadResourceVersions(epPath string) (*ResourceVersions, error) { | |||
| } | |||
|
|
|||
| func LoadResourceVersionsFileset(specYamls []string) (*ResourceVersions, error) { | |||
| var eps ResourceVersions | |||
| var resourceVersions ResourceVersions | |||
resource.go
Outdated
| // versions affecting the path. This supports navigation across versions. | ||
| for _, rc := range resourceVersions.versions { | ||
| for path, pathInfo := range rc.Paths { | ||
| pathInfo.ExtensionProps.Extensions[ExtSnykApiReleases] = pathReleases[path].Strings() |
There was a problem hiding this comment.
These extensions are basically being added on load, which gets merged into the compiled result by vervet.Merge.
The utility function is used to read the value of extensions provided in the source OpenAPI spec.
cmars
force-pushed
the
feat/path-change-versions
branch
from
009f0f9
to
0b22dbd
Compare
API documentation needs to represent a "changelog" per resource
endpoint: a list of versions in which a change to a given resource
endpoint was released.
This change adds a list of other resource release versions in which a
particular path was declared for such navigation purposes.
Implements #78.