podman
802 строки · 24.1 Кб
1// Copyright 2015 go-swagger maintainers2//3// Licensed under the Apache License, Version 2.0 (the "License");4// you may not use this file except in compliance with the License.5// You may obtain a copy of the License at6//7// http://www.apache.org/licenses/LICENSE-2.08//9// Unless required by applicable law or agreed to in writing, software10// distributed under the License is distributed on an "AS IS" BASIS,11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.12// See the License for the specific language governing permissions and13// limitations under the License.14)32// newRef stores information about refs created during the flattening process36type newRef struct {37key string38newName string39path string40isOAIGen bool41resolved bool42schema *spec.Schema43parents []string44}45// context stores intermediary results from flatten47type context struct {48newRefs map[string]*newRef49warnings []string50resolved map[string]string51}52}60// Flatten an analyzed spec and produce a self-contained spec bundle.62//63// There is a minimal and a full flattening mode.64//65//66// Minimally flattening a spec means:67// - Expanding parameters, responses, path items, parameter items and header items (references to schemas are left68// unscathed)69// - Importing external (http, file) references so they become internal to the document70// - Moving every JSON pointer to a $ref to a named definition (i.e. the reworked spec does not contain pointers71// like "$ref": "#/definitions/myObject/allOfs/1")72//73// A minimally flattened spec thus guarantees the following properties:74// - all $refs point to a local definition (i.e. '#/definitions/...')75// - definitions are unique76//77// NOTE: arbitrary JSON pointers (other than $refs to top level definitions) are rewritten as definitions if they78// represent a complex schema or express commonality in the spec.79// Otherwise, they are simply expanded.80// Self-referencing JSON pointers cannot resolve to a type and trigger an error.81//82//83// Minimal flattening is necessary and sufficient for codegen rendering using go-swagger.84//85// Fully flattening a spec means:86// - Moving every complex inline schema to be a definition with an auto-generated name in a depth-first fashion.87//88// By complex, we mean every JSON object with some properties.89// Arrays, when they do not define a tuple,90// or empty objects with or without additionalProperties, are not considered complex and remain inline.91//92// NOTE: rewritten schemas get a vendor extension x-go-gen-location so we know from which part of the spec definitions93// have been created.94//95// Available flattening options:96// - Minimal: stops flattening after minimal $ref processing, leaving schema constructs untouched97// - Expand: expand all $ref's in the document (inoperant if Minimal set to true)98// - Verbose: croaks about name conflicts detected99// - RemoveUnused: removes unused parameters, responses and definitions after expansion/flattening100//101// NOTE: expansion removes all $ref save circular $ref, which remain in place102//103// TODO: additional options104// - ProgagateNameExtensions: ensure that created entries properly follow naming rules when their parent have set a105// x-go-name extension106// - LiftAllOfs:107// - limit the flattening of allOf members when simple objects108// - merge allOf with validation only109// - merge allOf with extensions only110// - ...111//112func Flatten(opts FlattenOpts) error {113debugLog("FlattenOpts: %#v", opts)114}174}184// normalizeRef strips the current file from any absolute file $ref. This works around issue go-openapi/spec#76:186// leading absolute file in $ref is stripped187func normalizeRef(opts *FlattenOpts) error {188debugLog("normalizeRef")189}212}219}236// nameInlinedSchemas replaces every complex inline construct by a named definition.238func nameInlinedSchemas(opts *FlattenOpts) error {239debugLog("nameInlinedSchemas")240}271}292}306}371// importExternalReferences iteratively digs remote references and imports them into the main schema.373//374// At every iteration, new remotes may be found when digging deeper: they are rebased to the current schema before being imported.375//376// This returns true when no more remote references can be found.377func importExternalReferences(opts *FlattenOpts) (bool, error) {378debugLog("importExternalReferences")379}450// stripPointersAndOAIGen removes anonymous JSON pointers from spec and chain with name conflicts handler.452// This loops until the spec has no such pointer and all name conflicts have been reduced as much as possible.453func stripPointersAndOAIGen(opts *FlattenOpts) error {454// name all JSON pointers to anonymous documents455if err := namePointers(opts); err != nil {456return err457}458}487// stripOAIGen strips the spec from unnecessary OAIGen constructs, initially created to dedupe flattened definitions.489//490// A dedupe is deemed unnecessary whenever:491// - the only conflict is with its (single) parent: OAIGen is merged into its parent (reinlining)492// - there is a conflict with multiple parents: merge OAIGen in first parent, the rewrite other parents to point to493// the first parent.494//495// This function returns true whenever it re-inlined a complex schema, so the caller may chose to iterate496// pointer and name resolution again.497func stripOAIGen(opts *FlattenOpts) (bool, error) {498debugLog("stripOAIGen")499replacedWithComplex := false500}528// updateRefParents updates all parents of an updated $ref530func updateRefParents(allRefs map[string]spec.Ref, r *newRef) {531if !r.isOAIGen || r.resolved { // bail on already resolved entries (avoid looping)532return533}534for k, v := range allRefs {535if r.path != v.String() {536continue537}538}552}645// namePointers replaces all JSON pointers to anonymous documents by a $ref to a new named definitions.647//648// This is carried on depth-first. Pointers to $refs which are top level definitions are replaced by the $ref itself.649// Pointers to simple types are expanded, unless they express commonality (i.e. several such $ref are used).650func namePointers(opts *FlattenOpts) error {651debugLog("name pointers")652}725}803