Documentation
¶
Overview ¶
Copyright 2024 MongoDB Inc
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Copyright 2024 MongoDB Inc ¶
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewOperationConfigs ¶
func NewOperationConfigs(base, revision *load.SpecInfo) map[string]*OperationConfigs
NewOperationConfigs parses the base and revision openapi specs and returns the mapping between API operationId and EndpointConfig.
Types ¶
type OasDiffEntry ¶
type OasDiffEntry struct {
ID string `json:"id"`
Date string `json:"date"`
Text string `json:"text"`
Level int `json:"level"`
Operation string `json:"operation,omitempty"`
OperationID string `json:"operationId,omitempty"`
Path string `json:"path,omitempty"`
Source string `json:"source,omitempty"`
Section string `json:"section"`
HideFromChangelog bool `json:"hideFromChangelog,omitempty"`
}
func MarkHiddenEntries ¶
func MarkHiddenEntries(entries []*OasDiffEntry, exemptionsFilePath string, fs afero.Fs) ([]*OasDiffEntry, error)
MarkHiddenEntries sets the HideFromChangelog flag to true.
func NewChangelogEntries ¶
func NewChangelogEntries(checkers checker.Changes, specInfoPair *load.SpecInfoPair, exemptionsFilePath string) ([]*OasDiffEntry, error)
func (*OasDiffEntry) LevelWithDefault ¶
func (o *OasDiffEntry) LevelWithDefault() int
type OperationConfig ¶
type OperationConfigs ¶
type OperationConfigs struct {
Base *OperationConfig
Revision *OperationConfig
}
func (*OperationConfigs) Sunset ¶
func (e *OperationConfigs) Sunset() string
func (*OperationConfigs) Tag ¶
func (e *OperationConfigs) Tag() string
type SquashHandler ¶
type SquashHandler interface {
Squash(entriesGroupedByOperationID map[string][]*OasDiffEntry) []*OasDiffEntry
}
Source Files