Implement MAC settings profile CRUD API

[halimi]

Summary

References: https://github.com/TheThingsNetwork/lorawan-stack/issues/7380

This PR implements the MAC settings profile CRUD API. This is the first step (1 out of 6) of the proposed implementation plan.

Changes

• New API for MAC settings profile CRUD operation

Testing

Steps

Pre-requisite: Create an application

Tests:

• Create/Get/Update/List/Delete a MAC settings profile using the HTTP API

Results

• Create a MAC settings profile:

Request:

 POST http://localhost:1885/api/v3/ns/applications/myapp/mac_settings_profiles
> Authorization: Bearer  MFRWG.QRQCFEX537L4S3ETCM56BLPQKTT2OGOSHRHUCXI.AKJG32COZUA2VD74Z7KOQMKWJPENCDT4KIHPAWYSHHTMKYJL4OIQ
> content-type: application/json
> data
{
  "mac_settings_profile": {
    "ids": {
      "application_ids": {
        "application_id": "myapp"
      },
      "profile_id": "prof-01"
    },
    "mac_settings": {
      "resets_f_cnt": false,
      "factory_preset_frequencies": [
        1,
        2,
        3
      ]
    }
  }
}

Response:

{
  "mac_settings_profile": {
    "ids": {
      "application_ids": {
        "application_id": "myapp"
      },
      "profile_id": "prof-01"
    },
    "mac_settings": {
      "factory_preset_frequencies": [
        "1",
        "2",
        "3"
      ],
      "resets_f_cnt": false
    }
  }
}

• Get a MAC settings profile

Request:

GET http://localhost:1885/api/v3/ns/applications/myapp/mac_settings_profiles/prof-01?field_mask=ids
> Authorization: Bearer MFRWG.QRQCFEX537L4S3ETCM56BLPQKTT2OGOSHRHUCXI.AKJG32COZUA2VD74Z7KOQMKWJPENCDT4KIHPAWYSHHTMKYJL4OIQ

Response:

{
  "mac_settings_profile": {
    "ids": {
      "application_ids": {
        "application_id": "myapp"
      },
      "profile_id": "prof-01"
    }
  }
}

• Update a MAC settings profile

Request:

PUT http://localhost:1885/api/v3/ns/applications/myapp/mac_settings_profiles/prof-01
> Authorization: Bearer MFRWG.QRQCFEX537L4S3ETCM56BLPQKTT2OGOSHRHUCXI.AKJG32COZUA2VD74Z7KOQMKWJPENCDT4KIHPAWYSHHTMKYJL4OIQ
> content-type: application/json
> data
{
  "mac_settings_profile": {
    "ids": {
      "application_ids": {
        "application_id": "myapp"
      },
      "profile_id": "prof-01"
    },
    "mac_settings": {
      "resets_f_cnt": true,
      "factory_preset_frequencies": [
        1,
        2,
        3,
        4,
        5
      ]
    }
  }
}

Response:

{
  "mac_settings_profile": {
    "ids": {
      "application_ids": {
        "application_id": "myapp"
      },
      "profile_id": "prof-01"
    },
    "mac_settings": {
      "factory_preset_frequencies": [
        "1",
        "2",
        "3",
        "4",
        "5"
      ],
      "resets_f_cnt": true
    }
  }
}

• List MAC settings profiles

Request:

GET http://localhost:1885/api/v3/ns/applications/myapp/mac_settings_profiles?field_mask=ids
> Authorization: Bearer MFRWG.QRQCFEX537L4S3ETCM56BLPQKTT2OGOSHRHUCXI.AKJG32COZUA2VD74Z7KOQMKWJPENCDT4KIHPAWYSHHTMKYJL4OIQ

Response:

{
  "mac_settings_profiles": [
    {
      "ids": {
        "application_ids": {
          "application_id": "myapp"
        },
        "profile_id": "prof-01"
      }
    },
    {
      "ids": {
        "application_ids": {
          "application_id": "myapp"
        },
        "profile_id": "prof-02"
      }
    }
  ]
}

• Delete a MAC settings profile

Request:

DELETE http://localhost:1885/api/v3/ns/applications/myapp/mac_settings_profiles/prof-01
> Authorization: Bearer MFRWG.QRQCFEX537L4S3ETCM56BLPQKTT2OGOSHRHUCXI.AKJG32COZUA2VD74Z7KOQMKWJPENCDT4KIHPAWYSHHTMKYJL4OIQ

Response:

{}

Regressions

...

Notes for Reviewers

...

Checklist

• [x] Scope: The referenced issue is addressed, there are no unrelated changes.
• [x] Compatibility: The changes are backwards compatible with existing API, storage, configuration and CLI, according to the compatibility commitments in README.md for the chosen target branch.
• [ ] Documentation: Relevant documentation is added or updated.
• [x] Testing: The steps/process to test this feature are clearly explained including testing for regressions.
• [x] Infrastructure: If infrastructural changes (e.g., new RPC, configuration) are needed, a separate issue is created in the infrastructural repositories.
• [x] Changelog: Significant features, behavior changes, deprecations and fixes are added to CHANGELOG.md.
• [x] Commits: Commit messages follow guidelines in CONTRIBUTING.md, there are no fixup commits left.

[KrishnaIyer]

Should we mark this API as experimental until we complete the rest of the ToDo items this is tested with end devices?

[johanstokking]

Should we mark this API as experimental until we complete the rest of the ToDo items this is tested with end devices?

Yeah good call, let's do that.

[halimi]

Should we mark this API as experimental until we complete the rest of the ToDo items this is tested with end devices?

@KrishnaIyer Can you please help me out? What should I do to mark it as experimental? Is it just the CHANGELOG or more?

[KrishnaIyer]

1. Changelog: Add a comment (This feature is experimental and subject to change)
2. Service comment in the proto file: NsMACSettingsProfileRegistry EXPERIMENTAL: This service is subject to change.