+ - webhook : string|null
+ Key for the webhooks map.
- path : string|null
+ Key for the Path Object (OpenApi->paths array).
- ref : string|class-string|object|null
+ No details available.
See: Using refs
- summary : string|null
+ An optional, string summary, intended to apply to all operations in this path.
- description : string|null
+ An optional, string description, intended to apply to all operations in this path.
- get : OpenApi\Attributes\Get|null
+ A definition of a GET operation on this path.
- put : OpenApi\Attributes\Put|null
+ A definition of a PUT operation on this path.
- post : OpenApi\Attributes\Post|null
+ A definition of a POST operation on this path.
- delete : OpenApi\Attributes\Delete|null
+ A definition of a DELETE operation on this path.
- options : OpenApi\Attributes\Options|null
+ A definition of a OPTIONS operation on this path.
- head : OpenApi\Attributes\Head|null
+ A definition of a HEAD operation on this path.
- patch : OpenApi\Attributes\Patch|null
+ A definition of a PATCH operation on this path.
- trace : OpenApi\Attributes\Trace|null
+ A definition of a TRACE operation on this path.
- servers : Server[]|null
+ An alternative server array to service all operations in this path.
- parameters : Parameter[]|null
+ A list of parameters that are applicable for all the operations described under this path.
+
+These parameters can be overridden at the operation level, but cannot be removed there.
+The list must not include duplicated parameters.
+A unique parameter is defined by a combination of a name and location.
+The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object's components/parameters.
- x : array<string,mixed>|null
+ While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
+For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions
+The keys inside the array will be prefixed with `x-`.
- attachables : Attachable[]|null
+ Arbitrary attachables for this annotation.
+These will be ignored but can be used for custom processing.
+
## [Xml](https://github.com/zircote/swagger-php/tree/master/src/Attributes/Xml.php)
diff --git a/docs/snippets/guide/cookbook/default_security_an.php b/docs/snippets/guide/cookbook/default_security_an.php
new file mode 100644
index 000000000..ac0140efd
--- /dev/null
+++ b/docs/snippets/guide/cookbook/default_security_an.php
@@ -0,0 +1,18 @@
+ []]]
+)]
+#[OAT\Components(
+ securitySchemes: [
+ new OAT\SecurityScheme(
+ securityScheme: 'bearerAuth',
+ type: 'http',
+ scheme: 'bearer'
+ )
+ ]
+)]
+class OpenApiSpec
+{
+}
diff --git a/docs/snippets/minimal_api_annotations.php b/docs/snippets/minimal_api_an.php
similarity index 80%
rename from docs/snippets/minimal_api_annotations.php
rename to docs/snippets/minimal_api_an.php
index f27ee9f68..16f1c74e6 100644
--- a/docs/snippets/minimal_api_annotations.php
+++ b/docs/snippets/minimal_api_an.php
@@ -8,9 +8,12 @@
* version="0.1"
* )
*/
-class OpenApi {}
+class OpenApi
+{
+}
-class MyController {
+class MyController
+{
/**
* @OA\Get(
@@ -21,7 +24,8 @@ class MyController {
* )
* )
*/
- public function getResource() {
+ public function getResource()
+ {
// ...
}
}
diff --git a/docs/snippets/minimal_api_attributes.php b/docs/snippets/minimal_api_at.php
similarity index 67%
rename from docs/snippets/minimal_api_attributes.php
rename to docs/snippets/minimal_api_at.php
index 1113cfb6a..cc4fc4825 100644
--- a/docs/snippets/minimal_api_attributes.php
+++ b/docs/snippets/minimal_api_at.php
@@ -3,13 +3,21 @@
use OpenApi\Attributes as OA;
#[OA\Info(title: "My First API", version: "0.1")]
-class OpenApi {}
+class OpenApi
+{
+}
-class MyController {
+class MyController
+{
#[OA\Get(path: '/api/data.json')]
#[OA\Response(response: '200', description: 'The data')]
- public function getResource() {
+ public function getResource()
+ {
// ...
}
}
+
+class OpenApiSpec
+{
+}
diff --git a/src/Context.php b/src/Context.php
index 58bdb4938..a42395f75 100644
--- a/src/Context.php
+++ b/src/Context.php
@@ -16,30 +16,30 @@
* Contexts are nested to reflect the code/parsing hierarchy. They include useful metadata
* which the processors can use to augment the annotations.
*
- * @property string|null $comment The PHP DocComment
- * @property string|null $filename
- * @property int|null $line
- * @property int|null $character
- * @property string|null $namespace
- * @property array|null $uses
- * @property string|null $class
- * @property string|null $interface
- * @property string|null $trait
- * @property string|null $enum
- * @property array|string|null $extends Interfaces may extend a list of interfaces
- * @property array|null $implements
- * @property string|null $method
- * @property string|null $property
- * @property string|\ReflectionType|null $type
- * @property bool|null $static Indicate a static method
- * @property bool|null $nullable Indicate a nullable value
- * @property bool|null $generated Indicate the context was generated by a processor or
- * the serializer
- * @property Annotations\AbstractAnnotation|null $nested
- * @property Annotations\AbstractAnnotation[]|null $annotations
- * @property LoggerInterface|null $logger Guaranteed to be set when using the `Generator`
- * @property array|null $scanned Details of file scanner when using ReflectionAnalyser
- * @property string|null $version The OpenAPI version in use
+ * @property string|null $comment The PHP DocComment
+ * @property string|null $filename
+ * @property int|null $line
+ * @property int|null $character
+ * @property string|null $namespace
+ * @property array|null $uses
+ * @property string|null $class
+ * @property string|null $interface
+ * @property string|null $trait
+ * @property string|null $enum
+ * @property array|string|null $extends Interfaces may extend a list of interfaces
+ * @property array|null $implements
+ * @property string|null $method
+ * @property string|null $property
+ * @property string|\ReflectionType|null $type
+ * @property bool|null $static Indicate a static method
+ * @property bool|null $nullable Indicate a nullable value
+ * @property bool|null $generated Indicate the context was generated by a processor or
+ * the serializer
+ * @property OA\AbstractAnnotation|null $nested
+ * @property OA\AbstractAnnotation[]|null $annotations
+ * @property LoggerInterface|null $logger Guaranteed to be set when using the `Generator`
+ * @property array|null $scanned Details of file scanner when using ReflectionAnalyser
+ * @property string|null $version The OpenAPI version in use
*/
#[\AllowDynamicProperties]
class Context
diff --git a/tests/Annotations/SecuritySchemesTest.php b/tests/Annotations/SecuritySchemesTest.php
index 342dc3e56..3b63c1ef8 100644
--- a/tests/Annotations/SecuritySchemesTest.php
+++ b/tests/Annotations/SecuritySchemesTest.php
@@ -79,7 +79,7 @@ public function testImplicitFlowAnnotation(): void
$annotations = $this->annotationsFromDocBlockParser($comment);
$this->assertCount(1, $annotations);
- /** @var \OpenApi\Annotations\SecurityScheme $security */
+ /** @var OA\SecurityScheme $security */
$security = $annotations[0];
$this->assertInstanceOf(OA\SecurityScheme::class, $security);
@@ -119,7 +119,7 @@ public function testMultipleAnnotations(): void
$annotations = $this->annotationsFromDocBlockParser($comment);
$this->assertCount(1, $annotations);
- /** @var \OpenApi\Annotations\SecurityScheme $security */
+ /** @var OA\SecurityScheme $security */
$security = $annotations[0];
$this->assertCount(2, $security->flows);
diff --git a/tests/Fixtures/TypedProperties.php b/tests/Fixtures/TypedProperties.php
index 69579239b..4b06f25b6 100644
--- a/tests/Fixtures/TypedProperties.php
+++ b/tests/Fixtures/TypedProperties.php
@@ -48,7 +48,7 @@ class TypedProperties
/**
* @OA\Property
*/
- public \OpenApi\Tests\Fixtures\TypedProperties $namespaced;
+ public TypedProperties $namespaced;
/**
* @OA\Property