Update external links to OpenAPI spec (#1685)

zircote · Jan 6, 2025 · ee69aa1 · ee69aa1
1 parent dc81ae3
commit ee69aa1
Show file tree

Hide file tree

Showing 27 changed files with 834 additions and 834 deletions.
diff --git a/docs/reference/annotations.md b/docs/reference/annotations.md
diff --git a/docs/reference/attributes.md b/docs/reference/attributes.md
diff --git a/src/Annotations/Components.php b/src/Annotations/Components.php
@@ -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
  */

diff --git a/src/Annotations/Contact.php b/src/Annotations/Contact.php
@@ -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
  */

diff --git a/src/Annotations/Discriminator.php b/src/Annotations/Discriminator.php
@@ -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

diff --git a/src/Annotations/Examples.php b/src/Annotations/Examples.php
@@ -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
      */

diff --git a/src/Annotations/ExternalDocumentation.php b/src/Annotations/ExternalDocumentation.php
@@ -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
  */

diff --git a/src/Annotations/Flow.php b/src/Annotations/Flow.php
@@ -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
  */

diff --git a/src/Annotations/Header.php b/src/Annotations/Header.php
@@ -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
  */
@@ -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
      */

diff --git a/src/Annotations/Info.php b/src/Annotations/Info.php
@@ -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
  */

diff --git a/src/Annotations/License.php b/src/Annotations/License.php
@@ -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
  */

diff --git a/src/Annotations/Link.php b/src/Annotations/Link.php
@@ -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
      */

diff --git a/src/Annotations/MediaType.php b/src/Annotations/MediaType.php
@@ -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
  */

diff --git a/src/Annotations/OpenApi.php b/src/Annotations/OpenApi.php
@@ -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
  */

diff --git a/src/Annotations/Operation.php b/src/Annotations/Operation.php
@@ -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
  */

diff --git a/src/Annotations/Parameter.php b/src/Annotations/Parameter.php
@@ -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
  */
@@ -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
      */

diff --git a/src/Annotations/PathItem.php b/src/Annotations/PathItem.php
@@ -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
      */

diff --git a/src/Annotations/RequestBody.php b/src/Annotations/RequestBody.php
@@ -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
  */
@@ -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
      */

diff --git a/src/Annotations/Response.php b/src/Annotations/Response.php
@@ -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
  */
@@ -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
      */
@@ -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.
      *

diff --git a/src/Annotations/Schema.php b/src/Annotations/Schema.php
@@ -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
@@ -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
      */
@@ -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
      */

diff --git a/src/Annotations/SecurityScheme.php b/src/Annotations/SecurityScheme.php
@@ -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
  */
@@ -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
      */

diff --git a/src/Annotations/Server.php b/src/Annotations/Server.php
@@ -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
  */

diff --git a/src/Annotations/ServerVariable.php b/src/Annotations/ServerVariable.php
@@ -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
  */

diff --git a/src/Annotations/Tag.php b/src/Annotations/Tag.php
@@ -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
  */

diff --git a/src/Annotations/Xml.php b/src/Annotations/Xml.php
@@ -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
  */

diff --git a/src/Serializer.php b/src/Serializer.php
@@ -11,8 +11,6 @@
 
 /**
  * Allows to serialize/de-serialize annotations from/to JSON.
- *
- * @see https://github.com/zircote/swagger-php
  */
 class Serializer
 {

diff --git a/tools/src/Docs/RefGenerator.php b/tools/src/Docs/RefGenerator.php
@@ -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']) {
@@ -197,7 +197,7 @@ protected function propertyDetails(array $propertyDocumentation): void
             }
         }
 
-        echo '</table>';
+        echo '</tbody></table>';
     }
 
     /**
-Original file 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 @@