Skip to content
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

Changed wording #216

Closed
wants to merge 1 commit into from
Closed

Changed wording #216

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
2 changes: 1 addition & 1 deletion APIs/schemas/flow_audio_coded.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
],
"properties": {
"media_type": {
"description": "Subclassification of the format using IANA assigned media types",
"description": "Subclassification of the format using IANA assigned media types, if available",
Copy link
Contributor

@cristian-recoseanu cristian-recoseanu Nov 21, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we try to write these in such a way so it doesn't seem that the field is optional if there isn't an IANA assigned media type?

Suggested change
"description": "Subclassification of the format using IANA assigned media types, if available",
"description": "Subclassification of the format (prefer IANA assigned media types where available)",

"type": "string",
"pattern": "^audio\\/[^\\s\\/]+$",
"not": {
Expand Down
2 changes: 1 addition & 1 deletion APIs/schemas/flow_audio_raw.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
],
"properties": {
"media_type": {
"description": "Subclassification of the format using IANA assigned media types",
"description": "Subclassification of the format using IANA assigned media types, if available",
"type": "string",
"anyOf": [
{
Expand Down
2 changes: 1 addition & 1 deletion APIs/schemas/flow_data.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"format": "uri"
},
"media_type": {
"description": "Subclassification of the format using IANA assigned media types",
"description": "Subclassification of the format using IANA assigned media types, if available",
"type": "string",
"pattern": "^[^\\s\\/]+\\/[^\\s\\/]+$",
"not": {
Expand Down
2 changes: 1 addition & 1 deletion APIs/schemas/flow_json_data.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"format": "uri"
},
"media_type": {
"description": "Subclassification of the format using IANA assigned media types",
"description": "Subclassification of the format using IANA assigned media types, if available",
"type": "string",
"enum": [
"application/json"
Expand Down
2 changes: 1 addition & 1 deletion APIs/schemas/flow_mux.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"format": "uri"
},
"media_type": {
"description": "Subclassification of the format using IANA assigned media types",
"description": "Subclassification of the format using IANA assigned media types, if available",
"type": "string",
"anyOf": [
{
Expand Down
2 changes: 1 addition & 1 deletion APIs/schemas/flow_sdianc_data.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"format": "uri"
},
"media_type": {
"description": "Subclassification of the format using IANA assigned media types",
"description": "Subclassification of the format using IANA assigned media types, if available",
"type": "string",
"enum": [
"video/smpte291"
Expand Down
2 changes: 1 addition & 1 deletion APIs/schemas/flow_video_coded.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
],
"properties": {
"media_type": {
"description": "Subclassification of the format using IANA assigned media types",
"description": "Subclassification of the format using IANA assigned media types, if available",
"type": "string",
"anyOf": [
{
Expand Down
2 changes: 1 addition & 1 deletion APIs/schemas/flow_video_raw.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
],
"properties": {
"media_type": {
"description": "Subclassification of the format using IANA assigned media types",
"description": "Subclassification of the format using IANA assigned media types, if available",
"type": "string",
"enum": [
"video/raw"
Expand Down
2 changes: 1 addition & 1 deletion APIs/schemas/receiver_audio.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"type": "object",
"properties": {
"media_types": {
"description": "Subclassification of the formats accepted using IANA assigned media types",
"description": "Subclassification of the formats accepted using IANA assigned media types, if available",
Copy link
Contributor

@cristian-recoseanu cristian-recoseanu Nov 21, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we try to write these in such a way so it doesn't seem that the field is optional if there isn't an IANA assigned media type?

Suggested change
"description": "Subclassification of the formats accepted using IANA assigned media types, if available",
"description": "Subclassification of the formats (prefer IANA assigned media types where available)",

"type": "array",
"minItems": 1,
"items": {
Expand Down
2 changes: 1 addition & 1 deletion APIs/schemas/receiver_data.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"type": "object",
"properties": {
"media_types": {
"description": "Subclassification of the formats accepted using IANA assigned media types",
"description": "Subclassification of the formats accepted using IANA assigned media types, if available",
"type": "array",
"minItems": 1,
"items": {
Expand Down
2 changes: 1 addition & 1 deletion APIs/schemas/receiver_mux.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"type": "object",
"properties": {
"media_types": {
"description": "Subclassification of the formats accepted using IANA assigned media types",
"description": "Subclassification of the formats accepted using IANA assigned media types, if available",
"type": "array",
"minItems": 1,
"items": {
Expand Down
2 changes: 1 addition & 1 deletion APIs/schemas/receiver_video.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"type": "object",
"properties": {
"media_types": {
"description": "Subclassification of the formats accepted using IANA assigned media types",
"description": "Subclassification of the formats accepted using IANA assigned media types, if available",
"type": "array",
"minItems": 1,
"items": {
Expand Down