Generic Objects API

[jntullo]

Generic Objects API CRUD
(will make separate PRs for subcollection actions and calling generic object methods)

GET

• Returns property_attributes by default
• can specify associations to return

GET /api/generic_objects/:id?associations=vms,services

response:
{
  "id": "<id>",
  "name": "generic_object_name",
  "generic_object_definition_id": "id",
  "property_attributes": { "widget": "test", "is_something": true },
  "vms": [ { "id": "id" ...  } ],
  "services": [ { "id": "id" ... }]  
}

POST /api/generic_objects

Creating a new generic object

{  
   "generic_object_definition":{  
      "href":"/api/generic_object_definitions/:id"
   },
   "name":"go_name1",
   "uid":"optional_uid",
   "property_attributes":{  
      "widget":"widget value",
      "is_something":false
   },
   "associations":{  
      "vms":[  
         {  
            "href":"/api/vms/:id"
         },
         {  
            "href":"api/vms/:id"
         }
      ],
      "services":[  
         {  
            "href":"api/service/:id"
         }
      ]
   }
}

Editing a Generic Object

• Much like create - accepts associations and property_attributes

{  
   "action":"edit",
   "resources":[  
      {  
         "href":"/api/generic_objects/:id",
         "name":"updated name",
         "property_attributes":{  
            "widget":"updated widget"
         }
      }
   ]
}

Deleting a Generic Object

{  
   "action":"delete",
   "resources":[  
      {  
         "href":"/api/generic_objects/:id"
      }
   ]
}

POST /api/generic_objects/:id

Editing a generic object

{  
   "action":"edit",
   "resource":{  
      "name":"updated object",
      "property_attributes":{  
         "widget":"updated widget val",
         "is_something":false
      },
      "associations":{  
         "vms":[  
            {  
               "href":"/api/vms/:id"
            }
         ],
         "services":[  

         ]
      }
   }
}

Deleting a generic object

{
   "action": "delete"
}

DELETE api/generic_objects/:id

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

[jntullo]

@abellotti wanted to get your thoughts on this approach to returning associations since it's slightly different than we talked about. With GET /generic_objects/:id?property_associations=vms,services, and by adding them to the additional attributes, they can then get returned as if they were a normal relationship, ie:

{
  "id": "<generic_object_id>",
   ...
  "vms" [ {"id": "vm_id" }, ... ]
  "services": [ ... ]
}

thoughts?

[abellotti]

I like it, I wonder if the parameter shouldn't just be associations=vms,services,... to match the add_associations/remove_associations actions.

[jntullo]

@abellotti yeah, I like that. will update! 👍

[abellotti]

Thanks @jntullo for the PR. this LGTM 👍

/cc @imtayadeway can I borrow your 👀 for a quick look here. Thanks!!

[imtayadeway]

If you wish, you can use type = @req.subject here ☺️

[abellotti]

👍 🎵

[abellotti]

@imtayadeway waiting for your approval when you get a chance. Thanks !!

[miq-bot]

Checked commits jntullo/manageiq-api@5d5fbf3~...103df94 with ruby 2.2.6, rubocop 0.47.1, and haml-lint 0.20.0
4 files checked, 0 offenses detected
Everything looks fine. 🏆

[imtayadeway]

This LGTM. Thank you @jntullo ! 🥇

[chriskacerguis]

Echoing a previous question but how do you (1) get GO’s for a service and (2) how does one associate a GO with a service?

/cc @chalettu

[jntullo]

@chriskacerguis @chalettu services don't have GO's so much as a GO can have a service. A service can be added to a Generic Object via association so long as that association is defined in the generic object definition of the GO (see #15 or #37). Then if that relationship exists, the services can be added as seen in the examples I have documented above (via both create and edit).

@lfu and @bzwei would be best to describe it though, and to inform if there is a straightforward way in which to grab generic objects of a service.

[chriskacerguis]

@jntullo thanks for the clarification. So, given a service, how can I get the associated GO's?

[lfu]

A service can be added to a Generic Object via association so long as that association is defined in the generic object definition of the GO (see #15 or #37).

@jntullo This is correct. A service can be connected to a generic object as an association.

Generic objects can also be added to a service as resources. @chriskacerguis To get the associated GO's of a given service, just call:

service.generic_objects

(see ManageIQ/manageiq#15490)

[jntullo]

@lfu thank you! I did not see that relationship.

@chriskacerguis I will create a PR for a subcollection on services. ie /services/:id/generic_objects

[chriskacerguis]

@jntullo much appreciated!!

@lfu thank you for pointing that out.

You both are awesome.

[jntullo]

@chriskacerguis @chalettu just realized, it's not even necessary for the subcollection. you'll be able to specify attributes=generic_objects since that relationship already exists.

[chriskacerguis]

nice. Thanks @jntullo

[chriskacerguis]

@chalettu does all that address your concerns?

[chalettu]

I believe this does address my concerns . Thank you so much @jntullo for helping to clarify

[abellotti]

@jntullo agreeing with you above, simply accessing via attributes=generic_objects. Otherwise, we'd need to add the subcollection to all API CI's which map to an Miq reportable model type.

[abellotti]

LGTM !!! Thanks @jntullo for this API enhancement 👍