Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions code/API_definitions/device-identifier.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@
post:
summary: Get a pseudonymous identifier for device being used by a given mobile subscriber
description: Get a pseudonymous identifier for device being used by a given mobile subscriber
operationId: retrievePPID

Check notice on line 285 in code/API_definitions/device-identifier.yaml

View check run for this annotation

camara-validation / CAMARA Validation

operationId must be camelCase

[S-007] Operation Id must be in Camel case "must be camel case"
tags:
- Get Device Identifiers
security:
Expand Down Expand Up @@ -330,7 +330,7 @@
description: Check if a provided device identifier matches the one the network currently associates with a given mobile subscription
operationId: matchIdentifier
tags:
- Verify Device Identifiers

Check warning on line 333 in code/API_definitions/device-identifier.yaml

View check run for this annotation

camara-validation / CAMARA Validation

Operation tag not defined in tags list

[S-222] Operation tags must be defined in global tags.
security:
- openId:
- device-identifier:match-identifier
Expand Down Expand Up @@ -755,13 +755,14 @@
CommonResponseBody:
description: |
Common parameters to be included in all responses
type: object
properties:
device:
description: The device subscription identifier that was used to identify the device whose identifier is being returned. If this property is not present, then the device subscription identifier specified in the request was used.
allOf:
- $ref: "#/components/schemas/DeviceResponse"
- example: {"phoneNumber": "+123456789"}
lastChecked:

Check warning on line 765 in code/API_definitions/device-identifier.yaml

View check run for this annotation

camara-validation / CAMARA Validation

String must declare maxLength, enum, or const

[S-312] Schema of type string must specify maxLength, enum, or const. Hint: Add maxLength, enum, or const to string properties (CAMARA Design Guide section 2.2).
description: |
Date and time that the information was last confirmed by the mobile operator to be correct. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
type: string
Expand All @@ -773,11 +774,11 @@
The individual physical mobile device identifier, as expressed by the IMEI and IMEISV
type: object
properties:
imeisv:

Check warning on line 777 in code/API_definitions/device-identifier.yaml

View check run for this annotation

camara-validation / CAMARA Validation

String must declare maxLength, enum, or const

[S-312] Schema of type string must specify maxLength, enum, or const. Hint: Add maxLength, enum, or const to string properties (CAMARA Design Guide section 2.2).

Check notice on line 777 in code/API_definitions/device-identifier.yaml

View check run for this annotation

camara-validation / CAMARA Validation

String has no format/pattern/enum

[S-313] Schema of type string should specify a format, pattern, enum, or const. Hint: Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
description: IMEISV of the device
example: "4901542032375180"
imei:

Check warning on line 781 in code/API_definitions/device-identifier.yaml

View check run for this annotation

camara-validation / CAMARA Validation

String must declare maxLength, enum, or const

[S-312] Schema of type string must specify maxLength, enum, or const. Hint: Add maxLength, enum, or const to string properties (CAMARA Design Guide section 2.2).

Check notice on line 781 in code/API_definitions/device-identifier.yaml

View check run for this annotation

camara-validation / CAMARA Validation

String has no format/pattern/enum

[S-313] Schema of type string should specify a format, pattern, enum, or const. Hint: Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
description: IMEI of the device
example: "490154203237518"
Expand All @@ -787,25 +788,25 @@
The physical device type, as expressed by Type Approval Code, manufacturer name and model name
type: object
properties:
tac:

Check warning on line 791 in code/API_definitions/device-identifier.yaml

View check run for this annotation

camara-validation / CAMARA Validation

String must declare maxLength, enum, or const

[S-312] Schema of type string must specify maxLength, enum, or const. Hint: Add maxLength, enum, or const to string properties (CAMARA Design Guide section 2.2).

Check notice on line 791 in code/API_definitions/device-identifier.yaml

View check run for this annotation

camara-validation / CAMARA Validation

String has no format/pattern/enum

[S-313] Schema of type string should specify a format, pattern, enum, or const. Hint: Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
description: IMEI TAC of the device
example: "49015420"
model:

Check warning on line 795 in code/API_definitions/device-identifier.yaml

View check run for this annotation

camara-validation / CAMARA Validation

String must declare maxLength, enum, or const

[S-312] Schema of type string must specify maxLength, enum, or const. Hint: Add maxLength, enum, or const to string properties (CAMARA Design Guide section 2.2).

Check notice on line 795 in code/API_definitions/device-identifier.yaml

View check run for this annotation

camara-validation / CAMARA Validation

String has no format/pattern/enum

[S-313] Schema of type string should specify a format, pattern, enum, or const. Hint: Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
description: Model of the device
example: "3110"
manufacturer:

Check warning on line 799 in code/API_definitions/device-identifier.yaml

View check run for this annotation

camara-validation / CAMARA Validation

String must declare maxLength, enum, or const

[S-312] Schema of type string must specify maxLength, enum, or const. Hint: Add maxLength, enum, or const to string properties (CAMARA Design Guide section 2.2).

Check notice on line 799 in code/API_definitions/device-identifier.yaml

View check run for this annotation

camara-validation / CAMARA Validation

String has no format/pattern/enum

[S-313] Schema of type string should specify a format, pattern, enum, or const. Hint: Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
description: Manufacturer of the device
example: "Nokia"

DevicePPID:

Check warning on line 804 in code/API_definitions/device-identifier.yaml

View check run for this annotation

camara-validation / CAMARA Validation

Schema name must be PascalCase

[S-015] DevicePPID should be PascalCase (UpperCamelCase)
description: |
The individual physical mobile device identifier, expressed as a PPID (Pairwise Pseudonymous Identifier)
type: object
properties:
ppid:

Check warning on line 809 in code/API_definitions/device-identifier.yaml

View check run for this annotation

camara-validation / CAMARA Validation

String must declare maxLength, enum, or const

[S-312] Schema of type string must specify maxLength, enum, or const. Hint: Add maxLength, enum, or const to string properties (CAMARA Design Guide section 2.2).

Check notice on line 809 in code/API_definitions/device-identifier.yaml

View check run for this annotation

camara-validation / CAMARA Validation

String has no format/pattern/enum

[S-313] Schema of type string should specify a format, pattern, enum, or const. Hint: Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
description: A PPID for the identified physical device
example: "b083f65ccdad365d7489fff24b6d5074b30c12b6d81db3404d25964ffd908813"
Expand Down Expand Up @@ -868,35 +869,35 @@
"publicPort": 59765
}

ErrorInfo:

Check warning on line 872 in code/API_definitions/device-identifier.yaml

View check run for this annotation

camara-validation / CAMARA Validation

Schema property must have a description

[S-011] Property description is missing or empty: "ErrorInfo.description" property must be truthy
type: object
required:
- status
- code
- message
properties:
status:

Check warning on line 879 in code/API_definitions/device-identifier.yaml

View check run for this annotation

camara-validation / CAMARA Validation

Integer must declare int32 or int64 format

[S-310] Schema of type integer must specify format (int32 or int64). Hint: Add format: int32 or int64 to integer properties (CAMARA Design Guide section 2.2).

Check warning on line 879 in code/API_definitions/device-identifier.yaml

View check run for this annotation

camara-validation / CAMARA Validation

Integer must declare minimum and maximum

[S-311] Schema of type integer must specify minimum and maximum. Hint: Add minimum and maximum to integer properties (CAMARA Design Guide section 2.2).
type: integer
description: HTTP response status code
code:

Check warning on line 882 in code/API_definitions/device-identifier.yaml

View check run for this annotation

camara-validation / CAMARA Validation

String must declare maxLength, enum, or const

[S-312] Schema of type string must specify maxLength, enum, or const. Hint: Add maxLength, enum, or const to string properties (CAMARA Design Guide section 2.2).
type: string
description: A human-readable code to describe the error
message:

Check warning on line 885 in code/API_definitions/device-identifier.yaml

View check run for this annotation

camara-validation / CAMARA Validation

String must declare maxLength, enum, or const

[S-312] Schema of type string must specify maxLength, enum, or const. Hint: Add maxLength, enum, or const to string properties (CAMARA Design Guide section 2.2).
type: string
description: A human-readable description of what the event represents

NetworkAccessIdentifier:

Check warning on line 889 in code/API_definitions/device-identifier.yaml

View check run for this annotation

camara-validation / CAMARA Validation

String must declare maxLength, enum, or const

[S-312] Schema of type string must specify maxLength, enum, or const. Hint: Add maxLength, enum, or const to string properties (CAMARA Design Guide section 2.2).
description: A public identifier addressing a subscription in a mobile network. In 3GPP terminology, it corresponds to the GPSI formatted with the External Identifier ({Local Identifier}@{Domain Identifier}). Unlike the telephone number, the network access identifier is not subjected to portability ruling in force, and is individually managed by each operator.
type: string
example: "123456789@example.com"

PhoneNumber:

Check warning on line 894 in code/API_definitions/device-identifier.yaml

View check run for this annotation

camara-validation / CAMARA Validation

String must declare maxLength, enum, or const

[S-312] Schema of type string must specify maxLength, enum, or const. Hint: Add maxLength, enum, or const to string properties (CAMARA Design Guide section 2.2).
description: A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Number). In order to be globally unique it has to be formatted in international format, according to E.164 standard, prefixed with '+'.
type: string
pattern: '^\+[1-9][0-9]{4,14}$'
example: "+123456789"

Port:

Check warning on line 900 in code/API_definitions/device-identifier.yaml

View check run for this annotation

camara-validation / CAMARA Validation

Integer must declare int32 or int64 format

[S-310] Schema of type integer must specify format (int32 or int64). Hint: Add format: int32 or int64 to integer properties (CAMARA Design Guide section 2.2).
description: TCP or UDP port number
type: integer
minimum: 0
Expand All @@ -909,20 +910,20 @@
device:
$ref: "#/components/schemas/Device"

SingleIpv4Addr:

Check warning on line 913 in code/API_definitions/device-identifier.yaml

View check run for this annotation

camara-validation / CAMARA Validation

String must declare maxLength, enum, or const

[S-312] Schema of type string must specify maxLength, enum, or const. Hint: Add maxLength, enum, or const to string properties (CAMARA Design Guide section 2.2).
description: A single IPv4 address with no subnet mask
type: string
format: ipv4
example: "84.125.93.10"

DeviceIpv6Address:

Check warning on line 919 in code/API_definitions/device-identifier.yaml

View check run for this annotation

camara-validation / CAMARA Validation

String must declare maxLength, enum, or const

[S-312] Schema of type string must specify maxLength, enum, or const. Hint: Add maxLength, enum, or const to string properties (CAMARA Design Guide section 2.2).
description: |
The device should be identified by the observed IPv6 address, or by any single IPv6 address from within the subnet allocated to the device (e.g. adding ::0 to the /64 prefix).
type: string
format: ipv6
example: 2001:db8:85a3:8d3:1319:8a2e:370:7344

XCorrelator:

Check warning on line 926 in code/API_definitions/device-identifier.yaml

View check run for this annotation

camara-validation / CAMARA Validation

Schema property must have a description

[S-011] Property description is missing or empty: "XCorrelator.description" property must be truthy

Check warning on line 926 in code/API_definitions/device-identifier.yaml

View check run for this annotation

camara-validation / CAMARA Validation

String must declare maxLength, enum, or const

[S-312] Schema of type string must specify maxLength, enum, or const. Hint: Add maxLength, enum, or const to string properties (CAMARA Design Guide section 2.2).
type: string
pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
Expand All @@ -938,7 +939,7 @@
properties:
providedIdentifierType:
$ref: "#/components/schemas/ProvidedIdentifierType"
providedIdentifier:

Check notice on line 942 in code/API_definitions/device-identifier.yaml

View check run for this annotation

camara-validation / CAMARA Validation

String has no format/pattern/enum

[S-313] Schema of type string should specify a format, pattern, enum, or const. Hint: Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
minLength: 8
maxLength: 16
Expand Down
6 changes: 6 additions & 0 deletions code/common/.sync-manifest.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
sources:
- repository: Commonalities
release: r4.2
files:
CAMARA_common.yaml: f5122885eab0d3bc7424cf26e2087d4d02c9b96d
CAMARA_event_common.yaml: 9d74ec530af38045dc3d02772407a1d2d4f2f746
Loading