Skip to content

Commit

Permalink
[ReleasePR orbital] Updating descriptions and examples (#2437)
Browse files Browse the repository at this point in the history 
Create to sync Azure/azure-rest-api-specs#19536
[ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/main...azure-sdk:sdkAuto/orbital?expand=1)
  • Loading branch information
msftbot[bot] authored Jun 22, 2022
2 parents 689e8a2 + e9e30a3 commit 2a9aa4e
Showing 1 changed file with 38 additions and 38 deletions.
76 changes: 38 additions & 38 deletions schemas/2022-03-01/Microsoft.Orbital.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
},
"name": {
"type": "string",
"description": "Contact Profile Name"
"description": "Contact Profile name."
},
"properties": {
"oneOf": [
Expand Down Expand Up @@ -78,7 +78,7 @@
},
"name": {
"type": "string",
"description": "Spacecraft ID"
"description": "Spacecraft ID."
},
"properties": {
"oneOf": [
Expand Down Expand Up @@ -143,7 +143,7 @@
},
"name": {
"type": "string",
"description": "Contact Name"
"description": "Contact name."
},
"properties": {
"oneOf": [
Expand Down Expand Up @@ -188,7 +188,7 @@
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
],
"description": "Contact Profile Link Channel"
"description": "Contact Profile Link Channel."
},
"direction": {
"oneOf": [
Expand All @@ -214,7 +214,7 @@
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
],
"description": "Effective Isotropic Radiated Power (EIRP) in dBW."
"description": "Effective Isotropic Radiated Power (EIRP) in dBW. It is the required EIRP by the customer. Not used yet."
},
"gainOverTemperature": {
"oneOf": [
Expand All @@ -225,11 +225,11 @@
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
],
"description": "Gain To Noise Temperature in db/K."
"description": "Gain To Noise Temperature in db/K. It is the required G/T by the customer. Not used yet."
},
"name": {
"type": "string",
"description": "Link name"
"description": "Link name."
},
"polarization": {
"oneOf": [
Expand All @@ -246,7 +246,7 @@
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
],
"description": "polarization. eg (RHCP, LHCP)."
"description": "Polarization. e.g. (RHCP, LHCP)."
}
},
"required": [
Expand All @@ -255,7 +255,7 @@
"name",
"polarization"
],
"description": "Contact Profile Link"
"description": "Contact Profile Link."
},
"ContactProfileLinkChannel": {
"type": "object",
Expand All @@ -269,7 +269,7 @@
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
],
"description": "Bandwidth in MHz"
"description": "Bandwidth in MHz."
},
"centerFrequencyMHz": {
"oneOf": [
Expand All @@ -280,19 +280,19 @@
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
],
"description": "Center Frequency in MHz"
"description": "Center Frequency in MHz."
},
"decodingConfiguration": {
"type": "string",
"description": "Configuration for decoding"
"description": "Currently unused."
},
"demodulationConfiguration": {
"type": "string",
"description": "Configuration for demodulation"
"description": "Copy of the modem configuration file such as Kratos QRadio or Kratos QuantumRx. Only valid for downlink directions. If provided, the modem connects to the customer endpoint and sends demodulated data instead of a VITA.49 stream."
},
"encodingConfiguration": {
"type": "string",
"description": "Configuration for encoding"
"description": "Currently unused."
},
"endPoint": {
"oneOf": [
Expand All @@ -307,11 +307,11 @@
},
"modulationConfiguration": {
"type": "string",
"description": "Configuration for modulation"
"description": "Copy of the modem configuration file such as Kratos QRadio. Only valid for uplink directions. If provided, the modem connects to the customer endpoint and accepts commands from the customer instead of a VITA.49 stream."
},
"name": {
"type": "string",
"description": "Channel name"
"description": "Channel name."
}
},
"required": [
Expand All @@ -320,7 +320,7 @@
"endPoint",
"name"
],
"description": "Contact Profile Link Channel"
"description": "Contact Profile Link Channel."
},
"ContactProfileProperties": {
"type": "object",
Expand All @@ -339,11 +339,11 @@
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
],
"description": "Auto track configuration."
"description": "Auto-tracking configuration."
},
"eventHubUri": {
"type": "string",
"description": "The URI of the Event Hub used for telemetry"
"description": "ARM resource identifier of the Event Hub used for telemetry. Requires granting Orbital Resource Provider the rights to send telemetry into the hub."
},
"links": {
"oneOf": [
Expand All @@ -357,7 +357,7 @@
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
],
"description": "Links of the Contact Profile"
"description": "Links of the Contact Profile. Describes RF links, modem processing, and IP endpoints."
},
"minimumElevationDegrees": {
"oneOf": [
Expand All @@ -368,11 +368,11 @@
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
],
"description": "Minimum viable elevation for the contact in decimal degrees."
"description": "Minimum viable elevation for the contact in decimal degrees. Used for listing the available contacts with a spacecraft at a given ground station."
},
"minimumViableContactDuration": {
"type": "string",
"description": "Minimum viable contact duration in ISO 8601 format."
"description": "Minimum viable contact duration in ISO 8601 format. Used for listing the available contacts with a spacecraft at a given ground station."
},
"networkConfiguration": {
"oneOf": [
Expand All @@ -387,7 +387,7 @@
},
"provisioningState": {
"type": "string",
"description": "The current state of the resource's creation, deletion, or modification"
"description": "The current state of the resource's creation, deletion, or modification."
}
},
"required": [
Expand All @@ -401,7 +401,7 @@
"properties": {
"subnetId": {
"type": "string",
"description": "Customer subnet ARM resource identifier."
"description": "ARM resource identifier of the subnet delegated to the Microsoft.Orbital/orbitalGateways. Needs to be at least a class C subnet, and should not have any IP created in it."
}
},
"required": [
Expand Down Expand Up @@ -429,17 +429,17 @@
},
"provisioningState": {
"type": "string",
"description": "The current state of the resource's creation, deletion, or modification"
"description": "The current state of the resource's creation, deletion, or modification."
},
"reservationEndTime": {
"type": "string",
"format": "date-time",
"description": "Reservation end time of a contact."
"description": "Reservation end time of a contact (ISO 8601 UTC standard)."
},
"reservationStartTime": {
"type": "string",
"format": "date-time",
"description": "Reservation start time of a contact."
"description": "Reservation start time of a contact (ISO 8601 UTC standard)."
}
},
"required": [
Expand Down Expand Up @@ -511,7 +511,7 @@
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
],
"description": "Bandwidth in MHz"
"description": "Bandwidth in MHz."
},
"centerFrequencyMHz": {
"oneOf": [
Expand All @@ -522,7 +522,7 @@
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
],
"description": "Center Frequency in MHz"
"description": "Center Frequency in MHz."
},
"direction": {
"oneOf": [
Expand All @@ -541,7 +541,7 @@
},
"name": {
"type": "string",
"description": "Link name"
"description": "Link name."
},
"polarization": {
"oneOf": [
Expand All @@ -558,7 +558,7 @@
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
],
"description": "polarization. eg (RHCP, LHCP)."
"description": "Polarization. e.g. (RHCP, LHCP)."
}
},
"required": [
Expand All @@ -568,7 +568,7 @@
"name",
"polarization"
],
"description": "Authorized Ground Stations for the link"
"description": "List of authorized spacecraft links per ground station and the expiration date of the authorization."
},
"SpacecraftsProperties": {
"type": "object",
Expand All @@ -585,27 +585,27 @@
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
],
"description": "Links of the Spacecraft"
"description": "Immutable list of Spacecraft links."
},
"noradId": {
"type": "string",
"description": "NORAD ID of the spacecraft."
},
"provisioningState": {
"type": "string",
"description": "The current state of the resource's creation, deletion, or modification"
"description": "The current state of the resource's creation, deletion, or modification."
},
"titleLine": {
"type": "string",
"description": "Title line of Two Line Element (TLE)."
"description": "Title line of the two-line element set (TLE)."
},
"tleLine1": {
"type": "string",
"description": "Line 1 of Two Line Element (TLE)."
"description": "Line 1 of the two-line element set (TLE)."
},
"tleLine2": {
"type": "string",
"description": "Line 1 of Two Line Element (TLE)."
"description": "Line 1 of the two-line element set (TLE)."
}
},
"required": [
Expand All @@ -624,7 +624,7 @@
},
"name": {
"type": "string",
"description": "Contact Name"
"description": "Contact name."
},
"properties": {
"oneOf": [
Expand Down

0 comments on commit 2a9aa4e

Please sign in to comment.