Purpose

A temporary page to collect data needed to define and align needs for resource shape definitions for a variety of CmScenarios

Related Work

ReportingResourceSchema

CQ Experimental OSLC extension providing XML Schemas

Definitions

Resource Shape - Often referred to as a "schema". This defines what properties and types of properties exist on a resource, or which ones are needed to create a resource.

Scenarios

Discovering resource shapes

Given a service description document, retrieve all the resource types that can be created and queried on.

Creating resources without UI

There should be enough information in a resource shape definition to determine:

• required
• read-only
• property type (int, string, date, link) ?: What if a particular property is a complex type that has its own schema. Is this defined as type=Object or something like that?
• choices (enumerations or URL for computed choices)

Knowing which properties to query on

There should be enough information in a resource shape definition to determine:

• property type (int, string, date, link)
• choices (enumerations or URL for computed choices)

Knowing which properties to include in a partial get

There should be enough information in a resource shape definition to determine:

• property type (int, string, date, link)

Additional information for presentation in a UI

There should be enough information in a resource shape definition to determine:

• required
• read-only
• property type (int, string, date, link)
• choices (enumerations or URL for computed choices)
• I18N? labels for properties

Other optional attributes to help define the UI would be helpful:

• size (Example: the max length of a string so validations can be done before sending to the server)
• label (what the label should say for this attribute, localized in the requested language)
• defaultValue (if there is a default value for this attribute)
• format (Example: if there is a specific date format for this field that is different than the usual format)
• hint (tooltip text to show, localized in the requested language)
• queryable (if this field can be queried or not)

Other potential needs

Here is a quick list of other scenarios where some resource shape may be needed

• Performing actions on change requests, for example "Assigning" or "Closing" a CR often causes properties to become required or read-only

Proposal

tbd