Skip to content

Commit a5f560c

Browse files
committed
Add comment block for new method
1 parent 3187dbc commit a5f560c

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

Annotations/AnnotationGenerator.php

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1100,6 +1100,16 @@ protected function determineResponses(array $rules, string $plugin, string $meth
11001100
return $responses;
11011101
}
11021102

1103+
/**
1104+
* Build the array of properties making up a media type annotation object to be included in a response annotation
1105+
* object. The is for when we can provide examples for specific formats, like XML, JSON, and TSV.
1106+
*
1107+
* @param string $format The format of the example. E.g. xml, json, or tsv.
1108+
* @param string $exampleValue The example value, which can be a JSON string.
1109+
* @param array $responseSchema The default schema, like GenericArray or GenericInteger responses.
1110+
*
1111+
* @return string[]
1112+
*/
11031113
protected function buildMediaTypePropertiesArray(string $format, string $exampleValue, array $responseSchema = []): array
11041114
{
11051115
$contentType = $format === 'json' ? 'application/json' : ($format === 'xml' ? 'text/xml' : 'application/vnd.ms-excel');

0 commit comments

Comments
 (0)