diff options
Diffstat (limited to 'static/redfish/v1/schema/LogService_v1.xml')
| -rw-r--r-- | static/redfish/v1/schema/LogService_v1.xml | 98 |
1 files changed, 61 insertions, 37 deletions
diff --git a/static/redfish/v1/schema/LogService_v1.xml b/static/redfish/v1/schema/LogService_v1.xml index bdee3cea33..788d997f00 100644 --- a/static/redfish/v1/schema/LogService_v1.xml +++ b/static/redfish/v1/schema/LogService_v1.xml @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="UTF-8"?> <!----> <!--################################################################################ --> -<!--# Redfish Schema: LogService v1.1.1 --> +<!--# Redfish Schema: LogService v1.1.3 --> <!--# --> <!--# For a detailed change log, see the README file contained in the DSP8010 bundle, --> <!--# available at http://www.dmtf.org/standards/redfish --> -<!--# Copyright 2014-2018 DMTF. --> +<!--# Copyright 2014-2019 DMTF. --> <!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright --> <!--################################################################################ --> <!----> @@ -35,8 +35,8 @@ <Annotation Term="Redfish.OwningEntity" String="DMTF"/> <EntityType Name="LogService" BaseType="Resource.v1_0_0.Resource" Abstract="true"> - <Annotation Term="OData.Description" String="This resource contains properties for monitoring and configuring an event log service for the resource or service to which it is associated."/> - <Annotation Term="OData.LongDescription" String="This resource shall be used to represent a log service for a Redfish implementation."/> + <Annotation Term="OData.Description" String="The LogService schema contains properties for monitoring and configuring a Log Service."/> + <Annotation Term="OData.LongDescription" String="This Resource shall represent a Log Service for a Redfish implementation."/> <Annotation Term="Capabilities.InsertRestrictions"> <Record> <PropertyValue Property="Insertable" Bool="false"/> @@ -45,7 +45,7 @@ <Annotation Term="Capabilities.UpdateRestrictions"> <Record> <PropertyValue Property="Updatable" Bool="true"/> - <Annotation Term="OData.Description" String="A Log Service can be updated to change the date and time properties."/> + <Annotation Term="OData.Description" String="The date and time properties can be updated for a Log Service."/> </Record> </Annotation> <Annotation Term="Capabilities.DeleteRestrictions"> @@ -59,13 +59,15 @@ <String>/redfish/v1/Systems/{ComputerSystemId}/LogServices/{LogServiceId}</String> <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/LogServices/{LogServiceId}</String> <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/LogServices/{LogServiceId}</String> + <String>/redfish/v1/JobService/Log</String> + <String>/redfish/v1/TelemetryService/LogService</String> </Collection> </Annotation> </EntityType> <Action Name="ClearLog" IsBound="true"> <Parameter Name="LogService" Type="LogService.v1_0_0.Actions"/> - <Annotation Term="OData.Description" String="This action is used to clear the log for this Log Service."/> + <Annotation Term="OData.Description" String="The action to clear the log for this Log Service."/> <Annotation Term="OData.LongDescription" String="This action shall delete all entries found in the Entries collection for this Log Service."/> </Action> @@ -76,65 +78,63 @@ <Annotation Term="Redfish.Release" String="1.0"/> <EntityType Name="LogService" BaseType="LogService.LogService"> - <Annotation Term="OData.Description" String="This resource represents the log service for the resource or service to which it is associated."/> - <Annotation Term="OData.LongDescription" String="This resource shall be used to represent a log service for a Redfish implementation."/> <Property Name="ServiceEnabled" Type="Edm.Boolean"> <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/> - <Annotation Term="OData.Description" String="This indicates whether this service is enabled."/> - <Annotation Term="OData.LongDescription" String="The value of this property shall be a boolean indicating whether this service is enabled."/> + <Annotation Term="OData.Description" String="An indication of whether this service is enabled."/> + <Annotation Term="OData.LongDescription" String="This property shall indicate whether this service is enabled."/> </Property> <Property Name="MaxNumberOfRecords" Type="Edm.Int64" Nullable="false"> <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> - <Annotation Term="OData.Description" String="The maximum number of log entries this service can have."/> - <Annotation Term="OData.LongDescription" String="The value of this property shall be the maximum numbers of LogEntry resources in the Entries collection for this service."/> + <Annotation Term="OData.Description" String="The maximum number of log entries that this service can have."/> + <Annotation Term="OData.LongDescription" String="This property shall contain the maximum number of LogEntry Resources in the Entries collection for this service."/> <Annotation Term="Validation.Minimum" Int="0"/> </Property> <Property Name="OverWritePolicy" Type="LogService.v1_0_0.OverWritePolicy" Nullable="false"> <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> <Annotation Term="OData.Description" String="The overwrite policy for this service that takes place when the log is full."/> - <Annotation Term="OData.LongDescription" String="The value of this property shall indicate the policy of the log service when the MaxNumberOfRecords has been reached. Unknown indicates the log overwrite policy is unknown. WrapsWhenFull indicates that the log overwrites its entries with new entries when the log has reached its maximum capacity. NeverOverwrites indicates that the log never overwrites its entries by the new entries and ceases logging when the limit has been reached."/> + <Annotation Term="OData.LongDescription" String="This property shall indicate the policy of the Log Service when the MaxNumberOfRecords has been reached."/> </Property> <Property Name="DateTime" Type="Edm.DateTimeOffset"> <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/> - <Annotation Term="OData.Description" String="The current DateTime (with offset) for the log service, used to set or read time."/> - <Annotation Term="OData.LongDescription" String="The value of this property shall represent the current DateTime value that the log service is using, with offset from UTC, in Redfish Timestamp format."/> + <Annotation Term="OData.Description" String="The current date and time, with UTC offset, that the Log Service uses to set or read time."/> + <Annotation Term="OData.LongDescription" String="This property shall represent the current DateTime value, with UTC offset, in Redfish Timestamp format that the Log Service uses to set or read time."/> </Property> <Property Name="DateTimeLocalOffset" Type="Edm.String"> <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/> - <Annotation Term="OData.Description" String="The time offset from UTC that the DateTime property is set to in format: +06:00 ."/> - <Annotation Term="OData.LongDescription" String="The value is property shall represent the offset from UTC time that the current value of DataTime property contains."/> - <Annotation Term="Validation.Pattern" String="([-+][0-1][0-9]:[0-5][0-9])"/> + <Annotation Term="OData.Description" String="The UTC offset that the current DateTime property value contains in the `+HH:MM` format."/> + <Annotation Term="OData.LongDescription" String="This property shall represent the UTC offset that the current DateTime property value contains."/> + <Annotation Term="Validation.Pattern" String="^([-+][0-1][0-9]:[0-5][0-9])$"/> </Property> <NavigationProperty Name="Entries" Type="LogEntryCollection.LogEntryCollection" ContainsTarget="true" Nullable="false"> <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> - <Annotation Term="OData.Description" String="References to the log entry collection."/> - <Annotation Term="OData.LongDescription" String="The value of this property shall reference a collection of resources of type LogEntry."/> + <Annotation Term="OData.Description" String="The link to the log entry collection."/> + <Annotation Term="OData.LongDescription" String="This property shall contain a link to a Resource Collection of type LogEntryCollection."/> <Annotation Term="OData.AutoExpandReferences"/> </NavigationProperty> <Property Name="Actions" Type="LogService.v1_0_0.Actions" Nullable="false"> - <Annotation Term="OData.Description" String="The available actions for this resource."/> - <Annotation Term="OData.LongDescription" String="The Actions property shall contain the available actions for this resource."/> + <Annotation Term="OData.Description" String="The available actions for this Resource."/> + <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this Resource."/> </Property> <Property Name="Status" Type="Resource.Status" Nullable="false"> - <Annotation Term="OData.Description" String="This property describes the status and health of the resource and its children."/> - <Annotation Term="OData.LongDescription" String="This property shall contain any status or health properties of the resource."/> + <Annotation Term="OData.Description" String="The status and health of the Resource and its subordinate or dependent Resources."/> + <Annotation Term="OData.LongDescription" String="This property shall contain any status or health properties of the Resource."/> </Property> </EntityType> <ComplexType Name="Actions"> <Annotation Term="OData.AdditionalProperties" Bool="false"/> - <Annotation Term="OData.Description" String="The available actions for this resource."/> - <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/> + <Annotation Term="OData.Description" String="The available actions for this Resource."/> + <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this Resource."/> <Property Name="Oem" Type="LogService.v1_0_0.OemActions" Nullable="false"> - <Annotation Term="OData.Description" String="This property contains the available OEM specific actions for this resource."/> - <Annotation Term="OData.LongDescription" String="This property shall contain any additional OEM actions for this resource."/> + <Annotation Term="OData.Description" String="The available OEM-specific actions for this Resource."/> + <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this Resource."/> </Property> </ComplexType> <ComplexType Name="OemActions"> <Annotation Term="OData.AdditionalProperties" Bool="true"/> - <Annotation Term="OData.Description" String="The available OEM specific actions for this resource."/> - <Annotation Term="OData.LongDescription" String="This type shall contain any additional OEM actions for this resource."/> + <Annotation Term="OData.Description" String="The available OEM-specific actions for this Resource."/> + <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this Resource."/> </ComplexType> <EnumType Name="OverWritePolicy"> @@ -142,10 +142,10 @@ <Annotation Term="OData.Description" String="The overwrite policy is not known or is undefined."/> </Member> <Member Name="WrapsWhenFull"> - <Annotation Term="OData.Description" String="When full, new entries to the Log will overwrite previous entries."/> + <Annotation Term="OData.Description" String="When full, new entries to the log overwrite earlier entries."/> </Member> <Member Name="NeverOverWrites"> - <Annotation Term="OData.Description" String="When full, new entries to the Log will be discarded."/> + <Annotation Term="OData.Description" String="When full, new entries to the log are discarded."/> </Member> </EnumType> @@ -171,7 +171,7 @@ <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_5"> <Annotation Term="Redfish.OwningEntity" String="DMTF"/> - <Annotation Term="OData.Description" String="This version was created to correct the Descriptions and LongDescriptions used in the defined Actions."/> + <Annotation Term="OData.Description" String="This version was created to correct the short and long descriptions in the defined Actions."/> <EntityType Name="LogService" BaseType="LogService.v1_0_4.LogService"/> </Schema> @@ -181,6 +181,18 @@ <EntityType Name="LogService" BaseType="LogService.v1_0_5.LogService"/> </Schema> + <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_7"> + <Annotation Term="Redfish.OwningEntity" String="DMTF"/> + <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that URI properties use the uri-reference format."/> + <EntityType Name="LogService" BaseType="LogService.v1_0_6.LogService"/> + </Schema> + + <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_8"> + <Annotation Term="Redfish.OwningEntity" String="DMTF"/> + <Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/> + <EntityType Name="LogService" BaseType="LogService.v1_0_7.LogService"/> + </Schema> + <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_1_0"> <Annotation Term="Redfish.OwningEntity" String="DMTF"/> <Annotation Term="Redfish.Release" String="2017.3"/> @@ -188,20 +200,20 @@ <EntityType Name="LogService" BaseType="LogService.v1_0_5.LogService"> <Property Name="LogEntryType" Type="LogService.v1_1_0.LogEntryTypes"> <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> - <Annotation Term="OData.Description" String="The format of the Entries of this log."/> - <Annotation Term="OData.LongDescription" String="The value of this property shall represent the EntryType of all LogEntry resources contained in the Entries collection. If a single EntryType for all LogEntry resources cannot be determined or guaranteed by the Service, the value of this property shall be 'Multiple'."/> + <Annotation Term="OData.Description" String="The format of the log entries."/> + <Annotation Term="OData.LongDescription" String="This property shall represent the EntryType of all LogEntry Resources contained in the Entries collection. If the service cannot determine or guarantee a single EntryType for all LogEntry Resources, this property's value shall be `Multiple`."/> </Property> </EntityType> <EnumType Name="LogEntryTypes"> <Member Name="Event"> - <Annotation Term="OData.Description" String="The log contains Redfish-defined messages (events)."/> + <Annotation Term="OData.Description" String="The log contains Redfish-defined messages."/> </Member> <Member Name="SEL"> <Annotation Term="OData.Description" String="The log contains legacy IPMI System Event Log (SEL) entries."/> </Member> <Member Name="Multiple"> - <Annotation Term="OData.Description" String="The log contains multiple Log Entry types or a single entry type cannot be guaranteed by the Log Service."/> + <Annotation Term="OData.Description" String="The log contains multiple log entry types and, therefore, the Log Service cannot guarantee a single entry type."/> </Member> <Member Name="OEM"> <Annotation Term="OData.Description" String="The log contains entries in an OEM-defined format."/> @@ -215,5 +227,17 @@ <EntityType Name="LogService" BaseType="LogService.v1_1_0.LogService"/> </Schema> + <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_1_2"> + <Annotation Term="Redfish.OwningEntity" String="DMTF"/> + <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that URI properties use the uri-reference format."/> + <EntityType Name="LogService" BaseType="LogService.v1_1_1.LogService"/> + </Schema> + + <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_1_3"> + <Annotation Term="Redfish.OwningEntity" String="DMTF"/> + <Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/> + <EntityType Name="LogService" BaseType="LogService.v1_1_2.LogService"/> + </Schema> + </edmx:DataServices> </edmx:Edmx> |