Reference docs

Author: p1c2u

docs/reference/index.md

@@ -0,0 +1,3 @@
+# Reference
+
+Documentation with information of functions, classes or methods and all other parts of the OpenAPI-core public API.

docs/reference/openapi.md

@@ -0,0 +1,13 @@
+# `OpenAPI` class
+
+::: openapi_core.OpenAPI
+    options:
+        members:
+            - from_dict
+            - from_path
+            - from_file_path
+            - from_file
+            - unmarshal_request
+            - unmarshal_response
+            - validate_request
+            - validate_response

docs/reference/protocols.md

@@ -0,0 +1,13 @@
+# Protocols
+
+::: openapi_core.Request
+    options:
+      separate_signature: false
+
+::: openapi_core.WebhookRequest
+    options:
+      separate_signature: false
+
+::: openapi_core.Response
+    options:
+      separate_signature: false

mkdocs.yml

@@ -46,6 +46,24 @@ theme:
     - toc.follow
 repo_name: python-openapi/openapi-core
 repo_url: https://github.com/python-openapi/openapi-core
+plugins:
+  - mkdocstrings:
+      handlers:
+        python:
+          options:
+            extensions:
+              - griffe_typingdoc
+            show_root_heading: true
+            show_if_no_docstring: true
+            inherited_members: true
+            members_order: source
+            separate_signature: true
+            unwrap_annotated: true
+            merge_init_into_class: true
+            docstring_section_style: spacy
+            signature_crossrefs: true
+            show_symbol_type_heading: true
+            show_symbol_type_toc: true
 nav:
   - OpenAPI-core: index.md
   - unmarshalling.md
@@ -75,6 +93,10 @@ nav:
     - customizations/extra_format_unmarshallers.md
   - security.md
   - extensions.md
+  - Reference:
+    - reference/index.md
+    - reference/openapi.md
+    - reference/protocols.md
   - contributing.md
 markdown_extensions:
   - admonition

openapi_core/__init__.py

@@ -2,6 +2,9 @@
 
 from openapi_core.app import OpenAPI
 from openapi_core.configurations import Config
+from openapi_core.protocols import Request
+from openapi_core.protocols import Response
+from openapi_core.protocols import WebhookRequest
 from openapi_core.shortcuts import unmarshal_apicall_request
 from openapi_core.shortcuts import unmarshal_apicall_response
 from openapi_core.shortcuts import unmarshal_request
@@ -45,6 +48,9 @@
 __all__ = [
     "OpenAPI",
     "Config",
+    "Request",
+    "Response",
+    "WebhookRequest",
     "Spec",
     "unmarshal_request",
     "unmarshal_response",