Generic Object Definition Actions

[jntullo]

Generic Object Definition Actions

Dependent upon ManageIQ/manageiq#15893

@miq-bot add_label enhancement, wip
@miq-bot assign @abellotti

General Usage Information

• Can reference a generic object definition by name, id, or href (see "add_attributes" example for how to specify)

Examples

add_attributes

POST /api/generic_object_definitions
{
  "action": "add_attributes",
  "resources": {
    "attributes": [
    {
      "name": "name",
      "resource": {
        "attributes": {
          "attr1": "string",
          "another": "boolean"
        }
      }
    },
    {
      "id": ":id",
      "resource": {
        "attributes": {
          "attr2": "string"
        }
      }
    },
    {
      "href": "/generic_object_definition/:id",
      "resource": {
        "attributes": {
          "attr3": "string"
        }
      }
    }
  ]}
}

POST /generic_object_definitions/:id
{
  "action"   : "add_attributes",
  "resource" : {
    "attributes" : {
      "added_attribute1" : "string",
      "added_attribute2" : "boolean"
    }
  }
}

remove_attributes

• Accepts same payload as "add_attributes", with different action specified

POST /generic_object_definitions/:id
{
  "action"   : "remove_attributes",
  "resource" : {
    "attributes" : {
      "added_attribute1" : "string",
      "added_attribute2" : "boolean"
    }
  }
}

add_methods

POST /generic_object_definitions
{
  "action"    : "add_methods",
  "resources" : [
    { "id" : "id", "resource" : { "methods" : ["method1", "method2"] } }
  ]
}

POST /generic_object_definitions/:id
{
  "action"   : "add_methods",
  "resource" : {
    "methods" : ["foo", "bar"]
  }
}

remove_methods

• accepts same payload as add_methods with different action specified

POST /generic_object_definitions
{
  "action"    : "remove_methods",
  "resources" : [
    { "id" : "id", "resource" : { "methods" : ["method1", "method2"] } }
  ]
}

POST /generic_object_definitions/:id
{
  "action"   : "remove_methods",
  "resource" : {
    "methods" : ["foo", "bar"]
  }
}

add_associations

POST /generic_object_definitions
{
  "action"    : "add_associations",
  "resources" : [
    { "href" : "/generic_object_definition/:id", "resource" : { "associations" : { "zones" : "AvailabilityZone" } }}
  ]
}

POST /generic_object_definitions/:id
{
  "action"   : "add_associations",
  "resource" : {
    "associations" : {
      "az"         : "AvailabilityZone",
      "chargeback" : "ChargebackVm"
    }
  }
}

remove_associations

• accepts same payload as add_associations with different action specified

POST /generic_object_definitions
{
  "action"    : "remove_associations",
  "resources" : [
    { "href" : "/generic_object_definition/:id", "resource" : { "associations" : { "zones" : "AvailabilityZone" } }}
  ]
}

POST /generic_object_definitions/:id
{
  "action"   : "remove_associations",
  "resource" : {
    "associations" : {
      "az"         : "AvailabilityZone",
      "chargeback" : "ChargebackVm"
    }
  }
}

[miq-bot]

This pull request is not mergeable. Please rebase and repush.

[imtayadeway]

Hi! It looks like your PR has been affected by the recently merged #40, and as a result will need to be rebased. First, I apologize for any inconvenience caused. After rebasing, you'll need to update some specs in order for them to pass. In particular you'll need to change any path helpers, applying the following pattern:

vms_url => api_vms_url
vms_url(vm.id) => api_vm_url(nil, vm) 
vms_url(vm.compressed_id) => api_vm_url(nil, vm.compressed_id)
"#{vms_url(vm.id)}/tags" => api_vm_tags_url(nil, vm)
"#{vms_url(vm.compressed_id}/tags" => api_vm_tags_url(nil, vm.compressed_id)
"#{vms_url(vm.id)}/tags/#{tag.id}" => api_vm_tag_url(nil, vm, tag)
"#{vms_url(vm.compressed_id)}/tags/#{tag.compressed_id}" => api_vm_tag_url(nil, vm.compressed_id, tag.compressed_id)

If you run into any issues, please ping me and I will try to help you out.

Many thanks!
Tim

[abellotti]

Hi @jntullo maybe add the :forbidden result cases for each of the new action in case they don't have the right role.

[abellotti]

isn't this handled by the base class, ie. if data['resource'] exists, that will be the data coming in ?

[jntullo]

@abellotti not in the case where the id is the name of the generic object

[abellotti]

👍

[abellotti]

Hi @jntullo, looks like #51 was merged yesterday, can you update the failing tests to use the new get/post/etc. signatures ? Thanks !!

[jntullo]

@abellotti whoops, missed that. this should make them 🍏 😄

[miq-bot]

Checked commit jntullo@e4e5adb with ruby 2.2.6, rubocop 0.47.1, and haml-lint 0.20.0
2 files checked, 0 offenses detected
Everything looks fine. 🏆

[abellotti]

Thanks @jntullo for the update. LGTM!! 👍