Skip to content

Correct externalDocs.description wording in qos-booking.yaml #118

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

Merged
hdamker merged 1 commit into from
Aug 7, 2026
Merged

Correct externalDocs.description wording in qos-booking.yaml #118

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
2 changes: 1 addition & 1 deletion code/API_definitions/qos-booking.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@
x-camara-commonalities: 0.8.0

externalDocs:
description: Project documentation at CAMARA
description: Product documentation at CAMARA
url: https://github.com/camaraproject/QoSBooking

servers:
Expand Down Expand Up @@ -683,7 +683,7 @@
required:
- areaName
properties:
areaName:

Check notice on line 686 in code/API_definitions/qos-booking.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: 256

Expand All @@ -693,10 +693,10 @@
Point:
$ref: '../common/CAMARA_common.yaml#/components/schemas/Point'

Latitude:

Check warning on line 696 in code/API_definitions/qos-booking.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Component may be unused 

[S-211] Potentially unused component has been detected. | Suggestion: Remove the component if it is obsolete, or reference it from the API definition.
$ref: '../common/CAMARA_common.yaml#/components/schemas/Latitude'

Longitude:

Check warning on line 699 in code/API_definitions/qos-booking.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Component may be unused 

[S-211] Potentially unused component has been detected. | Suggestion: Remove the component if it is obsolete, or reference it from the API definition.
$ref: '../common/CAMARA_common.yaml#/components/schemas/Longitude'

Device:
Expand All @@ -718,7 +718,7 @@
$ref: "#/components/schemas/ApplicationServerIpv6Address"
minProperties: 1

ApplicationServerIpv4Address:

Check notice on line 721 in code/API_definitions/qos-booking.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: 15
example: "198.51.100.0/24"
Expand All @@ -728,7 +728,7 @@
- address/mask - an IP number as above with a mask width of the form 1.2.3.4/24.
In this case, all IP numbers from 1.2.3.0 to 1.2.3.255 will match. The bit width MUST be valid for the IP version.

ApplicationServerIpv6Address:

Check notice on line 731 in code/API_definitions/qos-booking.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: 45
example: "2001:db8:85a3:8d3:1319:8a2e:370:7344"
Expand Down
Loading