Configuration.md - Add 'openapi' section (#1249)

* * Add openapi configuration section

* Apply suggestions from code review

Co-authored-by: Alan Poulain <[email protected]>

Co-authored-by: Jan Christoph Beyer <[email protected]>
Co-authored-by: Antoine Bluchet <[email protected]>
Co-authored-by: Alan Poulain <[email protected]>

Author: 4 people

core/configuration.md

@@ -199,6 +199,24 @@ api_platform:
             # Whether the api key should be a query parameter or a header.
             # type: 'query' or 'header'
 
+    openapi:
+        # The contact information for the exposed API.
+        contact:
+            # The identifying name of the contact person/organization.
+            name:
+            # The URL pointing to the contact information. MUST be in the format of a URL.
+            url:
+            # The email address of the contact person/organization. MUST be in the format of an email address.
+            email:
+        # A URL to the Terms of Service for the API. MUST be in the format of a URL.
+        termsOfService:
+        # The license information for the exposed API.
+        license:
+            # The license name used for the API.
+            name:
+            # URL to the license used for the API. MUST be in the format of a URL.
+            url:       
+        
     http_cache:
         # Automatically generate etags for API responses.
         etag: true

core/openapi.md

@@ -485,3 +485,37 @@ api_platform:
 ```
 
 Note that `clientId` and `clientSecret` are being used by the SwaggerUI if enabled.
+## Info Object
+
+The [info object](https://swagger.io/specification/#info-object) provides metadata about the API like licensing information or a contact. You can specify this information using API Platform's configuration:
+
+```
+api_platform:
+    
+    # The title of the API.
+    title: 'API title'
+
+    # The description of the API.
+    description: 'API description'
+
+    # The version of the API.
+    version: '0.0.0'
+    
+    openapi:
+        # The contact information for the exposed API.
+        contact:
+            # The identifying name of the contact person/organization.
+            name:
+            # The URL pointing to the contact information. MUST be in the format of a URL.
+            url:
+            # The email address of the contact person/organization. MUST be in the format of an email address.
+            email:
+        # A URL to the Terms of Service for the API. MUST be in the format of a URL.
+        termsOfService:
+        # The license information for the exposed API.
+        license:
+            # The license name used for the API.
+            name:
+            # URL to the license used for the API. MUST be in the format of a URL.
+            url: 
+```