generated

Documentation

Overview

Code generated by "mdtogo"; DO NOT EDIT.

Index

• Variables

Variables

var FormatExamples = `
Format a package:

Let's start with the input resource in a package.

  apiVersion: apps/v1
  kind: Deployment
  metadata:
    annotations:
      bar: 100
    name: nginx-deployment
  spec:
    template:
      spec:
        containers:
          - name: nginx
            image: nginx:1.0.0
            ports:
              - containerPort: 80
                name: http

Invoke the ` + "`" + `format` + "`" + ` function on the package, formatted resource looks like the following:

  apiVersion: apps/v1
  kind: Deployment
  metadata:
    name: nginx-deployment
    annotations:
      bar: "100"
  spec:
    template:
      spec:
        containers:
          - name: nginx
            image: nginx:1.0.0
            ports:
              - name: http
                containerPort: 80

The fields are ordered as per the OpenAPI schema definition of ` + "`" + `Deployment` + "`" + ` resource. For e.g. ` + "`" + `metadata.name` + "`" + ` field
is moved up. Since the type of annotation value is ` + "`" + `string` + "`" + `, quotes are added to value ` + "`" + `100` + "`" + ` as it will be interpreted
as ` + "`" + `int` + "`" + ` by yaml in its current form.
`

var FormatLong = `` /* 314-byte string literal not displayed */

var FormatShort = `Format resources by sorting fields, fixing indentation and quoting ambiguous string values.`