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.

Sign up for GitHub

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

Jump to bottom

Update CAMARA Mobile Device Identifier API.yaml #55

Merged
merged 6 commits into from
Mar 13, 2024
Merged

Update CAMARA Mobile Device Identifier API.yaml #55

merged 6 commits into from
Mar 13, 2024

Conversation

eric-murray
Copy link
Collaborator

What type of PR is this?

Add one of the following kinds:

  • enhancement/feature

What this PR does / why we need it:

  • Separates API into two endpoints:
    • retrieve-identifier to obtain individual device details
    • retrieve-type to obtain type of device
  • Add scopes for each endpoint
  • Add lastChecked field to indicate when information about device was last confirmed correct

Which issue(s) this PR fixes:

Fixes #47, Fixes #30

Special notes for reviewers:

None

Changelog input

 release-note
 - Separates API into two endpoints:
   - `retrieve-identifier` to obtain individual device details
   - `retrieve-type` to obtain type of device
 - Add scopes for each endpoint
 - Add `lastChecked` field to indicate when information about device was last confirmed correct

Additional documentation

N/A

Kevsy
Kevsy reviewed Feb 23, 2024
View reviewed changes
code/API_definitions/CAMARA Mobile Device Identifier API.yaml Outdated
The API defines a single service endpoint `POST /get-device-identifier`. To call this endpoint, the API consumer must first obtain a valid OAuth2 token from the token endpoint, which is then passed as an Authorization header. The API consumer must also pass at least one of the available mobile subscription identifiers in the body of the request.
The API defines two service endpoints:

- `POST /get-identifier` to get details about the specific device being used by a given mobile subscriber, including IMEI / IMEISV and the type of device
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/get-identifier-> /retrieve-identifier

Kevsy
Kevsy reviewed Feb 23, 2024
View reviewed changes
code/API_definitions/CAMARA Mobile Device Identifier API.yaml Outdated
The API defines two service endpoints:

- `POST /get-identifier` to get details about the specific device being used by a given mobile subscriber, including IMEI / IMEISV and the type of device
- `POST /get-type` to get details only about the type of device being used by a given mobile subscriber
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/get-type -> /retrieve-type

Kevsy
Kevsy requested changes Feb 23, 2024
View reviewed changes
Copy link
Collaborator

@Kevsy Kevsy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two path corrections (see comments) - otherwise a minor comment that 'type' should be explained as meaning 'manufacturer and model' to avoid ambiguity.

@eric-murray
Copy link
Collaborator Author

Thanks @Kevsy. Updated.

I also added the text explaining that the phoneNumber will be treated as the secondary MSISDN for scenarios where the primary MSISDN is shared between multiple devices.

@Kevsy Kevsy merged commit d41dea9 into camaraproject:main Mar 13, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Kevsy Kevsy Kevsy approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add ageOfInformation field to API response Security Schemes and Scopes for Device Identifier API
2 participants
@eric-murray @Kevsy