Skip to content

Change configuration group operations URL to some more meaninfull #752

@fgalan

Description

@fgalan

IOTAs implements a concept named "configuration group" but, unfortunatelly, the API operations to manage them are using "service" literal in the URL

  • POST /iot/services -> create a new configuration group
  • GET /iot/services -> get configuration group
  • etc.

This is very confusing, as service is another concept used for authorization, used in fiware-service header.

Thus, URL should be changed to something different and close to "configuration group" term, for instance:

  • POST /iot/configurations -> create a new configuration group
  • GET /iot/confgurations -> get configuration group
  • etc.

(Not sure if "configurations" is the best one, maybe there are shorter alternatives, e.g. "groups", "cgroups", etc.)

Some additional comments:

  • The changes should be backward compatible. I mean, although we change the URLs in code an documentation the old ones will be still valid.
  • The changes will be done in the unit tests, but some tests should be added using the old URLs to ensure backward compatibility is not broken (a subset of the old ones)

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions