Skip to content

Use int32-range bounds for arrays and device counters (#145) #196

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

Open
jimfengjinhua wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Use int32-range bounds for arrays and device counters (#145) #196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 13 additions & 9 deletions code/API_definitions/dedicated-network-accesses.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@
- name: name
in: query
description: name of an access
schema:

Check notice on line 190 in code/API_definitions/dedicated-network-accesses.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

String has no format/pattern/enum 

[S-313] Schema of type string should specify a format, pattern, enum, or const. | Suggestion: Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
maxLength: 1024
- $ref: "../common/CAMARA_common.yaml#/components/parameters/x-correlator"
Expand Down Expand Up @@ -737,11 +737,11 @@
- code
- message
properties:
code:

Check notice on line 740 in code/API_definitions/dedicated-network-accesses.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

String has no format/pattern/enum 

[S-313] Schema of type string should specify a format, pattern, enum, or const. | Suggestion: Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
maxLength: 96
description: A human-readable code to describe the reason
message:

Check notice on line 744 in code/API_definitions/dedicated-network-accesses.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

String has no format/pattern/enum 

[S-313] Schema of type string should specify a format, pattern, enum, or const. | Suggestion: Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
maxLength: 4096
description: A human-readable description of what the reason represents
Expand Down Expand Up @@ -773,15 +773,19 @@
- pagination
properties:
items:
$ref: "#/components/schemas/AccessDevices"
description: A list of access devices
allOf:
- $ref: "#/components/schemas/AccessDevices"
- minItems: 0
- maxItems: 100
pagination:
$ref: "../common/CAMARA_common.yaml#/components/schemas/Pagination"

AccessDevices:
description: A list of access devices
type: array
minItems: 0
maxItems: 9007199254740991
maxItems: 2147483647
items:
$ref: "#/components/schemas/AccessDevice"

Expand Down Expand Up @@ -833,7 +837,7 @@
description: Common attributes of an access to a dedicated network
type: object
properties:
name:

Check notice on line 840 in code/API_definitions/dedicated-network-accesses.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

String has no format/pattern/enum 

[S-313] Schema of type string should specify a format, pattern, enum, or const. | Suggestion: Acceptable if free-form field or implementation-dependent — no fix needed.
description: A human-readable name to describe the access
type: string
minLength: 1
Expand Down Expand Up @@ -897,21 +901,21 @@
totalDevices:
description: the total number of devices included in the access (regardless of status)
type: integer
format: int64
format: int32
minimum: 0
maximum: 9007199254740991
maximum: 2147483647
totalGranted:
description: the total number of devices included in the access with status GRANTED
type: integer
format: int64
format: int32
minimum: 0
maximum: 9007199254740991
maximum: 2147483647
totalDenied:
description: the total number of devices included in the access with status DENIED
type: integer
format: int64
format: int32
minimum: 0
maximum: 9007199254740991
maximum: 2147483647
required:
- totalDevices
- totalGranted
Expand Down Expand Up @@ -1170,7 +1174,7 @@
Devices:
description: A list of devices
type: array
maxItems: 9007199254740991
maxItems: 2147483647
items:
$ref: "../common/CAMARA_common.yaml#/components/schemas/Device"

Expand Down
4 changes: 2 additions & 2 deletions code/API_definitions/dedicated-network-profiles.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@
- name: name
in: query
description: Only network profiles with this name are to be returned
schema:

Check notice on line 111 in code/API_definitions/dedicated-network-profiles.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

String has no format/pattern/enum 

[S-313] Schema of type string should specify a format, pattern, enum, or const. | Suggestion: Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
maxLength: 1024
- $ref: "../common/CAMARA_common.yaml#/components/parameters/x-correlator"
Expand Down Expand Up @@ -208,7 +208,7 @@
properties:
id:
$ref: '#/components/schemas/NetworkProfileId'
name:

Check notice on line 211 in code/API_definitions/dedicated-network-profiles.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

String has no format/pattern/enum 

[S-313] Schema of type string should specify a format, pattern, enum, or const. | Suggestion: Acceptable if free-form field or implementation-dependent — no fix needed.
description: A human-readable name to describe the network profile
type: string
minLength: 1
Expand All @@ -217,9 +217,9 @@
description: The maximum number of devices that can simultaneously use and share the dedicated network under this profile up to the limits set by the profile's performance characteristics
type: integer
example: 5
format: int64
format: int32
minimum: 1
maximum: 9007199254740991
maximum: 2147483647
aggregatedUlThroughput:
$ref: "#/components/schemas/BitRate"
aggregatedDlThroughput:
Expand Down
Loading