config

Documentation

Overview

Licensed to Elasticsearch B.V. under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. Elasticsearch B.V. licenses this file to you 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

• type Config
  • func Load(flags Flags) (*Config, error)
• type Flags
• type KnownType
• type ProcessorConfig
• type RenderConfig

Types

type Config

type Config struct {
	Processor ProcessorConfig `json:"processor"`
	Render    RenderConfig    `json:"render"`
	Flags     `json:"-"`
}

func Load

func Load(flags Flags) (*Config, error)

type Flags

type Flags struct {
	Config       string
	LogLevel     string
	OutputPath   string
	Renderer     string
	SourcePath   string
	TemplatesDir string
	MaxDepth     int
}

type KnownType

type KnownType struct {
	Name    string `json:"name"`
	Package string `json:"package"`
	Link    string `json:"link"`
}

type ProcessorConfig

type ProcessorConfig struct {
	MaxDepth            int      `json:"maxDepth"`
	IgnoreTypes         []string `json:"ignoreTypes"`
	IgnoreFields        []string `json:"ignoreFields"`
	IgnoreGroupVersions []string `json:"ignoreGroupVersions"`
	UseRawDocstring     bool     `json:"useRawDocstring"`
}

type RenderConfig

type RenderConfig struct {
	KnownTypes        []*KnownType `json:"knownTypes"`
	KubernetesVersion string       `json:"kubernetesVersion"`
}