generated from camaraproject/Template_API_Repository
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: remove models not currently in use
- Loading branch information
1 parent
6b15206
commit b21c691
Showing
1 changed file
with
0 additions
and
98 deletions.
There are no files selected for viewing
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -1369,19 +1369,6 @@ components: | |
| description: ID of the reboot request to find | ||
|
|
||
| schemas: | ||
| TimePeriod: | ||
| properties: | ||
| startDate: | ||
| type: string | ||
| format: date-time | ||
| description: An instant of time, starting of the TimePeriod. | ||
| endDate: | ||
| type: string | ||
| format: date-time | ||
| description: An instant of time, ending of the TimePeriod. If not included, then the period has no ending date. | ||
| required: | ||
| - startDate | ||
|
|
||
| ErrorInfo: | ||
| type: object | ||
| required: | ||
|
|
@@ -1399,91 +1386,6 @@ components: | |
| type: string | ||
| description: Friendly Code to describe the error | ||
|
|
||
| TODODevice: | ||
| description: | | ||
| End-user equipment able to connect to a mobile network. Examples of devices include smartphones or IoT sensors/actuators. | ||
| The developer can choose to provide the below specified device identifiers: | ||
| * `ipv4Address` | ||
| * `ipv6Address` | ||
| * `phoneNumber` | ||
| * `networkAccessIdentifier` | ||
| NOTE1: the network operator might support only a subset of these options. The API invoker can provide multiple identifiers to be compatible across different network operators. In this case the identifiers MUST belong to the same device. | ||
| NOTE2: for the Commonalities release v0.4, we are enforcing that the networkAccessIdentifier is only part of the schema for future-proofing, and CAMARA does not currently allow its use. After the CAMARA meta-release work is concluded and the relevant issues are resolved, its use will need to be explicitly documented in the guidelines. | ||
| type: object | ||
| properties: | ||
| phoneNumber: | ||
| $ref: "#/components/schemas/PhoneNumber" | ||
| networkAccessIdentifier: | ||
| $ref: "#/components/schemas/NetworkAccessIdentifier" | ||
| ipv4Address: | ||
| $ref: "#/components/schemas/DeviceIpv4Addr" | ||
| ipv6Address: | ||
| $ref: "#/components/schemas/DeviceIpv6Address" | ||
| minProperties: 1 | ||
|
|
||
| PhoneNumber: | ||
| 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" | ||
|
|
||
| NetworkAccessIdentifier: | ||
| 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: "[email protected]" | ||
|
|
||
| DeviceIpv4Addr: | ||
| type: object | ||
| description: | | ||
| The device should be identified by either the public (observed) IP address and port as seen by the application server, or the private (local) and any public (observed) IP addresses in use by the device (this information can be obtained by various means, for example from some DNS servers). | ||
| If the allocated and observed IP addresses are the same (i.e. NAT is not in use) then the same address should be specified for both publicAddress and privateAddress. | ||
| If NAT64 is in use, the device should be identified by its publicAddress and publicPort, or separately by its allocated IPv6 address (field ipv6Address of the Device object) | ||
| In all cases, publicAddress must be specified, along with at least one of either privateAddress or publicPort, dependent upon which is known. In general, mobile devices cannot be identified by their public IPv4 address alone. | ||
| properties: | ||
| publicAddress: | ||
| $ref: "#/components/schemas/SingleIpv4Addr" | ||
| privateAddress: | ||
| $ref: "#/components/schemas/SingleIpv4Addr" | ||
| publicPort: | ||
| $ref: "#/components/schemas/Port" | ||
| anyOf: | ||
| - required: [publicAddress, privateAddress] | ||
| - required: [publicAddress, publicPort] | ||
| example: | ||
| publicAddress: "84.125.93.10" | ||
| publicPort: 59765 | ||
|
|
||
| SingleIpv4Addr: | ||
| description: A single IPv4 address with no subnet mask | ||
| type: string | ||
| format: ipv4 | ||
| example: "84.125.93.10" | ||
|
|
||
| Port: | ||
| description: TCP or UDP port number | ||
| type: integer | ||
| minimum: 0 | ||
| maximum: 65535 | ||
|
|
||
| DeviceIpv6Address: | ||
| 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 | ||
|
|
||
| DateTime: | ||
| type: string | ||
| format: date-time | ||
| description: | | ||
| It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone. | ||
| Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows 2023-07-03T14:27:08.312+02:00 or | ||
| 2023-07-03T12:27:08.312Z) | ||
| example: &date-time "2023-07-03T14:27:08.312+02:00" | ||
|
|
||
| ServiceSiteId: | ||
| type: string | ||
| minLength: 1 | ||
|
|
||