INT-46: ipam.Address.type is now ipam.Address.status

[rupa]

The "type" field of ipam.Address has been renamed to "status" in
the API as of v2.2. Additionally, the "assignment" value becomes
"assigned".

For those using IPAM functionality, there are some minor but
potentially breaking changes:

v2.1 users:

• please continue to use v0.13.0 of the SDK

v2.2 users with existing code for IPAM:

• NS1 class:
  • createAddress method: the "type" arg is now "status"
  • loadAddressByPrefix method: the "type" arg is now "status"
• ipam.Address:
  • "type" kwarg to init is now "status"
  • "type" attr is now "status" attr
• ipam.Network:
  • new_address method: "type" arg is now "status"
• Valid values for "status" (née "type") have changed:
  • previously: ["planned", "assignment", "host"]
  • now: ["planned", "assigned", "host"]

[jwilner]

LGTM / can't wait for codegen

[mburtless]

LGTM 🌭

[mburtless]

I am confused about this though:

Valid values for "status" (née "type") have changed:

previously: ["planned", "assignment", "host"]
now: ["planned", "assigned", "host"]

But it looks like all references to the host value have been removed from status param docstrings? Is that because they are not allowed to be set to host via the API?

[rupa]

I am confused about this though:

Valid values for "status" (née "type") have changed:
previously: ["planned", "assignment", "host"]
now: ["planned", "assigned", "host"]

But it looks like all references to the host value have been removed from status param docstrings? Is that because they are not allowed to be set to host via the API?

yeah that's my understanding - whether it's a "host" or not is derived within the API so status will never be that value, nor should it be set to that value. (I did a rebase and forcepush so the actual commit message reflects this, but the PR message doesn't get updated on forcepush)