Skip to content

Commit

Permalink
Comment on internal interfaces
Browse files Browse the repository at this point in the history
  • Loading branch information
Mooli Tayer committed Jan 23, 2018
1 parent 8098547 commit b015dfb
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 0 deletions.
1 change: 1 addition & 0 deletions lib/kubeclient/entity_list.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
module Kubeclient
module Common
# Kubernetes Entity List
# Note: this IS NOT(!) a supported interface, and might change without a version bump
class EntityList < DelegateClass(Array)
attr_reader :kind, :resourceVersion

Expand Down
2 changes: 2 additions & 0 deletions lib/kubeclient/http_error.rb
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# TODO: remove this on next major version bump
# Deprected http exception
# Note: this IS NOT(!) a supported interface, and might change without a version bump
class KubeException < StandardError
attr_reader :error_code, :message, :response

Expand All @@ -18,6 +19,7 @@ def to_s
end
end

# Note: this IS NOT(!) a supported interface, and might change without a version bump
module Kubeclient
# Exception that is raised when a http request fails
class HttpError < KubeException
Expand Down
1 change: 1 addition & 0 deletions lib/kubeclient/resource_not_found_error.rb
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
module Kubeclient
# Note: this IS NOT(!) a supported interface, and might change without a version bump
class ResourceNotFoundError < HttpError
end
end
1 change: 1 addition & 0 deletions lib/kubeclient/watch_notice.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
module Kubeclient
module Common
# Represents an individual notice received from a Kubernetes watch
# Note: this IS NOT(!) a supported interface, and might change without a version bump
class WatchNotice < RecursiveOpenStruct
def initialize(hash = nil, args = {})
args[:recurse_over_arrays] = true
Expand Down
1 change: 1 addition & 0 deletions lib/kubeclient/watch_stream.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
module Kubeclient
module Common
# HTTP Stream used to watch changes on entities
# Note: this IS NOT(!) a supported interface, and might change without a version bump
class WatchStream
def initialize(uri, http_options, as:)
@uri = uri
Expand Down

0 comments on commit b015dfb

Please sign in to comment.