feat: OBS-397 - [NetBox Diode Plugin] create API endpoint for retrieving NetBox object state

[Julio-Oliveira-Encora]

• Add endpoint "/api/plugins/diode/object-state/";
• Parameter object_type is mandatory.
• Parameters must have q or ID.
• Endpoint returns only one object per request.
• The q parameter uses CachedValue to get the object ID, and then the cache must be updated.
• If there is any error in the payload, return 400.
• If the query is empty, the endpoint returns 200 and an empty list.

[linear]

OBS-397 Create API endpoint for retrieving NetBox object state

In the NetBox diode plugin, create API endpoint GET /api/plugins/diode/object-state to retrieve current state of the requested NetBox object.

We want to utilise existing NetBox core search functionality (see: https://github.com/netbox-community/netbox/blob/develop/netbox/netbox/views/misc.py#L65), so we should be able to support following query params:

• object_type (required) - only accepting one of supported object types for diode, i.e. device, site, platform, manufacturer, etc., let's start with device first
• q for arbitrary string phrase (i.e. device name, etc.), should be in use only if id param is not provided
• id object's ID (if already known by diode)

The endpoint should return single exact object state (if found) or an empty result (200 OK in both cases, unless it's a server side error then 5xx).

We should use iexact lookup type when using NetBox search functionality.

The response containing found object, should also include its latest known objectchange ID.

Response structure:

{
  "object_type": "{OBJECT_TYPE}",
  "object_change_id": {LATEST_OBJECTCHANGE_ID},
  "object": {
    {OBJECT_PROPERTIES}
  }
}

Example for dcim.site:

{
  "object_type": "dcim.site",
  "object_change_id": 4,
  "object": {
    "id": 1,
    "url": "http://localhost:8000/api/dcim/sites/1/",
    "display": "test123",
    "name": "test123",
    "slug": "test1",
    "status": {
      "value": "active",
      "label": "Active"
    },
    "region": null,
    "group": null,
    "tenant": null,
    "facility": "",
    "time_zone": null,
    "description": "",
    "physical_address": "",
    "shipping_address": "",
    "latitude": null,
    "longitude": null,
    "comments": "",
    "asns": [],
    "tags": [],
    "custom_fields": {},
    "created": "2024-02-20T14:32:32.381112Z",
    "last_updated": "2024-02-21T10:36:38.038324Z",
    "circuit_count": 0,
    "device_count": 0,
    "prefix_count": 0,
    "rack_count": 0,
    "virtualmachine_count": 0,
    "vlan_count": 0
  }
}

[mfiedorowicz]

Hey @Julio-Oliveira-Encora, to start with, could you please resolve linting issues detected by ruff and commented here https://github.com/netboxlabs/diode/pull/44/files?

Can you also add instructions how do you run these tests on local environment, i.e. add instruction in the diode-netbox-plugin/README.md?