Unit Profiles
=============

Create A Profile
----------------

Create a :term:`unit profile` and associate it with the specified :term:`consumer`.
Unit profiles are associated to consumers by content type.  Each consumer may
be associated with one profile of a given content type at a time.  If a
profile of the specified content type is already associated with the consumer,
it is replaced with the profile supplied in this call.

| :method:`post`
| :path:`/v2/consumers/<consumer_id>/profiles/`
| :permission:`create`
| :param_list:`post`

* :param:`content_type,string,the content type ID`
* :param:`profile,object,the content profile`

| :response_list:`_`

* :response_code:`201,if the profile was successfully created`
* :response_code:`400,if one or more of the parameters is invalid`
* :response_code:`404,if the consumer does not exist`

| :return:`The created unit profile object`

:sample_request:`_` ::

 {
   "content_type": "rpm",
   "profile": [{"arch": "i686",
                "epoch": 0,
                "name": "glib2",
                "release": "2.fc17",
                "vendor": "Fedora Project",
                "version": "2.32.4"},
               {"arch": "x86_64",
                "epoch": 0,
                "name": "rpm-libs",
                "release": "8.fc17",
                "vendor": "Fedora Project",
                "version": "4.9.1.3"}]
 }

:sample_response:`201` ::

 {
   "profile": [{"arch": "i686",
                "epoch": 0,
                "name": "glib2",
                "release": "2.fc17",
                "vendor": "Fedora Project",
                "version": "2.32.4"},
               {"arch": "x86_64",
                "epoch": 0,
                "name": "rpm-libs",
                "release": "8.fc17",
                "vendor": "Fedora Project",
                "version": "4.9.1.3"}],
   "_ns": "consumer_unit_profiles",
   "consumer_id": "test-consumer",
   "content_type": "rpm",
   "_href": "/pulp/api/v2/consumers/test-consumer/profiles/rpm/",
   "profile_hash": "2ecdf09a0f1f6ea43b5a991b468866bc07bcf8c2ac8251395ef2d78adf6e5c5b",
   "_id": {"$oid": "5008500ae138230abe000095"},
   "id": "5008500ae138230abe000095"
 }


Replace a Profile
-----------------

Replace a :term:`unit profile` associated with the specified :term:`consumer`.
Unit profiles are associated to consumers by content type.  Each consumer may
be associated to one profile of a given content type at one time.  If no
unit profile matching the specified content type is currently associated to the
consumer, the supplied profile is created and associated with the consumer
using the specified content type.

| :method:`put`
| :path:`/v2/consumers/<consumer_id>/profiles/<content-type>/`
| :permission:`update`
| :param_list:`put`

* :param:`profile,object,the content profile`

| :response_list:`_`

* :response_code:`201,if the profile was successfully updated`
* :response_code:`400,if one or more of the parameters is invalid`
* :response_code:`404,if the consumer does not exist`

| :return:`The created unit profile object`

:sample_request:`_` ::

 {
   "profile": [{"arch": "i686",
                "epoch": 0,
                "name": "glib2",
                "release": "2.fc17",
                "vendor": "Fedora Project",
                "version": "2.32.4"},
               {"arch": "x86_64",
                "epoch": 0,
                "name": "rpm-libs",
                "release": "8.fc17",
                "vendor": "Fedora Project",
                "version": "4.9.1.3"}]
 }

:sample_response:`201` ::

 {
   "profile": [{"arch": "i686",
                "epoch": 0,
                "name": "glib2",
                "release": "2.fc17",
                "vendor": "Fedora Project",
                "version": "2.32.4"},
               {"arch": "x86_64",
                "epoch": 0,
                "name": "rpm-libs",
                "release": "8.fc17",
                "vendor": "Fedora Project",
                "version": "4.9.1.3"}],
   "_ns": "consumer_unit_profiles",
   "consumer_id": "test-consumer",
   "content_type": "rpm",
   "_href": "/pulp/api/v2/consumers/test-consumer/profiles/rpm/",
   "profile_hash": "2abcf09a0f1f6ea43b5a991b468866bc07bcf8c2ac8251395ef2d78adf6e5c5b",
   "_id": {"$oid": "5008500ae138230abe000095"},
   "id": "5008500ae138230abe000095"
 }


Delete a profile
---------------------

Removes a profile associated with a consumer.

| :method:`delete`
| :path:`/v2/consumers/<consumer_id>/profiles/<content_type>/`
| :permission:`delete`
| :param_list:`delete`
| :response_list:`_`

* :response_code:`200,if the profile was successfully deleted`
* :response_code:`404,if there is no consumer with the given ID or profile`

| :return:`null`


Retrieve All Profiles By Consumer Id
------------------------------------

Retrieves information on all :term:`unit profile` entries associated
with a :term:`consumer`.

| :method:`get`
| :path:`/v2/consumers/<consumer_id>/profiles/`
| :permission:`read`
| :param_list:`get` None; There are no supported query parameters
| :response_list:`_`

* :response_code:`200,regardless of whether any profiles exist`
* :response_code:`404,if the consumer does not exist`

| :return:`an array of unit profile objects or an empty array if none exist`

:sample_response:`200` ::

 [
  {"_href": "/pulp/api/v2/consumers/test-consumer/profiles/test-content-type/",
   "_id": {"$oid": "521d92b1e5e7102f7500004a"},
   "_ns": "consumer_unit_profiles",
   "consumer_id": "test-consumer",
   "content_type": "test-content-type",
   "id": "521d92b1e5e7102f7500004a",
   "profile": [{"arch": "i686",
                "epoch": 0,
                "name": "glib2",
                "release": "2.fc17",
                "vendor": "Fedora Project",
                "version": "2.32.4"},
               {"arch": "x86_64",
                "epoch": 0,
                "name": "rpm-libs",
                "release": "8.fc17",
                "vendor": "Fedora Project",
                "version": "4.9.1.3"}],
   "profile_hash": "15df1c6105edacd6b167d2e9dd87311b069f50cebb2f7968ef185c1d6eae5197"
  },
  {"_href": "/pulp/api/v2/consumers/test-consumer/profiles/rpm/",
   "_id": {"$oid": "5217d77de5e710796700000c"},
   "_ns": "consumer_unit_profiles",
   "consumer_id": "test-consumer",
   "content_type": "rpm",
   "id": "5217d77de5e710796700000c",
   "profile": [{"arch": "i686",
                "epoch": 0,
                "name": "glib2",
                "release": "2.fc17",
                "vendor": "Fedora Project",
                "version": "2.32.4"}],
   "profile_hash": "15df1c6105edacd6b167d2e9dd87311b069f50cebb2f7968ef185c1d6eae5197"
  }
 ]


Retrieve a Profile By Content Type
----------------------------------

Retrieves a :term:`unit profile` associated with a :term:`consumer` by
content type.

| :method:`get`
| :path:`/v2/consumers/<consumer_id>/profiles/<content_type>/`
| :permission:`read`
| :param_list:`get` None; There are no supported query parameters
| :response_list:`_`

* :response_code:`200,if profile exists`
* :response_code:`404,if the consumer or requested profile does not exists`

| :return:`the requested unit profile object`

:sample_response:`200` ::

 {
   "_href": "/pulp/api/v2/consumers/test-consumer/profiles/test-content-type/",
   "_id": {"$oid": "521d92b1e5e7102f7500004a"},
   "_ns": "consumer_unit_profiles",
   "consumer_id": "test-consumer",
   "content_type": "test-content-type",
   "id": "521d92b1e5e7102f7500004a",
   "profile": [{"arch": "i686",
                "epoch": 0,
                "name": "glib2",
                "release": "2.fc17",
                "vendor": "Fedora Project",
                "version": "2.32.4"},
               {"arch": "x86_64",
                "epoch": 0,
                "name": "rpm-libs",
                "release": "8.fc17",
                "vendor": "Fedora Project",
                "version": "4.9.1.3"}],
   "profile_hash": "15df1c6105edacd6b167d2e9dd87311b069f50cebb2f7968ef185c1d6eae5197"
 }


Retrieve All Profiles
---------------------

Retrieves information on all :term:`unit profile` entries.

| :method:`get`
| :path:`/v2/consumers/profile/search/`
| :permission:`read`
| :param_list:`get` None; There are no supported query parameters
| :response_list:`_`

* :response_code:`200, containing the array of items`

| :return:`array of unit profiles`

:sample_response:`200` ::

 [
   {
     "profile": [{"arch": "i686",
                 "epoch": 0,
                 "name": "glib2",
                 "release": "2.fc17",
                 "vendor": "Fedora Project",
                 "version": "2.32.4"},
                 {"arch": "x86_64",
                 "epoch": 0,
                 "name": "rpm-libs",
                 "release": "8.fc17",
                 "vendor": "Fedora Project",
                 "version": "4.9.1.3"}],
     "_ns": "consumer_unit_profiles", 
     "profile_hash": "d20dc2d0fce88a064a2f7309863da7ebd068969de0150fd8ff83c220a0785d8a", 
     "consumer_id": "test-consumer", 
     "content_type": "rpm", 
     "_id": {"$oid": "545cacf09cd4ca28c83dd9f5"}, 
     "id": "545cacf09cd4ca28c83dd9f5"
   }
 ]


Searching Profiles
------------------

Returns items that match the search parameters. To understand how to use the SearchAPI look at the :ref:`search_criteria` page. This call will never return a 404; an empty array is returned in the case where there are no items in the database.

| :method:`post`
| :path:`/v2/consumers/profile/search/`
| :permission:`read`
| :param_list:`post` include the key "criteria" whose value is a mapping structure as defined in :ref:`search_criteria`
| :response_list:`_`

* :response_code:`200, containing the result of the query`

| :return:`elements matching the query`

:sample_request:`_` ::

 {
   "criteria" : { 
     "filters" : { "profile.name"  : "pulp-consumer-client" }, 
     "fields" : [ "consumer_id", "profile.$" ]
   }
 }

:sample_response:`200` ::

 {
   "profile": [
     {
       "vendor": "Koji", 
       "name": "pulp-consumer-client", 
       "epoch": 0, 
       "version": "2.4.3", 
       "release": "1.el6", 
       "arch": "noarch"
     }
   ], 
   "_id": {"$oid": "545cacf09cd4ca28c83dd9f5"}, 
   "id": "545cacf09cd4ca28c83dd9f5", 
   "consumer_id": "pulp-test"
 }