## {{ $route['metadata']['title'] ?: $route['uri']}} @component('scribe::components.badges.auth', ['authenticated' => $route['metadata']['authenticated']]) @endcomponent {!! $route['metadata']['description'] ?: ''!!} > Example request: @foreach($settings['languages'] as $language) @include("scribe::partials.example-requests.$language") @endforeach @if(in_array('GET',$route['methods']) || (isset($route['showresponse']) && $route['showresponse'])) @foreach($route['responses'] as $response) > Example response ({{$response['description'] ?? $response['status']}}): ```json @if(is_object($response['content']) || is_array($response['content'])) {!! json_encode($response['content'], JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE) !!} @elseif(is_string($response['content']) && \Str::startsWith($response['content'], "<>")) - {{ str_replace("<>","",$response['content']) }} @elseif($response['status'] == 204) @elseif(is_string($response['content']) && json_decode($response['content']) == null && $response['content'] !== null) {{-- If response is a non-JSON string, just print it --}} {!! $response['content'] !!} @else {!! json_encode(json_decode($response['content']), JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE) !!} @endif ``` @endforeach @endif

Request    @if($settings['interactive'])    @endif

@foreach($route['methods'] as $method)

@component('scribe::components.badges.http-method', ['method' => $method])@endcomponent {{$route['uri']}}

@endforeach @if($route['metadata']['authenticated'] && $auth['location'] === 'header')

@endif @if(count($route['urlParameters']))

URL Parameters

@foreach($route['urlParameters'] as $attribute => $parameter)

@component('scribe::components.field-details', [ 'name' => $parameter['name'], 'type' => $parameter['type'] ?? 'string', 'required' => $parameter['required'] ?? true, 'description' => $parameter['description'], 'endpointId' => $endpointId, 'component' => 'url', ]) @endcomponent

@endforeach @endif @if(count($route['queryParameters']))

Query Parameters

@foreach($route['queryParameters'] as $attribute => $parameter)

@component('scribe::components.field-details', [ 'name' => $parameter['name'], 'type' => $parameter['type'] ?? 'string', 'required' => $parameter['required'] ?? true, 'description' => $parameter['description'], 'endpointId' => $endpointId, 'component' => 'query', ]) @endcomponent

@endforeach @endif @if(count($route['nestedBodyParameters']))

Body Parameters

@component('scribe::partials.body-parameters', ['parameters' => $route['nestedBodyParameters'], 'endpointId' => $endpointId,]) @endcomponent @endif
@if(count($route['responseFields'] ?? [])) ### Response

Response Fields

@foreach($route['responseFields'] as $name => $field)

@component('scribe::components.field-details', [ 'name' => $field['name'], 'type' => $field['type'], 'required' => true, 'description' => $field['description'], 'isInput' => false, ]) @endcomponent

@endforeach @endif