eoap-problems-registry 1.0.0__py3-none-any.whl

eoap_problems_registry/__about__.py

@@ -0,0 +1,15 @@
+# Copyright 2026 EOAP
+#
+# 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.
+
+__version__ = "1.0.0"

eoap_problems_registry/__init__.py

@@ -0,0 +1,695 @@
+# Copyright 2026 EOAP
+#
+# 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.
+
+# generated by datamodel-codegen:
+#   filename:  schema.yaml
+#   timestamp: 2026-07-02T10:01:38+00:00
+
+from __future__ import annotations
+from pydantic import BaseModel
+from pydantic import ConfigDict, Field, RootModel
+from typing import Literal
+
+
+class ErrorDetail(BaseModel):
+    """
+    An object to provide explicit details on a problem towards an API consumer.
+    """
+
+    model_config = ConfigDict(
+        extra="allow",
+        populate_by_name=True,
+    )
+    detail: str = Field(..., max_length=4096)
+    """
+    A granular description on the specific error related to a body property, query parameter, path parameters, and/or header.
+    """
+    pointer: str | None = Field(None, max_length=1024)
+    """
+    A JSON Pointer to a specific request body property that is the source of error.
+    """
+    parameter: str | None = Field(None, max_length=1024)
+    """
+    The name of the query or path parameter that is the source of error.
+    """
+    header: str | None = Field(None, max_length=1024)
+    """
+    The name of the header that is the source of error.
+    """
+    code: str | None = Field(None, max_length=50)
+    """
+    A string containing additional provider specific codes to identify the error context.
+    """
+
+
+class ProblemDetails(BaseModel):
+    """
+    The `ProblemDetails` object provides detailed information about an errors that occurred during an API call execution. This problem object conforms to the [RFC9457](https://www.rfc-editor.org/info/rfc9457) (formerly [RFC7807](https://tools.ietf.org/html/rfc7807)).
+    The object is extended with the following properties: - `code` - a string identifier to aid the provider team better understand the error - `errors` - and array of errors providing contextual information on the root cause of the problem
+    The `ProblemDetails` referenced by this domain utilize the [EOAP Problems Registry](https://eoap.github.io/problems-registry/).
+    """
+
+    model_config = ConfigDict(
+        extra="allow",
+        populate_by_name=True,
+    )
+    instance: str | None = Field(None, max_length=1024)
+    """
+    A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
+    """
+    code: str | None = Field(None, max_length=50)
+    """
+    An API specific error code aiding the provider team understand the error based on their own potential taxonomy or registry.
+    """
+    errors: list[ErrorDetail] | None = Field(None, max_length=1000)
+    """
+    An array of error details to accompany a problem details response.
+    """
+
+
+class AlreadyExists(ProblemDetails):
+    model_config = ConfigDict(
+        extra="allow",
+        populate_by_name=True,
+    )
+    type: Literal["https://eoap.github.io/problems-registry/already-exists"] = (
+        "https://eoap.github.io/problems-registry/already-exists"
+    )
+    """
+    A URI reference that identifies the problem type.
+    """
+    status: Literal[409] = 409
+    """
+    The HTTP status code generated by the origin server for this occurrence of the problem.
+    """
+    title: Literal["Already exists"] = "Already exists"
+    """
+    A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+    """
+    detail: Literal["The resource being created already exists."] = (
+        "The resource being created already exists."
+    )
+    """
+    A human-readable explanation specific to this occurrence of the problem.
+    """
+
+
+class BadRequest(ProblemDetails):
+    model_config = ConfigDict(
+        extra="allow",
+        populate_by_name=True,
+    )
+    type: Literal["https://eoap.github.io/problems-registry/bad-request"] = (
+        "https://eoap.github.io/problems-registry/bad-request"
+    )
+    """
+    A URI reference that identifies the problem type.
+    """
+    status: Literal[400] = 400
+    """
+    The HTTP status code generated by the origin server for this occurrence of the problem.
+    """
+    title: Literal["Bad Request"] = "Bad Request"
+    """
+    A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+    """
+    detail: Literal["The request is invalid or malformed."] = (
+        "The request is invalid or malformed."
+    )
+    """
+    A human-readable explanation specific to this occurrence of the problem.
+    """
+
+
+class BusinessRuleViolation(ProblemDetails):
+    model_config = ConfigDict(
+        extra="allow",
+        populate_by_name=True,
+    )
+    type: Literal[
+        "https://eoap.github.io/problems-registry/business-rule-violation"
+    ] = "https://eoap.github.io/problems-registry/business-rule-violation"
+    """
+    A URI reference that identifies the problem type.
+    """
+    status: Literal[422] = 422
+    """
+    The HTTP status code generated by the origin server for this occurrence of the problem.
+    """
+    title: Literal["Business Rule Violation"] = "Business Rule Violation"
+    """
+    A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+    """
+    detail: Literal["The request body is invalid and not meeting business rules."] = (
+        "The request body is invalid and not meeting business rules."
+    )
+    """
+    A human-readable explanation specific to this occurrence of the problem.
+    """
+
+
+class InvalidStateTransition(ProblemDetails):
+    model_config = ConfigDict(
+        extra="allow",
+        populate_by_name=True,
+    )
+    type: Literal[
+        "https://eoap.github.io/problems-registry/invalid-state-transition"
+    ] = "https://eoap.github.io/problems-registry/invalid-state-transition"
+    """
+    A URI reference that identifies the problem type.
+    """
+    status: Literal[422] = 422
+    """
+    The HTTP status code generated by the origin server for this occurrence of the problem.
+    """
+    title: Literal["Invalid State Transition"] = "Invalid State Transition"
+    """
+    A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+    """
+    detail: Literal[
+        "The requested transition is not valid for the current item status."
+    ] = "The requested transition is not valid for the current item status."
+    """
+    A human-readable explanation specific to this occurrence of the problem.
+    """
+
+
+class Forbidden(ProblemDetails):
+    model_config = ConfigDict(
+        extra="allow",
+        populate_by_name=True,
+    )
+    type: Literal["https://eoap.github.io/problems-registry/forbidden"] = (
+        "https://eoap.github.io/problems-registry/forbidden"
+    )
+    """
+    A URI reference that identifies the problem type.
+    """
+    status: Literal[403] = 403
+    """
+    The HTTP status code generated by the origin server for this occurrence of the problem.
+    """
+    title: Literal["Forbidden"] = "Forbidden"
+    """
+    A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+    """
+    detail: Literal[
+        "The resource could not be returned as the requestor is not authorized."
+    ] = "The resource could not be returned as the requestor is not authorized."
+    """
+    A human-readable explanation specific to this occurrence of the problem.
+    """
+
+
+class InvalidBodyPropertyFormat(ProblemDetails):
+    model_config = ConfigDict(
+        extra="allow",
+        populate_by_name=True,
+    )
+    type: Literal[
+        "https://eoap.github.io/problems-registry/invalid-body-property-format"
+    ] = "https://eoap.github.io/problems-registry/invalid-body-property-format"
+    """
+    A URI reference that identifies the problem type.
+    """
+    status: Literal[400] = 400
+    """
+    The HTTP status code generated by the origin server for this occurrence of the problem.
+    """
+    title: Literal["Invalid Body Property Format"] = "Invalid Body Property Format"
+    """
+    A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+    """
+    detail: Literal["The request body contains a malformed property."] = (
+        "The request body contains a malformed property."
+    )
+    """
+    A human-readable explanation specific to this occurrence of the problem.
+    """
+
+
+class InvalidBodyPropertyValue(ProblemDetails):
+    model_config = ConfigDict(
+        extra="allow",
+        populate_by_name=True,
+    )
+    type: Literal[
+        "https://eoap.github.io/problems-registry/invalid-body-property-value"
+    ] = "https://eoap.github.io/problems-registry/invalid-body-property-value"
+    """
+    A URI reference that identifies the problem type.
+    """
+    status: Literal[400] = 400
+    """
+    The HTTP status code generated by the origin server for this occurrence of the problem.
+    """
+    title: Literal["Invalid Body Property Value"] = "Invalid Body Property Value"
+    """
+    A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+    """
+    detail: Literal["The request body contains an invalid body property value."] = (
+        "The request body contains an invalid body property value."
+    )
+    """
+    A human-readable explanation specific to this occurrence of the problem.
+    """
+
+
+class InvalidParameters(ProblemDetails):
+    model_config = ConfigDict(
+        extra="allow",
+        populate_by_name=True,
+    )
+    type: Literal["https://eoap.github.io/problems-registry/invalid-parameters"] = (
+        "https://eoap.github.io/problems-registry/invalid-parameters"
+    )
+    """
+    A URI reference that identifies the problem type.
+    """
+    status: Literal[400] = 400
+    """
+    The HTTP status code generated by the origin server for this occurrence of the problem.
+    """
+    title: Literal["Invalid parameters"] = "Invalid parameters"
+    """
+    A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+    """
+    detail: Literal[
+        "The request contained invalid, or malformed parameters (path or header or query)."
+    ] = "The request contained invalid, or malformed parameters (path or header or query)."
+    """
+    A human-readable explanation specific to this occurrence of the problem.
+    """
+
+
+class InvalidRequestHeaderFormat(ProblemDetails):
+    model_config = ConfigDict(
+        extra="allow",
+        populate_by_name=True,
+    )
+    type: Literal[
+        "https://eoap.github.io/problems-registry/invalid-request-header-format"
+    ] = "https://eoap.github.io/problems-registry/invalid-request-header-format"
+    """
+    A URI reference that identifies the problem type.
+    """
+    status: Literal[400] = 400
+    """
+    The HTTP status code generated by the origin server for this occurrence of the problem.
+    """
+    title: Literal["Invalid Request Header Format"] = "Invalid Request Header Format"
+    """
+    A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+    """
+    detail: Literal["The request contains a malformed request header parameter."] = (
+        "The request contains a malformed request header parameter."
+    )
+    """
+    A human-readable explanation specific to this occurrence of the problem.
+    """
+
+
+class InvalidRequestParameterFormat(ProblemDetails):
+    model_config = ConfigDict(
+        extra="allow",
+        populate_by_name=True,
+    )
+    type: Literal[
+        "https://eoap.github.io/problems-registry/invalid-request-parameter-format"
+    ] = "https://eoap.github.io/problems-registry/invalid-request-parameter-format"
+    """
+    A URI reference that identifies the problem type.
+    """
+    status: Literal[400] = 400
+    """
+    The HTTP status code generated by the origin server for this occurrence of the problem.
+    """
+    title: Literal["Invalid Request Parameter Format"] = (
+        "Invalid Request Parameter Format"
+    )
+    """
+    A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+    """
+    detail: Literal["The request contains a malformed request query parameter."] = (
+        "The request contains a malformed request query parameter."
+    )
+    """
+    A human-readable explanation specific to this occurrence of the problem.
+    """
+
+
+class InvalidRequestParameterValue(ProblemDetails):
+    model_config = ConfigDict(
+        extra="allow",
+        populate_by_name=True,
+    )
+    type: Literal[
+        "https://eoap.github.io/problems-registry/invalid-request-parameter-value"
+    ] = "https://eoap.github.io/problems-registry/invalid-request-parameter-value"
+    """
+    A URI reference that identifies the problem type.
+    """
+    status: Literal[400] = 400
+    """
+    The HTTP status code generated by the origin server for this occurrence of the problem.
+    """
+    title: Literal["Invalid Request Parameter Value"] = (
+        "Invalid Request Parameter Value"
+    )
+    """
+    A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+    """
+    detail: Literal["The request body contains an invalid request parameter value."] = (
+        "The request body contains an invalid request parameter value."
+    )
+    """
+    A human-readable explanation specific to this occurrence of the problem.
+    """
+
+
+class LicenseCancelled(ProblemDetails):
+    model_config = ConfigDict(
+        extra="allow",
+        populate_by_name=True,
+    )
+    type: Literal["https://eoap.github.io/problems-registry/license-cancelled"] = (
+        "https://eoap.github.io/problems-registry/license-cancelled"
+    )
+    """
+    A URI reference that identifies the problem type.
+    """
+    status: Literal[503] = 503
+    """
+    The HTTP status code generated by the origin server for this occurrence of the problem.
+    """
+    title: Literal["License Cancelled"] = "License Cancelled"
+    """
+    A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+    """
+    detail: Literal[
+        "The service is unavailable as the license associated with your client or organization has been cancelled. Please contact your account manager or representative."
+    ] = "The service is unavailable as the license associated with your client or organization has been cancelled. Please contact your account manager or representative."
+    """
+    A human-readable explanation specific to this occurrence of the problem.
+    """
+
+
+class LicenseExpired(ProblemDetails):
+    model_config = ConfigDict(
+        extra="allow",
+        populate_by_name=True,
+    )
+    type: Literal["https://eoap.github.io/problems-registry/license-expired"] = (
+        "https://eoap.github.io/problems-registry/license-expired"
+    )
+    """
+    A URI reference that identifies the problem type.
+    """
+    status: Literal[503] = 503
+    """
+    The HTTP status code generated by the origin server for this occurrence of the problem.
+    """
+    title: Literal["License Expired"] = "License Expired"
+    """
+    A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+    """
+    detail: Literal[
+        "The service is unavailable as the license associated with your client or organization has expired. Please contact your account manager or representative."
+    ] = "The service is unavailable as the license associated with your client or organization has expired. Please contact your account manager or representative."
+    """
+    A human-readable explanation specific to this occurrence of the problem.
+    """
+
+
+class MissingBodyProperty(ProblemDetails):
+    model_config = ConfigDict(
+        extra="allow",
+        populate_by_name=True,
+    )
+    type: Literal["https://eoap.github.io/problems-registry/missing-body-property"] = (
+        "https://eoap.github.io/problems-registry/missing-body-property"
+    )
+    """
+    A URI reference that identifies the problem type.
+    """
+    status: Literal[400] = 400
+    """
+    The HTTP status code generated by the origin server for this occurrence of the problem.
+    """
+    title: Literal["Missing body property"] = "Missing body property"
+    """
+    A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+    """
+    detail: Literal["The request is missing an expected body property."] = (
+        "The request is missing an expected body property."
+    )
+    """
+    A human-readable explanation specific to this occurrence of the problem.
+    """
+
+
+class MissingRequestHeader(ProblemDetails):
+    model_config = ConfigDict(
+        extra="allow",
+        populate_by_name=True,
+    )
+    type: Literal["https://eoap.github.io/problems-registry/missing-request-header"] = (
+        "https://eoap.github.io/problems-registry/missing-request-header"
+    )
+    """
+    A URI reference that identifies the problem type.
+    """
+    status: Literal[400] = 400
+    """
+    The HTTP status code generated by the origin server for this occurrence of the problem.
+    """
+    title: Literal["Missing request header"] = "Missing request header"
+    """
+    A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+    """
+    detail: Literal["The request is missing an expected HTTP request header."] = (
+        "The request is missing an expected HTTP request header."
+    )
+    """
+    A human-readable explanation specific to this occurrence of the problem.
+    """
+
+
+class MissingRequestParameter(ProblemDetails):
+    model_config = ConfigDict(
+        extra="allow",
+        populate_by_name=True,
+    )
+    type: Literal[
+        "https://eoap.github.io/problems-registry/missing-request-parameter"
+    ] = "https://eoap.github.io/problems-registry/missing-request-parameter"
+    """
+    A URI reference that identifies the problem type.
+    """
+    status: Literal[400] = 400
+    """
+    The HTTP status code generated by the origin server for this occurrence of the problem.
+    """
+    title: Literal["Missing request parameter"] = "Missing request parameter"
+    """
+    A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+    """
+    detail: Literal["The request is missing an expected query or path parameter."] = (
+        "The request is missing an expected query or path parameter."
+    )
+    """
+    A human-readable explanation specific to this occurrence of the problem.
+    """
+
+
+class NotFound(ProblemDetails):
+    model_config = ConfigDict(
+        extra="allow",
+        populate_by_name=True,
+    )
+    type: Literal["https://eoap.github.io/problems-registry/not-found"] = (
+        "https://eoap.github.io/problems-registry/not-found"
+    )
+    """
+    A URI reference that identifies the problem type.
+    """
+    status: Literal[404] = 404
+    """
+    The HTTP status code generated by the origin server for this occurrence of the problem.
+    """
+    title: Literal["Not Found"] = "Not Found"
+    """
+    A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+    """
+    detail: Literal["The requested resource was not found."] = (
+        "The requested resource was not found."
+    )
+    """
+    A human-readable explanation specific to this occurrence of the problem.
+    """
+
+
+class ServerError(ProblemDetails):
+    model_config = ConfigDict(
+        extra="allow",
+        populate_by_name=True,
+    )
+    type: Literal["https://eoap.github.io/problems-registry/server-error"] = (
+        "https://eoap.github.io/problems-registry/server-error"
+    )
+    """
+    A URI reference that identifies the problem type.
+    """
+    status: Literal[500] = 500
+    """
+    The HTTP status code generated by the origin server for this occurrence of the problem.
+    """
+    title: Literal["Server Error"] = "Server Error"
+    """
+    A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+    """
+    detail: Literal["The server encountered an unexpected error."] = (
+        "The server encountered an unexpected error."
+    )
+    """
+    A human-readable explanation specific to this occurrence of the problem.
+    """
+
+
+class ServiceUnavailable(ProblemDetails):
+    model_config = ConfigDict(
+        extra="allow",
+        populate_by_name=True,
+    )
+    type: Literal["https://eoap.github.io/problems-registry/service-unavailable"] = (
+        "https://eoap.github.io/problems-registry/service-unavailable"
+    )
+    """
+    A URI reference that identifies the problem type.
+    """
+    status: Literal[503] = 503
+    """
+    The HTTP status code generated by the origin server for this occurrence of the problem.
+    """
+    title: Literal["Service Unavailable"] = "Service Unavailable"
+    """
+    A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+    """
+    detail: Literal["The service is currently unavailable."] = (
+        "The service is currently unavailable."
+    )
+    """
+    A human-readable explanation specific to this occurrence of the problem.
+    """
+
+
+class Unauthorized(ProblemDetails):
+    model_config = ConfigDict(
+        extra="allow",
+        populate_by_name=True,
+    )
+    type: Literal["https://eoap.github.io/problems-registry/unauthorized"] = (
+        "https://eoap.github.io/problems-registry/unauthorized"
+    )
+    """
+    A URI reference that identifies the problem type.
+    """
+    status: Literal[401] = 401
+    """
+    The HTTP status code generated by the origin server for this occurrence of the problem.
+    """
+    title: Literal["Unauthorized"] = "Unauthorized"
+    """
+    A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+    """
+    detail: Literal[
+        "Access token not set or invalid, and the requested resource could not be returned."
+    ] = "Access token not set or invalid, and the requested resource could not be returned."
+    """
+    A human-readable explanation specific to this occurrence of the problem.
+    """
+
+
+class ValidationError(ProblemDetails):
+    model_config = ConfigDict(
+        extra="allow",
+        populate_by_name=True,
+    )
+    type: Literal["https://eoap.github.io/problems-registry/validation-error"] = (
+        "https://eoap.github.io/problems-registry/validation-error"
+    )
+    """
+    A URI reference that identifies the problem type.
+    """
+    status: Literal[422] = 422
+    """
+    The HTTP status code generated by the origin server for this occurrence of the problem.
+    """
+    title: Literal["Validation Error"] = "Validation Error"
+    """
+    A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+    """
+    detail: Literal["The request is not valid."] = "The request is not valid."
+    """
+    A human-readable explanation specific to this occurrence of the problem.
+    """
+
+
+class EoapProblemDetailsRegistry(
+    RootModel[
+        AlreadyExists
+        | BadRequest
+        | BusinessRuleViolation
+        | Forbidden
+        | InvalidBodyPropertyFormat
+        | InvalidBodyPropertyValue
+        | InvalidParameters
+        | InvalidRequestHeaderFormat
+        | InvalidRequestParameterFormat
+        | InvalidRequestParameterValue
+        | LicenseCancelled
+        | LicenseExpired
+        | MissingBodyProperty
+        | MissingRequestHeader
+        | MissingRequestParameter
+        | NotFound
+        | ServerError
+        | ServiceUnavailable
+        | Unauthorized
+        | ValidationError
+    ]
+):
+    root: (
+        AlreadyExists
+        | BadRequest
+        | BusinessRuleViolation
+        | Forbidden
+        | InvalidBodyPropertyFormat
+        | InvalidBodyPropertyValue
+        | InvalidParameters
+        | InvalidRequestHeaderFormat
+        | InvalidRequestParameterFormat
+        | InvalidRequestParameterValue
+        | LicenseCancelled
+        | LicenseExpired
+        | MissingBodyProperty
+        | MissingRequestHeader
+        | MissingRequestParameter
+        | NotFound
+        | ServerError
+        | ServiceUnavailable
+        | Unauthorized
+        | ValidationError
+    ) = Field(..., title="EOAP Problem Details Registry")

eoap_problems_registry-1.0.0.dist-info/METADATA

@@ -0,0 +1,188 @@
+Metadata-Version: 2.4
+Name: eoap-problems-registry
+Version: 1.0.0
+Summary: EOAP Problems Registry
+Project-URL: Documentation, https://eoap.github.io/problems-registry/
+Project-URL: Issues, https://github.com/eoap/problems-registry/issues
+Project-URL: Source, https://github.com/eoap/problems-registry
+Author-email: Fabrice Brito <info@terradue.com>, Simone Tripodi <info@terradue.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.8
+Requires-Dist: pydantic==2.13.4
+Description-Content-Type: text/markdown
+
+# EOAP Problems Registry
+
+[![PyPI - Version](https://img.shields.io/pypi/v/eoap-problems-registry.svg)](https://pypi.org/project/eoap-problems-registry)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/eoap-problems-registry.svg)](https://pypi.org/project/eoap-problems-registry)
+
+[EOAP Problems Registry](https://eoap.github.io/problems-registry/) is a shared registry of API problem detail types for EOAP services. The problem responses conform to [RFC 9457](https://www.rfc-editor.org/info/rfc9457), formerly [RFC 7807](https://www.rfc-editor.org/info/rfc7807), and are published as documentation, JSON Schema/OpenAPI artifacts, and a Python package with generated Pydantic models.
+
+The registry is intended to give API providers and consumers a common vocabulary for reusable `application/problem+json` responses.
+
+## What Is Included
+
+- `schemas/schema.yaml`: JSON Schema definitions for the common `ProblemDetails`, `ErrorDetail`, and each registered EOAP problem type.
+- `schemas/openapi.yaml`: reusable OpenAPI 3.1 response components and examples that reference the JSON Schema definitions.
+- `src/eoap_problems_registry`: generated Pydantic models for the registry.
+- `docs/`: MkDocs pages for each problem type, plus generated JSON Schema and OpenAPI documentation.
+- `tests/`: unit tests that verify generated problem models and extension behavior.
+- `.github/workflows/`: documentation deployment, package CI, and PyPI release automation.
+
+## Registered Problems
+
+EOAP-specific problem types:
+
+| Problem type | HTTP status |
+| --- | --- |
+| Already Exists | 409 |
+| Missing Body Property | 400 |
+| Missing Request Header | 400 |
+| Missing Request Parameter | 400 |
+| Invalid Body Property Format | 400 |
+| Invalid Request Parameter Format | 400 |
+| Invalid Request Header Format | 400 |
+| Invalid Body Property Value | 400 |
+| Invalid Request Parameter Value | 400 |
+| Validation Error | 422 |
+| Business Rule Violation | 422 |
+| License Expired | 503 |
+| License Cancelled | 503 |
+
+Common convenience problem types:
+
+| Problem type | HTTP status |
+| --- | --- |
+| Bad Request | 400 |
+| Unauthorized | 401 |
+| Forbidden | 403 |
+| Not Found | 404 |
+| Invalid Parameters | 400 |
+| Server Error | 500 |
+| Service Unavailable | 503 |
+
+For generic/common HTTP problem types, prefer the [IANA HTTP Problem Types registry](https://www.iana.org/assignments/http-problem-types/http-problem-types.xhtml) when it fits your use case.
+
+## Python Usage
+
+Install the package in an environment with Pydantic 2:
+
+```bash
+pip install eoap-problems-registry
+```
+
+Use the generated models to build responses with fixed registry fields and optional extension members:
+
+```python
+import eoap_problems_registry as registry
+
+problem = registry.MissingRequestParameter(
+    instance="https://api.example.test/problems/abc123",
+    code="400-03",
+    errors=[
+        registry.ErrorDetail(
+            detail="The query parameter limit is required.",
+            parameter="limit",
+        )
+    ],
+    correlation_id="req-123",
+)
+
+payload = problem.model_dump(mode="json", exclude_none=True)
+```
+
+The resulting payload includes the registered `type`, `status`, `title`, and `detail` values:
+
+```json
+{
+  "instance": "https://api.example.test/problems/abc123",
+  "code": "400-03",
+  "errors": [
+    {
+      "detail": "The query parameter limit is required.",
+      "parameter": "limit"
+    }
+  ],
+  "type": "https://eoap.github.io/problems-registry/missing-request-parameter",
+  "status": 400,
+  "title": "Missing request parameter",
+  "detail": "The request is missing an expected query or path parameter.",
+  "correlation_id": "req-123"
+}
+```
+
+`ProblemDetails` and `ErrorDetail` allow additional provider-specific fields, while generated problem classes use Pydantic literal fields to protect the registered `type`, `status`, `title`, and `detail` values.
+
+## Schemas And OpenAPI
+
+Use the schema and OpenAPI files directly when integrating the registry into API descriptions:
+
+- JSON Schema definitions: [`schemas/schema.yaml`](schemas/schema.yaml)
+- OpenAPI response components and examples: [`schemas/openapi.yaml`](schemas/openapi.yaml)
+- Published documentation: <https://eoap.github.io/problems-registry/>
+
+When a response needs more context, include an `errors` array. Each item must contain `detail` and may include `pointer`, `parameter`, `header`, `code`, or provider-specific extension fields.
+
+## Development
+
+This repository uses Hatch for Python environments, Ruff for formatting/linting, MkDocs for documentation, and Taskfile tasks for generated artifacts.
+
+Useful commands:
+
+```bash
+hatch run test:test
+hatch run test:testv
+hatch run test:cov
+hatch run dev:lint
+hatch run dev:check
+task process_schema
+task generate_openapi_docs
+task serve_docs
+```
+
+`task process_schema` regenerates the Pydantic models in `src/eoap_problems_registry/__init__.py` and the JSON Schema documentation in `docs/json-schema.md`.
+
+`task generate_openapi_docs` regenerates the static OpenAPI documentation under `docs/openapi/`.
+
+`task serve_docs` starts the MkDocs site locally.
+
+## Contributing Problem Types
+
+To add or update a problem type:
+
+1. Update `schemas/schema.yaml` with the JSON Schema definition under `$defs`.
+2. Update `schemas/openapi.yaml` if the problem should be exposed through reusable OpenAPI response components or examples.
+3. Add or update the matching Markdown page in `docs/`.
+4. Add the page to the `nav` section in `mkdocs.yaml`.
+5. Run `task process_schema` to regenerate the Python models and schema docs.
+6. Run `task generate_openapi_docs` if OpenAPI components or examples changed.
+7. Add or update tests in `tests/` when generated behavior changes.
+8. Run the test and lint commands before opening a pull request.
+
+Problem type URIs should use the published registry base URL:
+
+```text
+https://eoap.github.io/problems-registry/{problem-name}
+```
+
+Use hyphen-separated names for problem page filenames and URI suffixes, for example `missing-body-property`.
+
+## CI And Releases
+
+The package workflow runs Ruff and the unit test suite on Python 3.10 through 3.14 for pushes and pull requests targeting the active development branches. Version tags matching `v*.*.*` build and publish the package to PyPI after verifying that the tag version matches `hatch version`.
+
+The docs workflow publishes the MkDocs site to GitHub Pages when documentation-related files change on `docs`, `develop`, or `main`.
+
+## License
+
+[![Apache License, Version 2.0](https://img.shields.io/badge/license-Apache%20License%202.0-blue)](https://www.apache.org/licenses/LICENSE-2.0)

eoap_problems_registry-1.0.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+eoap_problems_registry/__about__.py,sha256=f3IRf3CBO4uARSCEumpBE9Su29QRZUHpjga30bIMEvM,591
+eoap_problems_registry/__init__.py,sha256=aOQK6fvLmwEMfw1JDG7A37h2YZoDpmRGYMqcmQBMIKY,25796
+eoap_problems_registry-1.0.0.dist-info/METADATA,sha256=ZRabItztDhVJ7vlyLtk7w74tCNpfwFfBxoznMXMSMvI,7604
+eoap_problems_registry-1.0.0.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
+eoap_problems_registry-1.0.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+eoap_problems_registry-1.0.0.dist-info/RECORD,,

eoap_problems_registry-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.31.0
+Root-Is-Purelib: true
+Tag: py3-none-any

eoap_problems_registry-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 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.