Editing Module:Sensitive IP addresses/API/doc (section)

=== Entity objects ===

An entity object represents a country or organization that has IP ranges which Wikipedia considers sensitive. Entity objects may contain the following fields:
* <code>id</code> - the entity ID. This is a unique string used to identify the entity. This field is always present.
* <code>name</code> - the name of the entity. This is a plain string, containing no wikitext, and is always present.
* <code>description</code> - a description of the entity. This is a string, and may contain wikitext. This field is optional, and may not be present.
* <code>reason</code> - the reason that the entity's IP ranges are sensitive. The possible reasons are <code>{{#invoke:Sensitive IP addresses/API|_getSensitivityReasons|</code>, <code>|</code> and <code>}}</code>.
* <code>ipv4-ranges</code> - an array of IPv4 CIDR strings that belong to the entity, and are considered as sensitive by Wikipedia. This field is optional, and may not be present.
* <code>ipv6-ranges</code> - an array of IPv6 CIDR strings that belong to the entity, and are considered as sensitive by Wikipedia. This field is optional, and may not be present.
* <code>notes</code> - notes about the entity or its ranges. This field is optional, and may not be present.