question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Describe Data: provide example of datashape definition

See original GitHub issue

This is a…


[x ] Feature request
[ ] Regression (a behavior that used to work and stopped working in a new release)
[ ] Bug report  
[ ] Documentation issue or request

The problem

Currently the definition textarea is blank. Could we provide an example definition to outline format, required fields etc? Or we just entirely fallback to docs here?

Screenshot

screen shot 2018-03-05 at 19 47 29

Issue Analytics

  • State:closed
  • Created 6 years ago
  • Comments:6 (4 by maintainers)

github_iconTop GitHub Comments

1reaction
TovaCohencommented, Jun 11, 2018

For the Specify Input/Output Data Type page, the user documentation provides this information:

Select one of the following as the schema type:

  • JSON schema is a document that describes the structure of JSON data. The document’s media type is application/schema+json.
  • JSON instance is a document that contains JSON data. The document’s media type is application/json.
  • XML schema is a document that describes the structure of XML data. The document’s file extension is .xsd.
  • XML instance is a document that contains XML data. The document’s file extension is .xml.

In the Definition input box, paste a definition that conforms to the schema type you selected. For example, if you select JSON schema then you would paste the content of a JSON schema file, which has a media type of application/schema+json.

However, the page does not provide hover help for input fields. Can this be added? I suggest:

Select Type Indicate how you are specifying the data type.

Definition Paste or write content for the type you selected, for example, for JSON Schema, paste the content of a document whose media type is application/schema+json.

Data Type Name Enter a name that you choose. This name will appear in the data mapper.

Data Type Description Enter any information about this data type that might be helpful to you.

1reaction
dsimanskcommented, Mar 5, 2018

@gashcrumb I’m fine with that. I’ll remove TP4 label and keep this as a possible enhancement once validation is also available? Wdyt?

Read more comments on GitHub >

github_iconTop Results From Across the Web

Data Shapes - ThingWorx - PTC Support
A Data Shape is a named set of field definitions and related metadata. Each field in a Data Shape has a data type....
Read more >
Data Shapes - Syndesis
A datashape is a way to describe any inbound/outbound message format and to allow the user to easily map each data property in...
Read more >
Lesson 3: Describing Quantitative Data (Shape & Center)
In the example below, we will explore one way to define what “average” means. When we talk about the “typical” or “average” value,...
Read more >
Add data to Visio shapes - Microsoft Support
Add data directly to shapes on your diagram to provide details, for example ... In the Define Shape Data dialog box, click New,...
Read more >
Describing Distributions - Biostatistics - University of Florida
LO 4.7: Define and describe the features of the distribution of one quantitative variable ... To provide an example of a histogram applied...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found