Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
BarcoMasile opened this issue Mar 18, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@BarcoMasile
Copy link
Contributor

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"
              }
          }
      ]
    }
@BarcoMasile BarcoMasile added the enhancement New feature or request label Mar 18, 2024
Copy link

Thank you for reporting us your feedback!

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

This message was autogenerated

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant