models

Documentation

Index

• type AvailableDataSet
• type AvailableDataSetForAPIVersion

Types

type AvailableDataSet

type AvailableDataSet struct {
	// ServiceName is the name of the Service (e.g. `Compute`).
	ServiceName string

	// DataSetsForAPIVersions contains a map of API Version (key) to AvailableDataSetForAPIVersion (value)
	// which outlines the available Data Set for this API Version.
	DataSetsForAPIVersions map[string]AvailableDataSetForAPIVersion

	// ResourceProvider is the Resource Provider associated with this Data Set.
	ResourceProvider *string
}

AvailableDataSet defines the available Data Sets for a Service - including the API Definitions for each API Version and any additional files.

type AvailableDataSetForAPIVersion

type AvailableDataSetForAPIVersion struct {
	// APIVersion specifies the APIVersion which this DataSet is related to.
	APIVersion string

	// ContainsStableAPIVersion specifies whether this is considered a Stable API Version or not.
	// if not, this should be considered a Preview API Version (either Private/Public Preview, or similar).
	ContainsStableAPIVersion bool

	// FilePathsContainingAPIDefinitions is a slice of the absolute file paths which contain the APIDefinitions
	// for the Service/API Version combination.
	FilePathsContainingAPIDefinitions []string
}

AvailableDataSetForAPIVersion defines the set of data related to a specific API Version This information is used by the Parser to parse out the information for this Service/API Version combination.

NOTE: in the future we could likely extend the Discovery logic to build and return an instance of AvailableDataSetForAPIVersion from the TypeSpec files, too.