Initial contribution of API spec location.yaml v0.1.0#3
Merged
shilpa-padgaonkar merged 2 commits intocamaraproject:mainfrom Nov 18, 2022
Merged
Conversation
jlurien
requested changes
Oct 27, 2022
Collaborator
jlurien
left a comment
There was a problem hiding this comment.
From Telefónica, after review with our Product and Network Engineering teams, there are several changes we'd like to promote in this API:
- POST /verify:
- Input:
- Additionally to coordinates, we see a use case for providing a postcode, so API would support oneOf [Coordinates, Postcode].
- To identify the device we think that we have to move from the current ueId object to a more convenient identifier, to avoid ambiguity in how the mobile connectivity of the device is to be identified, and to deal properly with sensible information. The proposal for this is being discussed within Commonalities, as it is transversal to almost every API: WorkingGroups Issue #101
- Output:
- We identify several possibilities when comparing the provided location with the network location, which cannot properly be covered by a single boolean. We propose a richer response:
- Input:
VerifyLocationResponse:
type: object
required:
- verification_result
properties:
verification_result:
$ref: '#/components/schemas/VerificationResult'
success_rate:
$ref: '#/components/schemas/SuccessRate'
VerificationResult:
description: |-
Verification request result:
* `match` when the Network locates the device within the requested area
* `not_match` when the requested area completely differs from the area where the Network locates the device
* `partial_match` when the requested area is partially included in the area where the Network locates the device but not entirely. In this case `success_rate` must be included in the response
* `undetermined` when the area included in the request body is smaller than the network capacities to locate the device.
type: string
enum:
- match
- not_match
- partial_match
- undetermined
SuccessRate:
description: SuccessRate estimated for location verification in percent
type: number
minimum: 0
maximum: 100
example: 74
- securitySchemes:
- Only three_legged should be considered, requiring user authentication and consent gathering
We will launch a separated PR with a new proposal incorporating all these comments.
jlurien
reviewed
Nov 10, 2022
Collaborator
There was a problem hiding this comment.
@shilpa-padgaonkar To move this API forward, I suggest to merge this initial version as v0.1.0, and start a new dev branch to make contributions for v0.2.0. We can then move our comments there.
jlurien
reviewed
Nov 10, 2022
Collaborator
jlurien
left a comment
There was a problem hiding this comment.
Change name more specifically to "Device Location Verification"
| - BasicAuth: [] | ||
| - apiKey: [] | ||
| - three_legged: | ||
| - device-location-read |
Collaborator
There was a problem hiding this comment.
Suggested change
| - device-location-read | |
| - device-location-verification-verify-read |
| default: http://localhost:9091 | ||
| description: API root | ||
| basePath: | ||
| default: location/v0 |
Collaborator
There was a problem hiding this comment.
Suggested change
| default: location/v0 | |
| default: device-location-verification/v0 |
| description: API root | ||
| basePath: | ||
| default: location/v0 | ||
| description: Base path for the device location API |
Collaborator
There was a problem hiding this comment.
Suggested change
| description: Base path for the device location API | |
| description: Base path for the device location verification API |
| @@ -0,0 +1,253 @@ | |||
| openapi: 3.0.3 | |||
| info: | |||
| title: Device location API | |||
Collaborator
There was a problem hiding this comment.
Suggested change
| title: Device location API | |
| title: Device Location Verification API |
jlurien
approved these changes
Nov 16, 2022
Commenting out apikey basic auth security schemes to stay compliant with the approved authN-authZ concept in commonalities
Collaborator
|
As agreed, merging the pull request so that we can have a base version. New issues should be created to bring in further improvements in the spec. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Initial contribution of the API spec location.yaml with the version 0.1.0. #4
The API enables to verify the current position of the UE against given coordinates and accuracy.