Class: Weft::ResourcesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/weft/generated/api/resources_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ResourcesApi

Returns a new instance of ResourcesApi.



19
20
21
 
# File 'lib/weft/generated/api/resources_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/weft/generated/api/resources_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#enroll_resource(resource_enrollment_request, opts = {}) ⇒ ResourceEnrollmentResponse

Self-enroll a ghost resource (public, no auth) Lets an unauthenticated agent (or its operator) self-enroll a Resource as a "ghost" (no owning provider). The server generates the slug and a single-use claim_token; the response also carries a claim_url the agent hands to its human controller to claim the resource from the dashboard. Client-supplied slug and category are silently ignored: slugs are server-generated from name (so callers cannot squat on reserved names), and category is a post-claim concern set by a real human. Rate-limited to 10 enrollments/hour/IP.

Parameters:

Returns:



27
28
29
30
 
# File 'lib/weft/generated/api/resources_api.rb', line 27

def enroll_resource(resource_enrollment_request, opts = {})
  data, _status_code, _headers = enroll_resource_with_http_info(resource_enrollment_request, opts)
  data
end

#enroll_resource_with_http_info(resource_enrollment_request, opts = {}) ⇒ Array<(ResourceEnrollmentResponse, Integer, Hash)>

Self-enroll a ghost resource (public, no auth) Lets an unauthenticated agent (or its operator) self-enroll a Resource as a &quot;ghost&quot; (no owning provider). The server generates the `slug` and a single-use `claim_token`; the response also carries a `claim_url` the agent hands to its human controller to claim the resource from the dashboard. Client-supplied `slug` and `category` are silently ignored: slugs are server-generated from `name` (so callers cannot squat on reserved names), and `category` is a post-claim concern set by a real human. Rate-limited to 10 enrollments/hour/IP.

Parameters:

Returns:

  • (Array<(ResourceEnrollmentResponse, Integer, Hash)>) —

    ResourceEnrollmentResponse data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/weft/generated/api/resources_api.rb', line 37

def enroll_resource_with_http_info(resource_enrollment_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResourcesApi.enroll_resource ...'
  end
  # verify the required parameter 'resource_enrollment_request' is set
  if @api_client.config.client_side_validation && resource_enrollment_request.nil?
    fail ArgumentError, "Missing the required parameter 'resource_enrollment_request' when calling ResourcesApi.enroll_resource"
  end
  # resource path
  local_var_path = '/api/v1/resources/enroll'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(resource_enrollment_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ResourceEnrollmentResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"ResourcesApi.enroll_resource",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResourcesApi#enroll_resource\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end