Adjust endpoints request payload and responses according to current OpenAPI spec. - Githubissues

canonical / identity-platform-admin-ui

Admin UI for the Canonical identity broker and identity provider solution

Other

5 stars 4 forks source link

Adjust endpoints request payload and responses according to current OpenAPI spec. #225

Open BarcoMasile opened 4 months ago

BarcoMasile commented 4 months ago

Description

We need to edit current endpoints request payloads and responses to match the currect OpenAPI spec (repo) as of March 18th 2024.

Endpoints changes

remove entitlements endpoints with DELETE /.../{e_id} where e_id is the entitlement ID
remove all DELETE operations that perform the removal entities added with PATCH operations (so basically merge PATCH and cooresponding DELETE operations)

Response payload changes

all detail endpoints now return the single entity that has been queried
all POST endpoints now return the single created entity
all PUT endpoints now return the single updated entity

Request payload changes

All PATCH endpoints must handle the following formats, examples:
- PATCH /identity/{id}/groups
- PATCH /identity/{id}/roles
- PATCH /identity/{id}/entitlements
- ...
```
{
"patches": [
{
    "op": "add",
    "group": "group-A",
}
]
}
```
{ "patches": [ { "op": "remove", "role": "role-A", } ] }

{ "patches": [ { "op": "add", "entitlement": { "entity_type": "entity-type", "entity_name": "entity-name", "entitlement_type": "entitlement-type" } } ] }

syncronize-issues-to-jira[bot] commented 4 months ago

Thank you for reporting us your feedback!

The internal ticket has been created: https://warthogs.atlassian.net/browse/IAM-759.

This message was autogenerated