jentic-openapi-datamodels 1.0.0a10__tar.gz

jentic_openapi_datamodels-1.0.0a10/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

jentic_openapi_datamodels-1.0.0a10/NOTICE

@@ -0,0 +1,4 @@
+Jentic OpenAPI Tools
+Copyright (c) 2025 Jentic
+Jentic OpenAPI Tools is licensed under Apache 2.0 license.
+Copy of the Apache 2.0 license can be found in `LICENSE` file.

jentic_openapi_datamodels-1.0.0a10/PKG-INFO

@@ -0,0 +1,52 @@
+Metadata-Version: 2.4
+Name: jentic-openapi-datamodels
+Version: 1.0.0a10
+Summary: Jentic OpenAPI Data Models
+Author: Jentic
+Author-email: Jentic <hello@jentic.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Requires-Python: >=3.11
+Project-URL: Homepage, https://github.com/jentic/jentic-openapi-tools
+Description-Content-Type: text/markdown
+
+# jentic-openapi-datamodels
+
+Low-level and high-level data models for OpenAPI specifications.
+
+## Overview
+
+This package provides data model classes for representing OpenAPI specification objects in Python. The models are designed to be:
+
+- **Dict-like**: Implement `MutableMapping` for easy data access
+- **Unvalidated**: Separate parsing from validation for performance
+- **Extensible**: Support OpenAPI specification extensions (x-* fields)
+- **Version-aware**: Currently implements OpenAPI 3.0.x (3.1.x planned)
+
+## Structure
+
+- `datamodels.low.v30`: Low-level models for OpenAPI 3.0.x
+
+## Usage
+
+```python
+from jentic.apitools.openapi.datamodels.low.v30 import Schema
+
+# Create a schema from raw data
+schema = Schema({
+    "type": "object",
+    "properties": {
+        "name": {"type": "string"}
+    }
+})
+
+# Access via properties
+print(schema.type)  # "object"
+
+# Access via dict
+print(schema["type"])  # "object"
+
+# Convert back to dict
+data = schema.to_mapping()
+```

jentic_openapi_datamodels-1.0.0a10/README.md

@@ -0,0 +1,39 @@
+# jentic-openapi-datamodels
+
+Low-level and high-level data models for OpenAPI specifications.
+
+## Overview
+
+This package provides data model classes for representing OpenAPI specification objects in Python. The models are designed to be:
+
+- **Dict-like**: Implement `MutableMapping` for easy data access
+- **Unvalidated**: Separate parsing from validation for performance
+- **Extensible**: Support OpenAPI specification extensions (x-* fields)
+- **Version-aware**: Currently implements OpenAPI 3.0.x (3.1.x planned)
+
+## Structure
+
+- `datamodels.low.v30`: Low-level models for OpenAPI 3.0.x
+
+## Usage
+
+```python
+from jentic.apitools.openapi.datamodels.low.v30 import Schema
+
+# Create a schema from raw data
+schema = Schema({
+    "type": "object",
+    "properties": {
+        "name": {"type": "string"}
+    }
+})
+
+# Access via properties
+print(schema.type)  # "object"
+
+# Access via dict
+print(schema["type"])  # "object"
+
+# Convert back to dict
+data = schema.to_mapping()
+```

jentic_openapi_datamodels-1.0.0a10/pyproject.toml

@@ -0,0 +1,25 @@
+[project]
+name = "jentic-openapi-datamodels"
+version = "1.0.0-alpha.10"
+description = "Jentic OpenAPI Data Models"
+readme = "README.md"
+authors = [{ name = "Jentic", email = "hello@jentic.com" }]
+license = "Apache-2.0"
+license-files = ["LICENSE", "NOTICE"]
+requires-python = ">=3.11"
+dependencies = []
+
+[project.urls]
+Homepage = "https://github.com/jentic/jentic-openapi-tools"
+
+[tool.uv]
+package = true
+
+[tool.uv.build-backend]
+namespace = true
+module-name = "jentic.apitools.openapi.datamodels"
+module-root = "src/"
+
+[build-system]
+requires = ["uv_build~=0.8.15"]
+build-backend = "uv_build"

jentic_openapi_datamodels-1.0.0a10/src/jentic/apitools/openapi/datamodels/low/v30/__init__.py

@@ -0,0 +1,28 @@
+"""OpenAPI 3.0.x low-level models."""
+
+from .discriminator import Discriminator
+from .external_documentation import ExternalDocumentation
+from .oauth_flow import OAuthFlow
+from .oauth_flows import OAuthFlows
+from .reference import Reference
+from .schema import Schema
+from .security_requirement import SecurityRequirement
+from .security_scheme import SecurityScheme
+from .specification_object import SpecificationObject
+from .tag import Tag
+from .xml import XML
+
+
+__all__ = [
+    "Discriminator",
+    "ExternalDocumentation",
+    "OAuthFlow",
+    "OAuthFlows",
+    "Reference",
+    "Schema",
+    "SecurityRequirement",
+    "SecurityScheme",
+    "SpecificationObject",
+    "Tag",
+    "XML",
+]

jentic_openapi_datamodels-1.0.0a10/src/jentic/apitools/openapi/datamodels/low/v30/discriminator.py

@@ -0,0 +1,91 @@
+"""
+OpenAPI 3.0.4 Discriminator Object model.
+
+When request bodies or response payloads may be one of a number of different schemas,
+a discriminator object gives a hint about the expected schema.
+"""
+
+from collections.abc import Mapping
+
+from jentic.apitools.openapi.datamodels.low.v30.specification_object import SpecificationObject
+
+
+__all__ = ["Discriminator"]
+
+
+class Discriminator(SpecificationObject):
+    """
+    Represents a Discriminator Object from OpenAPI 3.0.4.
+
+    Used to support polymorphism by indicating which property in a payload
+    is used to differentiate between schemas.
+
+    Supports specification extensions (x-* fields).
+
+    Example:
+        >>> # Basic discriminator
+        >>> disc = Discriminator({
+        ...     "propertyName": "petType"
+        ... })
+        >>> disc.property_name
+        'petType'
+
+        >>> # With mapping
+        >>> disc = Discriminator({
+        ...     "propertyName": "petType",
+        ...     "mapping": {
+        ...         "dog": "#/components/schemas/Dog",
+        ...         "cat": "#/components/schemas/Cat",
+        ...         "lizard": "https://example.com/schemas/Lizard.json"
+        ...     }
+        ... })
+        >>> disc.property_name
+        'petType'
+        >>> disc.mapping["dog"]
+        '#/components/schemas/Dog'
+    """
+
+    _supports_extensions: bool = True
+    _fixed_fields: frozenset[str] = frozenset({"propertyName", "mapping"})
+
+    @property
+    def property_name(self) -> str | None:
+        """
+        The name of the property in the payload to discriminate schemas.
+
+        REQUIRED field.
+
+        Returns:
+            Property name or None if not present
+        """
+        return self.get("propertyName")
+
+    @property_name.setter
+    def property_name(self, value: str | None) -> None:
+        """Set the property name."""
+        if value is None:
+            self.pop("propertyName", None)
+        else:
+            self["propertyName"] = value
+
+    @property
+    def mapping(self) -> dict[str, str]:
+        """
+        Mapping between payload values and schema names/references.
+
+        Maps discriminator property values to schema names or references.
+        When absent, the value is expected to match a schema name.
+
+        Returns:
+            Dictionary mapping values to schema references (empty dict if not present)
+        """
+        return self.get("mapping", {})
+
+    @mapping.setter
+    def mapping(self, value: Mapping[str, str] | None) -> None:
+        """Set the mapping."""
+        if value is None:
+            self.pop("mapping", None)
+        else:
+            # Convert to plain dict once at storage time
+            self["mapping"] = dict(value) if isinstance(value, Mapping) else value

jentic_openapi_datamodels-1.0.0a10/src/jentic/apitools/openapi/datamodels/low/v30/external_documentation.py

@@ -0,0 +1,79 @@
+"""
+OpenAPI 3.0.4 External Documentation Object model.
+
+Allows referencing an external resource for extended documentation.
+"""
+
+from jentic.apitools.openapi.datamodels.low.v30.specification_object import SpecificationObject
+
+
+__all__ = ["ExternalDocumentation"]
+
+
+class ExternalDocumentation(SpecificationObject):
+    """
+    Represents an External Documentation Object from OpenAPI 3.0.4.
+
+    Allows referencing an external resource for extended documentation.
+
+    Supports specification extensions (x-* fields).
+
+    Example:
+        >>> # Basic external docs
+        >>> docs = ExternalDocumentation({
+        ...     "url": "https://example.com/docs"
+        ... })
+        >>> docs.url
+        'https://example.com/docs'
+
+        >>> # With description
+        >>> docs = ExternalDocumentation({
+        ...     "description": "Find more info here",
+        ...     "url": "https://example.com/docs/api"
+        ... })
+        >>> docs.description
+        'Find more info here'
+        >>> docs.url
+        'https://example.com/docs/api'
+    """
+
+    _supports_extensions: bool = True
+    _fixed_fields: frozenset[str] = frozenset({"description", "url"})
+
+    @property
+    def description(self) -> str | None:
+        """
+        A description of the target documentation.
+
+        Returns:
+            Description or None if not present
+        """
+        return self.get("description")
+
+    @description.setter
+    def description(self, value: str | None) -> None:
+        """Set the description."""
+        if value is None:
+            self.pop("description", None)
+        else:
+            self["description"] = value
+
+    @property
+    def url(self) -> str | None:
+        """
+        The URL for the target documentation.
+
+        REQUIRED field.
+
+        Returns:
+            URL or None if not present
+        """
+        return self.get("url")
+
+    @url.setter
+    def url(self, value: str | None) -> None:
+        """Set the URL."""
+        if value is None:
+            self.pop("url", None)
+        else:
+            self["url"] = value

jentic_openapi_datamodels-1.0.0a10/src/jentic/apitools/openapi/datamodels/low/v30/oauth_flow.py

@@ -0,0 +1,140 @@
+"""
+OpenAPI 3.0.4 OAuth Flow Object model.
+
+Configuration details for a supported OAuth Flow as defined in RFC 6749.
+Different OAuth flows use different combinations of the fields.
+"""
+
+from collections.abc import Mapping
+
+from jentic.apitools.openapi.datamodels.low.v30.specification_object import SpecificationObject
+
+
+__all__ = ["OAuthFlow"]
+
+
+class OAuthFlow(SpecificationObject):
+    """
+    Represents an OAuth Flow Object from OpenAPI 3.0.4.
+
+    Configuration details for a supported OAuth Flow. Different flow types
+    (authorization code, implicit, password, client credentials) use different
+    combinations of these fields.
+
+    Supports specification extensions (x-* fields).
+
+    Example:
+        >>> # Authorization Code flow
+        >>> flow = OAuthFlow({
+        ...     "authorizationUrl": "https://example.com/oauth/authorize",
+        ...     "tokenUrl": "https://example.com/oauth/token",
+        ...     "scopes": {
+        ...         "read:pets": "Read access to pets",
+        ...         "write:pets": "Write access to pets"
+        ...     }
+        ... })
+        >>> flow.authorization_url
+        'https://example.com/oauth/authorize'
+        >>> flow.scopes
+        {'read:pets': 'Read access to pets', 'write:pets': 'Write access to pets'}
+
+        >>> # Implicit flow
+        >>> flow = OAuthFlow({
+        ...     "authorizationUrl": "https://example.com/oauth/authorize",
+        ...     "scopes": {"read": "Read access"}
+        ... })
+        >>> print(flow.token_url)
+        None
+
+        >>> # With extensions
+        >>> flow = OAuthFlow({
+        ...     "tokenUrl": "https://example.com/oauth/token",
+        ...     "scopes": {},
+        ...     "x-token-ttl": 3600
+        ... })
+        >>> flow.get_extensions()
+        {'x-token-ttl': 3600}
+    """
+
+    _supports_extensions: bool = True
+
+    @property
+    def authorization_url(self) -> str | None:
+        """
+        OAuth authorization endpoint URL.
+
+        REQUIRED for: authorizationCode, implicit flows.
+
+        Returns:
+            Authorization URL or None if not present
+        """
+        return self.get("authorizationUrl")
+
+    @authorization_url.setter
+    def authorization_url(self, value: str | None) -> None:
+        """Set the authorization URL."""
+        if value is None:
+            self.pop("authorizationUrl", None)
+        else:
+            self["authorizationUrl"] = value
+
+    @property
+    def token_url(self) -> str | None:
+        """
+        OAuth token endpoint URL.
+
+        REQUIRED for: authorizationCode, password, clientCredentials flows.
+
+        Returns:
+            Token URL or None if not present
+        """
+        return self.get("tokenUrl")
+
+    @token_url.setter
+    def token_url(self, value: str | None) -> None:
+        """Set the token URL."""
+        if value is None:
+            self.pop("tokenUrl", None)
+        else:
+            self["tokenUrl"] = value
+
+    @property
+    def refresh_url(self) -> str | None:
+        """
+        OAuth refresh token endpoint URL (optional for all flows).
+
+        Returns:
+            Refresh URL or None if not present
+        """
+        return self.get("refreshUrl")
+
+    @refresh_url.setter
+    def refresh_url(self, value: str | None) -> None:
+        """Set the refresh URL."""
+        if value is None:
+            self.pop("refreshUrl", None)
+        else:
+            self["refreshUrl"] = value
+
+    @property
+    def scopes(self) -> dict[str, str]:
+        """
+        Available scopes for the OAuth2 security scheme.
+
+        Maps scope names to their descriptions. REQUIRED for all flows.
+
+        Returns:
+            Dictionary mapping scope names to descriptions (empty dict if not present)
+        """
+        scopes = self.get("scopes")
+        if scopes is None:
+            return {}
+        return dict(scopes) if isinstance(scopes, Mapping) else {}
+
+    @scopes.setter
+    def scopes(self, value: dict[str, str] | Mapping[str, str] | None) -> None:
+        """Set the scopes mapping."""
+        if value is None:
+            self.pop("scopes", None)
+        else:
+            self["scopes"] = dict(value) if isinstance(value, Mapping) else value