Merge pull request #181 from sky-uk/feature/basic-example-support

Basic input parameter example support
sky-uk · Aug 30, 2017 · ac5c534 · ac5c534
2 parents f2a06e4 + d0f03cf
commit ac5c534
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 15 deletions.
diff --git a/src/components/widgets/SpecWidgetTab.js b/src/components/widgets/SpecWidgetTab.js
@@ -1,20 +1,31 @@
 import React, { Component, PropTypes } from 'react'
 
 class SpecWidgetTab extends Component {
+
+ renderParameterDescription (description) {
+ return description.startsWith('http')
+ ? (<a href={description} target='_blank'>Go to external docs <i className='fa fa-external-link' /></a>)
+ : (<div>{description}</div>)
+ }
+
  renderParameter (parameter) {
- return (<tr key={parameter.name}>
- <td >
- <span className='label label-default' >{parameter.in}</span>
- </td>
- <td className='col-md-2' ><span >{parameter.name}</span></td>
- <td className='col-md-8' >
- <span className='doc-w-param-value' >{parameter.description}</span>
- </td>
- <td className='col-md-2' >
- <span className='doc-w-param-datatype' >{this.renderType(parameter)}
- </span>
- </td>
- </tr>)
+ return (
+ <tr key={parameter.name}>
+ <td className='col-md-4'>
+ <span className='label label-default'>{parameter.in}</span>
+ <span> {parameter.name}</span></td>
+ <td className='col-md-6' >
+ <span className='doc-w-param-value'>{this.renderParameterDescription(parameter.description)}</span>
+ {parameter.example && (
+ <code>{JSON.stringify(parameter.example)}</code>
+ )}
+ </td>
+ <td className='col-md-2' >
+ <span className='doc-w-param-datatype' >{this.renderType(parameter)}
+ </span>
+ </td>
+ </tr>
+ )
  }
 
  renderType (parameter) {
@@ -47,7 +58,7 @@ class SpecWidgetTab extends Component {
  <p>{this.props.operation.spec.summary}</p>
  <p className='text-muted' >{this.props.operation.spec.description}</p>
  <div >
- <div >
+ <div>
  <h4 >Parameters</h4>
  <table className='table table-striped' >
  <tbody className='operation-params' >

diff --git a/src/components/widgets/TryOutWidgetTabParameters.js b/src/components/widgets/TryOutWidgetTabParameters.js
@@ -131,6 +131,12 @@ class TryOutWidgetTabParameters extends Component {
  return <div>-</div>
  }
 
+ renderParameterDescription (description) {
+ return description.startsWith('http')
+ ? (<div><small><small><a href={description} target='_blank'>Go to external docs <i className='fa fa-external-link' /></a></small></small></div>)
+ : (<div><small><small>{description}</small></small></div>)
+ }
+
  renderParameters (parameters) {
  return parameters.map((parameter, i) => {
  return (
@@ -139,7 +145,7 @@ class TryOutWidgetTabParameters extends Component {
  <td className='col-md-3'>
  <span>{parameter.name}</span>
  <span title='Required field'>{parameter.required ? '*' : ''}</span>
- {parameter.description && <div><small><small>{parameter.description}</small></small></div>}
+ {parameter.description && this.renderParameterDescription(parameter.description)}
  </td>
  <td className='col-md-6'>
  <div>{this.renderEditorFor(parameter)}</div>