Description
Hi Team,
As explained in [1], when invoking the Publisher REST API Retrieve/Search APIs [2], the additionalProperties and additionalPropertiesMap fields are returned as empty even when the API contains additional properties.
The internal discussion concluded with keeping the fields in the response without improving the result set or removing the properties from the payload.
However, returning empty fields can be misleading to users. Therefore, shall we at least add a note in the documentation clarifying that these fields are intentionally left empty to reduce the payload size, and that users should use the individual API retrieval endpoint if they need the additional properties for a specific API?
Additionally, the current documentation examples still show populated additional properties. Those examples should also be updated accordingly.
[1] https://github.com/wso2-enterprise/wso2-apim-internal/issues/16796
[2] https://apim.docs.wso2.com/en/4.6.0/reference/product-apis/publisher-apis/publisher-v4/publisher-v4/#tag/APIs/operation/getAllAPIs
Thanks
Methma
Steps to Reproduce
N/A
Version
apim-4.6.0
Environment Details (with versions)
No response
Description
Hi Team,
As explained in [1], when invoking the Publisher REST API Retrieve/Search APIs [2], the additionalProperties and additionalPropertiesMap fields are returned as empty even when the API contains additional properties.
The internal discussion concluded with keeping the fields in the response without improving the result set or removing the properties from the payload.
However, returning empty fields can be misleading to users. Therefore, shall we at least add a note in the documentation clarifying that these fields are intentionally left empty to reduce the payload size, and that users should use the individual API retrieval endpoint if they need the additional properties for a specific API?
Additionally, the current documentation examples still show populated additional properties. Those examples should also be updated accordingly.
[1] https://github.com/wso2-enterprise/wso2-apim-internal/issues/16796
[2] https://apim.docs.wso2.com/en/4.6.0/reference/product-apis/publisher-apis/publisher-v4/publisher-v4/#tag/APIs/operation/getAllAPIs
Thanks
Methma
Steps to Reproduce
N/A
Version
apim-4.6.0
Environment Details (with versions)
No response