swagger.json

{
	"definitions": {
		"io.k8s.api.networking.v1.NetworkPolicy": {
			"description": "NetworkPolicy describes what network traffic is allowed for a set of Pods",
			"properties": {
				"apiVersion": {
					"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
					"type": "string"
				},
				"kind": {
					"description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
					"type": "string"
				},
				"metadata": {
					"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta",
					"description": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"
				},
				"spec": {
					"$ref": "#/definitions/io.k8s.api.networking.v1.NetworkPolicySpec",
					"description": "Specification of the desired behavior for this NetworkPolicy."
				}
			},
			"type": "object",
			"x-kubernetes-group-version-kind": [
				{
					"group": "networking.k8s.io",
					"kind": "NetworkPolicy",
					"version": "v1"
				}
			]
		},
		"io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta": {
			"description": "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.",
			"properties": {
				"annotations": {
					"additionalProperties": {
						"type": "string"
					},
					"description": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations",
					"type": "object"
				},
				"clusterName": {
					"description": "The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.",
					"type": "string"
				},
				"creationTimestamp": {
					"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time",
					"description": "CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.\n\nPopulated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"
				},
				"deletionGracePeriodSeconds": {
					"description": "Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.",
					"format": "int64",
					"type": "integer"
				},
				"deletionTimestamp": {
					"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time",
					"description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"
				},
				"finalizers": {
					"description": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order.  Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.",
					"items": {
						"type": "string"
					},
					"type": "array",
					"x-kubernetes-patch-strategy": "merge"
				},
				"generateName": {
					"description": "GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency",
					"type": "string"
				},
				"generation": {
					"description": "A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.",
					"format": "int64",
					"type": "integer"
				},
				"labels": {
					"additionalProperties": {
						"type": "string"
					},
					"description": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels",
					"type": "object"
				},
				"managedFields": {
					"description": "ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object.",
					"items": {
						"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry"
					},
					"type": "array"
				},
				"name": {
					"description": "Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names",
					"type": "string"
				},
				"namespace": {
					"description": "Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces",
					"type": "string"
				},
				"ownerReferences": {
					"description": "List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.",
					"items": {
						"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference"
					},
					"type": "array",
					"x-kubernetes-patch-merge-key": "uid",
					"x-kubernetes-patch-strategy": "merge"
				},
				"resourceVersion": {
					"description": "An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency",
					"type": "string"
				},
				"selfLink": {
					"description": "SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.",
					"type": "string"
				},
				"uid": {
					"description": "UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids",
					"type": "string"
				}
			},
			"type": "object"
		},
		"io.k8s.apimachinery.pkg.apis.meta.v1.Time": {
			"description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON.  Wrappers are provided for many of the factory methods that the time package offers.",
			"format": "date-time",
			"type": "string"
		},
		"io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry": {
			"description": "ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.",
			"properties": {
				"apiVersion": {
					"description": "APIVersion defines the version of this resource that this field set applies to. The format is \"group/version\" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.",
					"type": "string"
				},
				"fieldsType": {
					"description": "FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: \"FieldsV1\"",
					"type": "string"
				},
				"fieldsV1": {
					"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.FieldsV1",
					"description": "FieldsV1 holds the first JSON version format as described in the \"FieldsV1\" type."
				},
				"manager": {
					"description": "Manager is an identifier of the workflow managing these fields.",
					"type": "string"
				},
				"operation": {
					"description": "Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.",
					"type": "string"
				},
				"time": {
					"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time",
					"description": "Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'"
				}
			},
			"type": "object"
		},
		"io.k8s.apimachinery.pkg.apis.meta.v1.FieldsV1": {
			"description": "FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.\n\nEach key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of  a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.\n\nThe exact format is defined in sigs.k8s.io/structured-merge-diff",
			"type": "object"
		},
		"io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference": {
			"description": "OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.",
			"properties": {
				"apiVersion": {
					"description": "API version of the referent.",
					"type": "string"
				},
				"blockOwnerDeletion": {
					"description": "If true, AND if the owner has the \"foregroundDeletion\" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs \"delete\" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.",
					"type": "boolean"
				},
				"controller": {
					"description": "If true, this reference points to the managing controller.",
					"type": "boolean"
				},
				"kind": {
					"description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
					"type": "string"
				},
				"name": {
					"description": "Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names",
					"type": "string"
				},
				"uid": {
					"description": "UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids",
					"type": "string"
				}
			},
			"required": [
				"apiVersion",
				"kind",
				"name",
				"uid"
			],
			"type": "object"
		},
		"io.k8s.api.networking.v1.NetworkPolicySpec": {
			"description": "NetworkPolicySpec provides the specification of a NetworkPolicy",
			"properties": {
				"egress": {
					"description": "List of egress rules to be applied to the selected pods. Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8",
					"items": {
						"$ref": "#/definitions/io.k8s.api.networking.v1.NetworkPolicyEgressRule"
					},
					"type": "array"
				},
				"ingress": {
					"description": "List of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default)",
					"items": {
						"$ref": "#/definitions/io.k8s.api.networking.v1.NetworkPolicyIngressRule"
					},
					"type": "array"
				},
				"podSelector": {
					"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
					"description": "Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace."
				},
				"policyTypes": {
					"description": "List of rule types that the NetworkPolicy relates to. Valid options are \"Ingress\", \"Egress\", or \"Ingress,Egress\". If this field is not specified, it will default based on the existence of Ingress or Egress rules; policies that contain an Egress section are assumed to affect Egress, and all policies (whether or not they contain an Ingress section) are assumed to affect Ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ \"Egress\" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include \"Egress\" (since such a policy would not include an Egress section and would otherwise default to just [ \"Ingress\" ]). This field is beta-level in 1.8",
					"items": {
						"type": "string"
					},
					"type": "array"
				}
			},
			"required": [
				"podSelector"
			],
			"type": "object"
		},
		"io.k8s.api.networking.v1.NetworkPolicyEgressRule": {
			"description": "NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8",
			"properties": {
				"ports": {
					"description": "List of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.",
					"items": {
						"$ref": "#/definitions/io.k8s.api.networking.v1.NetworkPolicyPort"
					},
					"type": "array"
				},
				"to": {
					"description": "List of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list.",
					"items": {
						"$ref": "#/definitions/io.k8s.api.networking.v1.NetworkPolicyPeer"
					},
					"type": "array"
				}
			},
			"type": "object"
		},
		"io.k8s.api.networking.v1.NetworkPolicyPort": {
			"description": "NetworkPolicyPort describes a port to allow traffic on",
			"properties": {
				"port": {
					"$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString",
					"description": "The port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers."
				},
				"protocol": {
					"description": "The protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.",
					"type": "string"
				}
			},
			"type": "object"
		},
		"io.k8s.apimachinery.pkg.util.intstr.IntOrString": {
			"description": "IntOrString is a type that can hold an int32 or a string.  When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type.  This allows you to have, for example, a JSON field that can accept a name or number.",
			"format": "int-or-string",
			"type": "string"
		},
		"io.k8s.api.networking.v1.NetworkPolicyPeer": {
			"description": "NetworkPolicyPeer describes a peer to allow traffic to/from. Only certain combinations of fields are allowed",
			"properties": {
				"ipBlock": {
					"$ref": "#/definitions/io.k8s.api.networking.v1.IPBlock",
					"description": "IPBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be."
				},
				"namespaceSelector": {
					"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
					"description": "Selects Namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces.\n\nIf PodSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector."
				},
				"podSelector": {
					"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
					"description": "This is a label selector which selects Pods. This field follows standard label selector semantics; if present but empty, it selects all pods.\n\nIf NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the Pods matching PodSelector in the policy's own Namespace."
				}
			},
			"type": "object"
		},
		"io.k8s.api.networking.v1.IPBlock": {
			"description": "IPBlock describes a particular CIDR (Ex. \"192.168.1.1/24\",\"2001:db9::/64\") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.",
			"properties": {
				"cidr": {
					"description": "CIDR is a string representing the IP Block Valid examples are \"192.168.1.1/24\" or \"2001:db9::/64\"",
					"type": "string"
				},
				"except": {
					"description": "Except is a slice of CIDRs that should not be included within an IP Block Valid examples are \"192.168.1.1/24\" or \"2001:db9::/64\" Except values will be rejected if they are outside the CIDR range",
					"items": {
						"type": "string"
					},
					"type": "array"
				}
			},
			"required": [
				"cidr"
			],
			"type": "object"
		},
		"io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector": {
			"description": "A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.",
			"properties": {
				"matchExpressions": {
					"description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.",
					"items": {
						"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement"
					},
					"type": "array"
				},
				"matchLabels": {
					"additionalProperties": {
						"type": "string"
					},
					"description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed.",
					"type": "object"
				}
			},
			"type": "object",
			"x-kubernetes-map-type": "atomic"
		},
		"io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement": {
			"description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.",
			"properties": {
				"key": {
					"description": "key is the label key that the selector applies to.",
					"type": "string",
					"x-kubernetes-patch-merge-key": "key",
					"x-kubernetes-patch-strategy": "merge"
				},
				"operator": {
					"description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.",
					"type": "string"
				},
				"values": {
					"description": "values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.",
					"items": {
						"type": "string"
					},
					"type": "array"
				}
			},
			"required": [
				"key",
				"operator"
			],
			"type": "object"
		},
		"io.k8s.api.networking.v1.NetworkPolicyIngressRule": {
			"description": "NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from.",
			"properties": {
				"from": {
					"description": "List of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the from list.",
					"items": {
						"$ref": "#/definitions/io.k8s.api.networking.v1.NetworkPolicyPeer"
					},
					"type": "array"
				},
				"ports": {
					"description": "List of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.",
					"items": {
						"$ref": "#/definitions/io.k8s.api.networking.v1.NetworkPolicyPort"
					},
					"type": "array"
				}
			},
			"type": "object"
		}
	}
}