wso2 / wso2/docs-apim

Additional Properties & Additional Properties Map empty in Retrieve/Search APIs Publisher REST API

Open Beginner friendly
#11,405 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type/Bug
Dominant language
CSS
Stars
99
Forks
708
Avg merge
1d 7h
Merged PRs (30d)
22

Description

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

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Publisher REST API documentation linked in the issue, especially the APIs Retrieve/Search endpoint and its examples. Update the documentation to explain why additionalProperties and additionalPropertiesMap are empty in these responses, point readers to individual API retrieval for those properties, and revise examples that currently show populated fields.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.