{ "description": "ContentItem defines additional documentation for given resource.", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore 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.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", "type": "string" }, "metadata": { "type": "object" }, "spec": { "description": "Defines the documentation to attach to the referenced resource.", "properties": { "content": { "description": "Content is the valid markdown content.", "maxLength": 1500000, "type": "string" }, "link": { "description": "Link is the link to the content.", "properties": { "href": { "description": "Href is the public URL of the content.", "type": "string", "x-kubernetes-validations": [ { "message": "must be a valid URL", "rule": "isURL(self)" } ] } }, "required": [ "href" ], "type": "object", "additionalProperties": false }, "order": { "description": "Order defines the order of the content in the UI.", "format": "int32", "minimum": 0, "type": "integer" }, "parentRef": { "description": "ParentRef is the reference to the resource that this content belongs to.", "properties": { "kind": { "description": "Kind is the kind of the resource that this content belongs to.", "enum": [ "APIPortal", "API", "APIBundle" ], "type": "string" }, "name": { "description": "Name is the name of the resource that this content belongs to.", "maxLength": 253, "type": "string" } }, "required": [ "kind", "name" ], "type": "object", "additionalProperties": false }, "title": { "description": "Title is the public-facing name of the ContentItem.", "maxLength": 253, "minLength": 1, "type": "string" } }, "required": [ "order", "parentRef", "title" ], "type": "object", "x-kubernetes-validations": [ { "message": "exactly one of content or link must be specified", "rule": "[has(self.content), has(self.link)].filter(x, x).size() == 1" } ], "additionalProperties": false }, "status": { "description": "The current status of this ContentItem.", "properties": { "conditions": { "items": { "description": "Condition contains details for one aspect of the current state of this API Resource.", "properties": { "lastTransitionTime": { "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "format": "date-time", "type": "string" }, "message": { "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.", "maxLength": 32768, "type": "string" }, "observedGeneration": { "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", "format": "int64", "minimum": 0, "type": "integer" }, "reason": { "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.", "maxLength": 1024, "minLength": 1, "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "type": "string" }, "status": { "description": "status of the condition, one of True, False, Unknown.", "enum": [ "True", "False", "Unknown" ], "type": "string" }, "type": { "description": "type of condition in CamelCase or in foo.example.com/CamelCase.", "maxLength": 316, "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "type": "string" } }, "required": [ "lastTransitionTime", "message", "reason", "status", "type" ], "type": "object", "additionalProperties": false }, "type": "array" }, "hash": { "description": "Hash is a hash representing the ContentItem.", "type": "string" }, "syncedAt": { "format": "date-time", "type": "string" }, "version": { "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object" }