Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add required: yes/no to reference docs #1652

Merged
merged 2 commits into from
Sep 22, 2024
Merged

Add required: yes/no to reference docs #1652

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a5c4d12
Add required: yes/no to reference docs
DerManoMann Sep 22, 2024
8849e76
CS
DerManoMann Sep 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/.vitepress/theme/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,9 @@
border-bottom: solid 1px #ddd;
}
}

.table-plain, table.table-plain tr, table.table-plain th, table.table-plain td {
border: none;
padding: 2px 12px 2px 0;
background: none;
}
302 changes: 151 additions & 151 deletions docs/reference/annotations.md
View file
Open in desktop

Large diffs are not rendered by default.

1,244 changes: 622 additions & 622 deletions docs/reference/attributes.md
View file
Open in desktop

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/reference/processors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,9 +115,6 @@ Generate the OperationId based on the context of the OpenApi annotation.
</dl>


### [AugmentTags](https://github.com/zircote/swagger-php/tree/master/src/Processors/AugmentTags.php)

Ensures that all tags used on operations also exist in the global <code>tags</code> list.
### [CleanUnmerged](https://github.com/zircote/swagger-php/tree/master/src/Processors/CleanUnmerged.php)


Expand Down Expand Up @@ -151,3 +148,6 @@ Tracks the use of all <code>Components</code> and removed unused schemas.
</dl>


### [AugmentTags](https://github.com/zircote/swagger-php/tree/master/src/Processors/AugmentTags.php)

Ensures that all tags used on operations also exist in the global <code>tags</code> list.
5 changes: 5 additions & 0 deletions src/Annotations/PathParameter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,9 @@ class PathParameter extends Parameter
* @inheritdoc
*/
public $required = true;

/**
* @inheritdoc
*/
public static $_required = ['name'];
}
17 changes: 14 additions & 3 deletions tools/src/Docs/RefGenerator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,18 +163,28 @@ public function formatAnnotationsDetails(string $name, string $fqdn, string $fil

protected function getPropertyDocumentation(string $fqdn, string $name): array
{
/** @var class-string<AbstractAnnotation> $class */
$class = str_replace('Attributes', 'Annotations', $fqdn);
try {
$rp = new \ReflectionProperty(str_replace('Attributes', 'Annotations', $fqdn), $name);
$rp = new \ReflectionProperty($class, $name);
} catch (\ReflectionException $re) {
$rp = null;
}

return $this->extractDocumentation($rp ? $rp->getDocComment() : null);
$documentation = $this->extractDocumentation($rp ? $rp->getDocComment() : null);

$documentation['required'] = in_array($name, $class::$_required);

return $documentation;
}

protected function propertyDetails(array $propertyDocumentation): void
{
echo '<p>' . nl2br($propertyDocumentation['content'] ?: self::NO_DETAILS_AVAILABLE) . '</p>';

echo '<table class="table-plain">';
echo '<tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>' . ($propertyDocumentation['required'] ? 'yes' : 'no') . '</b></td></tr>';

if ($propertyDocumentation['see']) {
$links = [];
foreach ($propertyDocumentation['see'] as $see) {
Expand All @@ -183,10 +193,11 @@ protected function propertyDetails(array $propertyDocumentation): void
}
}
if ($links) {
echo '<p><i>See</i>: ' . implode(', ', $links) . '</p>';
echo '<tr><td style="padding-left: 0;"><i>See</i>:</td><td style="padding-left: 0;">' . implode(', ', $links) . '</td></tr>';
}
}

echo '</table>';
}

/**
Expand Down