400 on IpamPrefixesBulkUpdate, ID Required

[maksim-kuvshinov-oxa]

Netbox: v4.2.4
go-netbox: v4.2.2-3

netboxAPIKey := os.Getenv("NETBOX_API_KEY")
netboxURI := os.Getenv("NETBOX_URI")

if netboxAPIKey == "" || netboxURI == "" {
	log.Fatal("NETBOX_API_KEY or NETBOX_URI environment variable is not set")
}

prefixes := []netbox.PrefixRequest{
	{Prefix: "10.10.10.0/24"},
	{Prefix: "10.10.11.0/24"},
}

client := netbox.NewAPIClientFor(netboxURI, netboxAPIKey)
_, resp, err := client.IpamAPI.IpamPrefixesBulkUpdate(context.Background()).PrefixRequest(prefixes).Execute()

if err != nil {
	log.Printf("Error: %v", err)
}

if resp.StatusCode >= http.StatusBadRequest {
	body, _ := io.ReadAll(resp.Body)
	log.Printf("HTTP Error: Status Code=%d, Body=%s", resp.StatusCode, body)
}

Output:
HTTP Error: Status Code=400, Body=[{"id":["This field is required."]},{"id":["This field is required."]}]

I believe this endpoint shouldn't require IDs defined?

[nutgood]

Well, the endpoint does require them defined. You can set the property like this:

prefixes[0].AdditionalProperties["id"] = id

[maksim-kuvshinov-oxa]

I thought this endpoint was for creating new prefixes in bulk, and for updating existing ones there's IpamPrefixesBulkPartialUpdate.

Surely, users don't need to manage generation of IDs on their end, so I presume there might be some kind of confusion in regards to purposes of these two endpoints I mentioned. Or those IDs are only for the client-side of the request and have nothing to do with IDs on server-side?

When I try assigning an additional property as suggested I get
panic: assignment to entry in nil map

[nutgood]

It doesn't look like netbox API let's you bulk-create IPAM prefixes.

IpamPrefixesBulkUpdate looks like it hits the PUT api endpoint
IpamPrefixesBulkPartialUpdate looks like it hits the PATCH api endpoint

Looking at the OpenAPI spec (remember, this is a 100% generated SDK):

post:
  operationId: ipam_prefixes_create
  description: Post a list of prefix objects.
  tags:
  - ipam
  requestBody:
    content:
      application/json:
        schema:
          $ref: '#/components/schemas/WritablePrefixRequest' # Accepts one prefix
put:
  operationId: ipam_prefixes_bulk_update
  description: Put a list of prefix objects.
  tags:
  - ipam
  requestBody:
    content:
      application/json:
        schema:
          type: array
          items:
            $ref: '#/components/schemas/PrefixRequest' # Accepts a list of prefix
patch:
  operationId: ipam_prefixes_bulk_partial_update
  description: Patch a list of prefix objects.
  tags:
  - ipam
  requestBody:
    content:
      application/json:
        schema:
          type: array
          items:
            $ref: '#/components/schemas/PrefixRequest' # Accepts a list of prefix

Looking at the PrefixRequest component in the schema, it indeed doesn't require the id field to be set but yet your netbox instance asks you to please set it. Maybe this is an upstream bug ?