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.

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

Update external links to OpenAPI spec #1685

Merged
merged 2 commits into from
Jan 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
346 changes: 173 additions & 173 deletions docs/reference/annotations.md

Large diffs are not rendered by default.

1,246 changes: 623 additions & 623 deletions docs/reference/attributes.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion src/Annotations/Components.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
* All objects defined within the components object will have no effect on the API unless they are explicitly
* referenced from properties outside the components object.
*
* @see [OAI Components Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#components-object)
* @see [Components Object](https://spec.openapis.org/oas/v3.1.1.html#components-object)
*
* @Annotation
*/
Expand Down
2 changes: 1 addition & 1 deletion src/Annotations/Contact.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
/**
* Contact information for the exposed API.
*
* @see [OAI Contact Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#contact-object)
* @see [Contact Object](https://spec.openapis.org/oas/v3.1.1.html#components-object)
*
* @Annotation
*/
Expand Down
2 changes: 1 addition & 1 deletion src/Annotations/Discriminator.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
* This object is based on the [JSON Schema Specification](http://json-schema.org) and uses a predefined subset of it.
* On top of this subset, there are extensions provided by this specification to allow for more complete documentation.
*
* @see [OAI Discriminator Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#discriminatorObject)
* @see [Discriminator Object](https://spec.openapis.org/oas/v3.1.1.html#discriminator-object)
* @see [JSON Schema](http://json-schema.org/)
*
* @Annotation
Expand Down
2 changes: 1 addition & 1 deletion src/Annotations/Examples.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ class Examples extends AbstractAnnotation
/**
* The relative or absolute path to an example.
*
* @see [Using refs](https://swagger.io/docs/specification/using-ref/)
* @see [Reference Object](https://spec.openapis.org/oas/v3.1.1.html#reference-object)
*
* @var string|class-string|object
*/
Expand Down
2 changes: 1 addition & 1 deletion src/Annotations/ExternalDocumentation.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
/**
* Allows referencing an external resource for extended documentation.
*
* @see [OAI External Documentation Object](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#external-documentation-object)
* @see [External Documentation Object](https://spec.openapis.org/oas/v3.1.1.html#external-documentation-object)
*
* @Annotation
*/
Expand Down
4 changes: 2 additions & 2 deletions src/Annotations/Flow.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
use OpenApi\Generator;

/**
* Configuration details for a supported OAuth Flow.
* Configuration details for a supported OAuth flow.
*
* @see [OAI OAuth Flow Object](https://swagger.io/specification/#oauthFlowObject)
* @see [OAuth Flow Object](https://spec.openapis.org/oas/v3.1.1.html#oauth-flow-object)
*
* @Annotation
*/
Expand Down
4 changes: 2 additions & 2 deletions src/Annotations/Header.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
use OpenApi\Generator;

/**
* @see [OAI Header Object](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#headerObject).
* @see [Header Object](https://spec.openapis.org/oas/v3.1.1.html#header-object)
*
* @Annotation
*/
Expand All @@ -17,7 +17,7 @@ class Header extends AbstractAnnotation
/**
* The relative or absolute path to the endpoint.
*
* @see [Using refs](https://swagger.io/docs/specification/using-ref/)
* @see [Reference Object](https://spec.openapis.org/oas/v3.1.1.html#reference-object)
*
* @var string|class-string|object
*/
Expand Down
2 changes: 1 addition & 1 deletion src/Annotations/Info.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
*
* The metadata may be used by the clients if needed and may be presented in editing or documentation generation tools for convenience.
*
* @see [OAI Info Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#info-object)
* @see [Info Object](https://spec.openapis.org/oas/v3.1.1.html#info-object)
*
* @Annotation
*/
Expand Down
2 changes: 1 addition & 1 deletion src/Annotations/License.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
/**
* License information for the exposed API.
*
* @see [OAI License Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#license-object)
* @see [License Object](https://spec.openapis.org/oas/v3.1.1.html#license-object)
*
* @Annotation
*/
Expand Down
4 changes: 2 additions & 2 deletions src/Annotations/Link.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@
* For computing links, and providing instructions to execute them, a runtime expression is used for
* accessing values in an operation and using them as parameters while invoking the linked operation.
*
* @see [OAI Link Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#link-object)
* @see [Link Object](https://spec.openapis.org/oas/v3.1.1.html#link-object)
*
* @Annotation
*/
class Link extends AbstractAnnotation
{
/**
* @see [Using refs](https://swagger.io/docs/specification/using-ref/)
* @see [Reference Object](https://spec.openapis.org/oas/v3.1.1.html#reference-object)
*
* @var string|class-string|object
*/
Expand Down
2 changes: 1 addition & 1 deletion src/Annotations/MediaType.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
/**
* Each Media Type object provides schema and examples for the media type identified by its key.
*
* @see [OAI Media Type Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#media-type-object)
* @see [Media Type Object](https://spec.openapis.org/oas/v3.1.1.html#media-type-object)
*
* @Annotation
*/
Expand Down
2 changes: 1 addition & 1 deletion src/Annotations/OpenApi.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
/**
* This is the root document object for the API specification.
*
* @see [OAI OpenApi Object](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#openapi-object)
* @see [OpenApi Object](https://spec.openapis.org/oas/v3.1.1.html#openapi-object)
*
* @Annotation
*/
Expand Down
2 changes: 1 addition & 1 deletion src/Annotations/Operation.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
*
* Describes a single API operation on a path.
*
* @see [OAI Operation Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#operation-object)
* @see [Operation Object](https://spec.openapis.org/oas/v3.1.1.html#operation-object)
*
* @Annotation
*/
Expand Down
4 changes: 2 additions & 2 deletions src/Annotations/Parameter.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
*
* A unique parameter is defined by a combination of a name and location.
*
* @see [OAA Parameter Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#parameter-object)
* @see [Parameter Object](https://spec.openapis.org/oas/v3.1.1.html#parameter-object)
*
* @Annotation
*/
Expand All @@ -22,7 +22,7 @@ class Parameter extends AbstractAnnotation
/**
* The relative or absolute path to the endpoint.
*
* @see [Using refs](https://swagger.io/docs/specification/using-ref/)
* @see [Reference Object](https://spec.openapis.org/oas/v3.1.1.html#reference-object)
*
* @var string|class-string|object
*/
Expand Down
4 changes: 2 additions & 2 deletions src/Annotations/PathItem.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@
* A Path Item may be empty, due to ACL constraints.
* The path itself is still exposed to the documentation viewer, but they will not know which operations and parameters are available.
*
* @see [OAI Path Item Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#path-item-object)
* @see [Path Item Object](https://spec.openapis.org/oas/v3.1.1.html#path-item-object)
*
* @Annotation
*/
class PathItem extends AbstractAnnotation
{
/**
* @see [Using refs](https://swagger.io/docs/specification/using-ref/)
* @see [Reference Object](https://spec.openapis.org/oas/v3.1.1.html#reference-object)
*
* @var string|class-string|object
*/
Expand Down
4 changes: 2 additions & 2 deletions src/Annotations/RequestBody.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
/**
* Describes a single request body.
*
* @see [OAI Request Body Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#requestBodyObject)
* @see [Request Body Object](https://spec.openapis.org/oas/v3.1.1.html#request-body-object)
*
* @Annotation
*/
Expand All @@ -22,7 +22,7 @@ class RequestBody extends AbstractAnnotation
/**
* The relative or absolute path to a request body.
*
* @see [Using refs](https://swagger.io/docs/specification/using-ref/)
* @see [Reference Object](https://spec.openapis.org/oas/v3.1.1.html#reference-object)
*
* @var string|class-string|object
*/
Expand Down
6 changes: 3 additions & 3 deletions src/Annotations/Response.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
* Describes a single response from an API Operation, including design-time,
* static links to operations based on the response.
*
* @see [OAI Response Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#response-object)
* @see [Response Object](https://spec.openapis.org/oas/v3.1.1.html#response-object)
*
* @Annotation
*/
Expand All @@ -21,7 +21,7 @@ class Response extends AbstractAnnotation
/**
* The relative or absolute path to a response.
*
* @see [Using refs](https://swagger.io/docs/specification/using-ref/)
* @see [Reference Object](https://spec.openapis.org/oas/v3.1.1.html#reference-object)
*
* @var string|class-string|object
*/
Expand All @@ -48,7 +48,7 @@ class Response extends AbstractAnnotation
/**
* Maps a header name to its definition.
*
* RFC7230 states header names are case insensitive.
* RFC7230 states header names are case-insensitive.
*
* If a response header is defined with the name "Content-Type", it shall be ignored.
*
Expand Down
8 changes: 5 additions & 3 deletions src/Annotations/Schema.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* This object is based on the [JSON Schema Specification](http://json-schema.org) and uses a predefined subset of it.
* On top of this subset, there are extensions provided by this specification to allow for more complete documentation.
*
* @see [OAI Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schemaObject)
* @see [Schema Object](https://spec.openapis.org/oas/v3.1.1.html#schema-object)
* @see [JSON Schema](http://json-schema.org/)
*
* @Annotation
Expand All @@ -26,7 +26,7 @@ class Schema extends AbstractAnnotation
/**
* The relative or absolute path to the endpoint.
*
* @see [Using refs](https://swagger.io/docs/specification/using-ref/)
* @see [Reference Object](https://spec.openapis.org/oas/v3.1.1.html#reference-object)
*
* @var string|class-string|object
*/
Expand Down Expand Up @@ -102,7 +102,9 @@ class Schema extends AbstractAnnotation
public $type = Generator::UNDEFINED;

/**
* The extending format for the previously mentioned type. See Data Type Formats for further details.
* The extending format for the previously mentioned type.
*
* @see [Data Types](https://spec.openapis.org/oas/v3.1.1.html#data-types)
*
* @var string
*/
Expand Down
4 changes: 2 additions & 2 deletions src/Annotations/SecurityScheme.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
use OpenApi\Generator;

/**
* @see [OAI Security Scheme Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#securitySchemeObject).
* @see [Security Scheme Object](https://spec.openapis.org/oas/v3.1.1.html#security-scheme-object-0)
*
* @Annotation
*/
Expand All @@ -18,7 +18,7 @@ class SecurityScheme extends AbstractAnnotation
/**
* The relative or absolute path to a security scheme.
*
* @see [Using refs](https://swagger.io/docs/specification/using-ref/)
* @see [Reference Object](https://spec.openapis.org/oas/v3.1.1.html#reference-object)
*
* @var string|class-string|object
*/
Expand Down
2 changes: 1 addition & 1 deletion src/Annotations/Server.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
/**
* An object representing a server.
*
* @see [OAI Server Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#server-object)
* @see [Server Object](https://spec.openapis.org/oas/v3.1.1.html#server-object)
*
* @Annotation
*/
Expand Down
2 changes: 1 addition & 1 deletion src/Annotations/ServerVariable.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
/**
* An object representing a server variable for server URL template substitution.
*
* @see [OAI Server Variable Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#server-variable-object)
* @see [Server Variable Object](https://spec.openapis.org/oas/v3.1.1.html#server-variable-object)
*
* @Annotation
*/
Expand Down
2 changes: 1 addition & 1 deletion src/Annotations/Tag.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
use OpenApi\Generator;

/**
* @see [OAI Tag Object]( https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#tagObject).
* @see [Tag Object](https://spec.openapis.org/oas/v3.1.1.html#tag-object)
*
* @Annotation
*/
Expand Down
2 changes: 1 addition & 1 deletion src/Annotations/Xml.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
use OpenApi\Generator;

/**
* @see [OAI XML Object](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#xmlObject).
* @see [XML Object](https://spec.openapis.org/oas/v3.1.1.html#xml-object)
*
* @Annotation
*/
Expand Down
2 changes: 0 additions & 2 deletions src/Serializer.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@

/**
* Allows to serialize/de-serialize annotations from/to JSON.
*
* @see https://github.com/zircote/swagger-php
*/
class Serializer
{
Expand Down
4 changes: 2 additions & 2 deletions tools/src/Docs/RefGenerator.php
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ protected function propertyDetails(array $propertyDocumentation): void
{
echo '<p>' . nl2br($propertyDocumentation['content'] ?: self::NO_DETAILS_AVAILABLE) . '</p>';

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

if ($propertyDocumentation['see']) {
Expand All @@ -197,7 +197,7 @@ protected function propertyDetails(array $propertyDocumentation): void
}
}

echo '</table>';
echo '</tbody></table>';
}

/**
Expand Down
Loading