Control Client-Organizations about apimanager-swagger-promote

[rchinthakuntla]

Chris,

I got a better idea on how to handle invalid organizations. For sure, we wan to throw error. As part of error message, can we show what the valid organizations are (both development and consumer)? Remember the startInstance script we provide in API Gateway? When I try to run it with invalid group or instance name, it errors out but provides information with the valid options. We can follow the same model here. This way, the team owing this CLI tool can correct the script and rerun it (instead of signing into Web UI and see what the valid organizations are).

Makes sense?

Thanks
Ravee

[rekies]

I really like the idea of failing and getting back the options as a result. It's a real time saver and production boost for CLI.

René

[cwiechmann]

Some questions to the team (@rchinthakuntla, @rathnapandi, @rekies):

• What should happen, if a defined Org doesn't exists?
  • Should it:
    • Just skip this org? (I do prefer this one with a dedicated return code)
    • Fail completely?
    • Should there be an option, that the Org will be created "On-Demand"?
• I plan to add an Option: "ALL" (instead of the org-name), to assign permissions to all orgs. Agree?
• Adding an option for the tool to ignore Client-Organizations definitions
  • might be useful to avoid, that an API-Developer can control directly who can consume his API.
• should the config be named: organizations, clientOrganizations or clientOrgs?

Any other thoughts on this?

Chris

[rathnapandi]

Default behavior should be fail completely. If user uses force flag, ignore the organization which does not exist on target APIM.

[rchinthakuntla]

I agree with Rathna's comments. Creating Org on-demand might not be desired because Developers often might not know which consumer organizations tend to consume the APIs they own. Failing is a better and should be the only option in my opinion because it gives the customer an opportunity to introspect and make the right fixes. Force flag should be added, only if asked by customers. End goal is to make sure the API configurations are accurate and do not have any elements like invalid organizations.

Thanks
Ravee

[cwiechmann]

Yes, makes sense and I have updated the description how I plan to implement it.

[cwiechmann]

Merge support for Organizations control into develop branch. Will be part of the next release.

[cwiechmann]

Just released version 1.3 which supports management of Client-Organizations.