Skip to content

enhance: Address schema in webrtc-call-handling #178

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
teikuran wants to merge 4 commits into
base: main
Choose a base branch
from
Open

enhance: Address schema in webrtc-call-handling #178

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
427aa41
Enhance Subscriber address description in YAML
teikuran Jun 21, 2026
db45e56
Fix formatting issues in webrtc-call-handling.yaml
teikuran Jun 21, 2026
c2b177f
Clarify SIP URI user part description
teikuran Jun 21, 2026
90f1968
Update webrtc-call-handling.yaml for anonymous calls
teikuran Jun 25, 2026
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
24 changes: 21 additions & 3 deletions code/API_definitions/webrtc-call-handling.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,10 +236,10 @@
- url: '{apiRoot}/webrtc-call-handling/vwip'
variables:
apiRoot:
description: API root

Check notice on line 239 in code/API_definitions/webrtc-call-handling.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

apiRoot description should match standard text 

[S-023] apiRoot description does not match the standard CAMARA text.
default: 'http://localhost:9091'
tags:
- name: Call handling

Check notice on line 242 in code/API_definitions/webrtc-call-handling.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Tag name must be Title Case 

[S-021] Tag name 'Call handling' is not Title Case. Use e.g. 'Quality On Demand' instead of 'quality-on-demand'.
description: Operations to manage voice video sessions (calls)
paths:
/sessions:
Expand Down Expand Up @@ -466,7 +466,7 @@
required: true
style: simple
explode: false
schema:

Check notice on line 469 in code/API_definitions/webrtc-call-handling.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%3A Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
maxLength: 256
pathParamMediaSessionId:
Expand All @@ -476,7 +476,7 @@
required: true
style: simple
explode: false
schema:

Check notice on line 479 in code/API_definitions/webrtc-call-handling.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%3A Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
maxLength: 256
x-correlator:
Expand All @@ -498,14 +498,14 @@
properties:
originatorAddress:
$ref: '#/components/schemas/Address'
originatorName:

Check notice on line 501 in code/API_definitions/webrtc-call-handling.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%3A Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
maxLength: 256
description: Friendly name of the call originator
example: 'Alice'
receiverAddress:
$ref: '#/components/schemas/Address'
receiverName:

Check notice on line 508 in code/API_definitions/webrtc-call-handling.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%3A Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
maxLength: 256
description: Friendly name of the call terminator
Expand Down Expand Up @@ -552,7 +552,7 @@
- $ref: '#/components/schemas/MediaSessionInformation'
- type: object
properties:
mediaSessionId:

Check notice on line 555 in code/API_definitions/webrtc-call-handling.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%3A Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
maxLength: 256
description: >-
Expand Down Expand Up @@ -585,7 +585,7 @@
present in a request from the application to the server to create a
session.
properties:
sdp:

Check notice on line 588 in code/API_definitions/webrtc-call-handling.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%3A Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
maxLength: 65536
description: |-
Expand Down Expand Up @@ -634,10 +634,28 @@
description: A human readable description of what the event represent
Address:
type: string
description: Subscriber address (Sender or Receiver)
pattern: '^(tel:\+[0-9]{5,15}|sip:[A-Za-z0-9_.!%+\-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}|urn:service:sos(?:\.[a-z0-9](?:[a-z0-9\-]{0,30}[a-z0-9])?)*)$'
maxLength: 256
description: >-
Subscriber address (Sender or Receiver).
The following formats are supported:
- A TEL URI :
- an international format; or
- a home local number (as defined in 3GPP TS 24.229 subclause 5.1.2A.1.5) qualified by a `phone-context`
parameter identifying the home network numbering plan.
- A SIP URI :
- SIP URI with a generic user part;
- SIP URI with a home local number (`user=phone`). The user part MAY contain a home local number qualified by
a `phone-context` parameter, in which case the `user=phone` URI parameter SHALL be appended;
- an emergency service URN; or
- anonymous SIP URI

The reserved value `sip:anonymous@anonymous.invalid` (as defined in RFC 3323) MAY be used to indicate
that the calling party identity is withheld within the trust domain. When `sip:anonymous@anonymous.invalid` is set
as the `originatorAddress`, the session SHALL be handled as an anonymous call origination.
This value SHALL NOT be used as the `receiverAddress`.

pattern: '^(tel:\+[1-9][0-9]{4,14}|tel:[0-9*#]{1,15};phone-context=(?:\+[1-9][0-9]{0,14}|[A-Za-z0-9](?:[A-Za-z0-9\-]*[A-Za-z0-9])?(?:\.[A-Za-z0-9](?:[A-Za-z0-9\-]*[A-Za-z0-9])?)+)|sip:[A-Za-z0-9_.!%+\-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}|sip:[0-9*#]{1,15};phone-context=(?:\+[1-9][0-9]{0,14}|[A-Za-z0-9](?:[A-Za-z0-9\-]*[A-Za-z0-9])?(?:\.[A-Za-z0-9](?:[A-Za-z0-9\-]*[A-Za-z0-9])?)+)@[A-Za-z0-9.-]+\.[A-Za-z]{2,};user=phone|urn:service:sos(?:\.[a-z0-9](?:[a-z0-9\-]{0,30}[a-z0-9])?)*|sip:anonymous@anonymous\.invalid)$'
example: 'tel:+11234567899'
maxLength: 256
LocationDetails:
type: object
description: >-
Expand Down Expand Up @@ -689,7 +707,7 @@
minimum: 0
maximum: 100
description: The confidence value (percentage).
timestamp:

Check notice on line 710 in code/API_definitions/webrtc-call-handling.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

date-time field must mention RFC 3339 

[S-028] Property with format 'date-time' must have a description mentioning RFC\s*3339
type: string
format: date-time
maxLength: 64
Expand Down
Loading