Merge pull request #324 from james2doyle/feature/field-examples

Feature/field examples. Closes #322
knuckleswtf · Sep 29, 2021 · e4d7e17 · e4d7e17
2 parents c1da197 + 4668014
commit e4d7e17
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 2 deletions.
diff --git a/resources/views/components/body-parameters.blade.php b/resources/views/components/body-parameters.blade.php
@@ -19,6 +19,7 @@
                           'type' => $subfield['type'] ?? 'string',
                           'required' => $subfield['required'] ?? false,
                           'description' => $subfield['description'] ?? '',
+                          'example' => $subfield['example'] ?? '',
                           'endpointId' => $endpointId,
                           'hasChildren' => false,
                           'component' => 'body',
@@ -53,6 +54,7 @@
                           'type' => $subfield['type'] ?? 'string',
                           'required' => $subfield['required'] ?? false,
                           'description' => $subfield['description'] ?? '',
+                          'example' => $subfield['example'] ?? '',
                           'endpointId' => $endpointId,
                           'hasChildren' => false,
                           'component' => 'body',
@@ -70,6 +72,7 @@
               'type' => $parameter['type'] ?? 'string',
               'required' => $parameter['required'] ?? false,
               'description' => $parameter['description'] ?? '',
+              'example' => $parameter['example'] ?? '',
               'endpointId' => $endpointId,
               'hasChildren' => false,
               'component' => 'body',
@@ -78,4 +81,3 @@
         </p>
     @endif
 @endforeach
-
diff --git a/resources/views/components/field-details.blade.php b/resources/views/components/field-details.blade.php
@@ -54,8 +54,9 @@
         <input type="{{ $inputType }}"
                name="{{ $fullName }}"
                data-endpoint="{{ $endpointId }}"
+               value="{{ $example }}"
                data-component="{{ $component }}" @if($required)required @endif hidden>
     @endif
 @endif
 <br>
-{!! Parsedown::instance()->text($description) !!}
+{!! Parsedown::instance()->text($description) !!}
diff --git a/resources/views/themes/default/endpoint.blade.php b/resources/views/themes/default/endpoint.blade.php
@@ -111,6 +111,7 @@
                   'type' => $parameter->type ?? 'string',
                   'required' => $parameter->required,
                   'description' => $parameter->description,
+                  'example' => $parameter->example ?? '',
                   'endpointId' => $endpoint->endpointId(),
                   'component' => 'url',
                 ])
@@ -127,6 +128,7 @@
                   'type' => $parameter->type,
                   'required' => $parameter->required,
                   'description' => $parameter->description,
+                  'example' => $parameter->example ?? '',
                   'endpointId' => $endpoint->endpointId(),
                   'component' => 'query',
                 ])