@jkcfg/kubernetes/schemas/v1.9.9-local/apiresource.json

jk Kubernetes library

{
  "$schema": "http://json-schema.org/schema#", 
  "required": [
    "name", 
    "singularName", 
    "namespaced", 
    "kind", 
    "verbs"
  ], 
  "type": "object", 
  "description": "APIResource specifies the name of a resource and whether it is namespaced.", 
  "properties": {
    "shortNames": {
      "items": {
        "type": [
          "string", 
          "null"
        ]
      }, 
      "type": [
        "array", 
        "null"
      ], 
      "description": "shortNames is a list of suggested short names of the resource."
    }, 
    "namespaced": {
      "type": "boolean", 
      "description": "namespaced indicates if a resource is namespaced or not."
    }, 
    "kind": {
      "type": [
        "string", 
        "null"
      ], 
      "description": "kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')"
    }, 
    "group": {
      "type": [
        "string", 
        "null"
      ], 
      "description": "group is the preferred group of the resource.  Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale\"."
    }, 
    "name": {
      "type": [
        "string", 
        "null"
      ], 
      "description": "name is the plural name of the resource."
    }, 
    "version": {
      "type": [
        "string", 
        "null"
      ], 
      "description": "version is the preferred version of the resource.  Empty implies the version of the containing resource list For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource's group)\"."
    }, 
    "singularName": {
      "type": [
        "string", 
        "null"
      ], 
      "description": "singularName is the singular name of the resource.  This allows clients to handle plural and singular opaquely. The singularName is more correct for reporting status on a single item and both singular and plural are allowed from the kubectl CLI interface."
    }, 
    "categories": {
      "items": {
        "type": [
          "string", 
          "null"
        ]
      }, 
      "type": [
        "array", 
        "null"
      ], 
      "description": "categories is a list of the grouped resources this resource belongs to (e.g. 'all')"
    }, 
    "verbs": {
      "items": {
        "type": [
          "string", 
          "null"
        ]
      }, 
      "type": [
        "array", 
        "null"
      ], 
      "description": "verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)"
    }
  }
}