mirror of
https://github.com/zitadel/zitadel.git
synced 2025-08-11 16:47:32 +00:00
docs(API_DESIGN.md): adding guidlines around API returns when multiple resources created (#9797)
# Which Problems Are Solved Updating API_Design.md to include guidelines to specify all created resources created from an API call # How the Problems Are Solved This makes things clearer to the user if everything requested was actually created and helps with testing. See https://github.com/zitadel/zitadel/pull/9352 # Additional Context - Related https://github.com/zitadel/zitadel/issues/6305 - Related https://github.com/zitadel/zitadel/pull/9352 --------- Co-authored-by: Livio Spring <livio.a@gmail.com>
This commit is contained in:
@@ -56,6 +56,10 @@ Provide clear and concise documentation for the API.
|
||||
Do not rely on implicit fallbacks or defaults if the client does not provide certain parameters.
|
||||
Only use defaults if they are explicitly documented, such as returning a result set for the whole instance if no filter is provided.
|
||||
|
||||
Some API calls may create multiple resources such as in the case of `zitadel.org.v2.AddOrganization`, where you can create an organization AND multiple users as admin.
|
||||
In such cases the response should include **ALL** created resources and their ids. This removes any ambiguity from the users perspective whether or not
|
||||
the additional resources were created and it also helps in testing.
|
||||
|
||||
### Naming Conventions
|
||||
|
||||
Names of resources, fields and methods MUST be descriptive and consistent.
|
||||
|
Reference in New Issue
Block a user