feat: collect py-jwt wiki; register wiki kind; refresh lib and mcp artifacts
Adds the py-jwt wiki to the hub alongside lib and mcp and picks up the regenerated flat lib reference and standardized MCP modules.
This commit is contained in:
@@ -4,32 +4,18 @@
|
||||
"path": "jwtlib.models.app",
|
||||
"docstring": "# Summary\n\nAuthentication request and response models.\n\nThis module defines all **typed data models** used by the authentication\nlibrary for user registration, login, logout, and token introspection.\n\nNotes:\n **Model Categories:**\n\n - Request payloads used by authentication workflows.\n - Public response models exposed to consumers.\n - Introspection responses used for service-to-service authentication.\n\n **Design Principles:**\n\n - Fully typed (Pydantic v2).\n - Serialization-safe.\n - Framework-agnostic.\n - Suitable for both internal logic and external adapters.",
|
||||
"objects": {
|
||||
"BaseModel": {
|
||||
"name": "BaseModel",
|
||||
"kind": "alias",
|
||||
"path": "jwtlib.models.app.BaseModel",
|
||||
"signature": "<bound method Alias.signature of Alias('BaseModel', 'pydantic.BaseModel')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Field": {
|
||||
"name": "Field",
|
||||
"kind": "alias",
|
||||
"path": "jwtlib.models.app.Field",
|
||||
"signature": "<bound method Alias.signature of Alias('Field', 'pydantic.Field')>",
|
||||
"docstring": null
|
||||
},
|
||||
"ActiveStateMixin": {
|
||||
"name": "ActiveStateMixin",
|
||||
"kind": "class",
|
||||
"path": "jwtlib.models.app.ActiveStateMixin",
|
||||
"signature": "<bound method Alias.signature of Alias('ActiveStateMixin', 'jwtlib.models.common.ActiveStateMixin')>",
|
||||
"signature": null,
|
||||
"docstring": "Mixin for entities with an active status flag.\n\nAttributes:\n is_active (bool):\n Indicates whether the account is active and allowed to\n authenticate.",
|
||||
"members": {
|
||||
"is_active": {
|
||||
"name": "is_active",
|
||||
"kind": "attribute",
|
||||
"path": "jwtlib.models.app.ActiveStateMixin.is_active",
|
||||
"signature": "<bound method Alias.signature of Alias('is_active', 'jwtlib.models.common.ActiveStateMixin.is_active')>",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
}
|
||||
}
|
||||
@@ -38,21 +24,21 @@
|
||||
"name": "IdentityMixin",
|
||||
"kind": "class",
|
||||
"path": "jwtlib.models.app.IdentityMixin",
|
||||
"signature": "<bound method Alias.signature of Alias('IdentityMixin', 'jwtlib.models.common.IdentityMixin')>",
|
||||
"signature": null,
|
||||
"docstring": "Mixin for entities with a username and email.\n\nAttributes:\n username (str):\n Unique username used for authentication and display.\n email (Optional[EmailStr]):\n Primary email address associated with the account.",
|
||||
"members": {
|
||||
"username": {
|
||||
"name": "username",
|
||||
"kind": "attribute",
|
||||
"path": "jwtlib.models.app.IdentityMixin.username",
|
||||
"signature": "<bound method Alias.signature of Alias('username', 'jwtlib.models.common.IdentityMixin.username')>",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"email": {
|
||||
"name": "email",
|
||||
"kind": "attribute",
|
||||
"path": "jwtlib.models.app.IdentityMixin.email",
|
||||
"signature": "<bound method Alias.signature of Alias('email', 'jwtlib.models.common.IdentityMixin.email')>",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
}
|
||||
}
|
||||
@@ -61,14 +47,14 @@
|
||||
"name": "PasswordMixin",
|
||||
"kind": "class",
|
||||
"path": "jwtlib.models.app.PasswordMixin",
|
||||
"signature": "<bound method Alias.signature of Alias('PasswordMixin', 'jwtlib.models.common.PasswordMixin')>",
|
||||
"signature": null,
|
||||
"docstring": "Mixin for entities with a raw password field.\n\nAttributes:\n password (str):\n User password (minimum 6 characters).",
|
||||
"members": {
|
||||
"password": {
|
||||
"name": "password",
|
||||
"kind": "attribute",
|
||||
"path": "jwtlib.models.app.PasswordMixin.password",
|
||||
"signature": "<bound method Alias.signature of Alias('password', 'jwtlib.models.common.PasswordMixin.password')>",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
}
|
||||
}
|
||||
@@ -77,14 +63,14 @@
|
||||
"name": "User",
|
||||
"kind": "class",
|
||||
"path": "jwtlib.models.app.User",
|
||||
"signature": "<bound method Alias.signature of Alias('User', 'jwtlib.models.mongo.User')>",
|
||||
"signature": null,
|
||||
"docstring": "Internal user persistence model.\n\nAttributes:\n hashed_password (str):\n Secure hash of the user's password.\n\nNotes:\n **Responsibilities:**\n\n - Represents a user record as stored in the database. Includes\n sensitive fields and is strictly confined to the persistence\n layer.\n\n **Guarantees:**\n\n - This model MUST NOT be returned from authentication APIs.\n Consumers should use `PublicUser` instead. Password verification\n is handled by the repository layer.",
|
||||
"members": {
|
||||
"hashed_password": {
|
||||
"name": "hashed_password",
|
||||
"kind": "attribute",
|
||||
"path": "jwtlib.models.app.User.hashed_password",
|
||||
"signature": "<bound method Alias.signature of Alias('hashed_password', 'jwtlib.models.mongo.User.hashed_password')>",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
}
|
||||
}
|
||||
@@ -93,7 +79,7 @@
|
||||
"name": "RegisterRequest",
|
||||
"kind": "class",
|
||||
"path": "jwtlib.models.app.RegisterRequest",
|
||||
"signature": "<bound method Class.signature of Class('RegisterRequest', 32, 53)>",
|
||||
"signature": null,
|
||||
"docstring": "Payload for registering a new user account.\n\nAttributes:\n username (str):\n Unique username identifier.\n email (EmailStr, optional):\n User's email address.\n password (str):\n Plain-text password (to be hashed by the repository layer).",
|
||||
"members": {
|
||||
"model_config": {
|
||||
@@ -130,7 +116,7 @@
|
||||
"name": "LoginRequest",
|
||||
"kind": "class",
|
||||
"path": "jwtlib.models.app.LoginRequest",
|
||||
"signature": "<bound method Class.signature of Class('LoginRequest', 56, 71)>",
|
||||
"signature": null,
|
||||
"docstring": "Payload for authenticating a user and issuing a `JWT`.\n\nAttributes:\n username (str):\n Username identifier.\n password (str):\n Plain-text password to be verified.",
|
||||
"members": {
|
||||
"model_config": {
|
||||
@@ -160,7 +146,7 @@
|
||||
"name": "IntrospectRequest",
|
||||
"kind": "class",
|
||||
"path": "jwtlib.models.app.IntrospectRequest",
|
||||
"signature": "<bound method Class.signature of Class('IntrospectRequest', 74, 93)>",
|
||||
"signature": null,
|
||||
"docstring": "Payload for requesting token introspection.\n\nAttributes:\n token (str):\n `JWT` access token to introspect.",
|
||||
"members": {
|
||||
"token": {
|
||||
@@ -183,7 +169,7 @@
|
||||
"name": "PublicUser",
|
||||
"kind": "class",
|
||||
"path": "jwtlib.models.app.PublicUser",
|
||||
"signature": "<bound method Class.signature of Class('PublicUser', 99, 121)>",
|
||||
"signature": null,
|
||||
"docstring": "Public-facing user representation returned by authentication APIs.\n\nAttributes:\n username (str):\n Unique username identifier.\n email (EmailStr, optional):\n User's email address.\n is_active (bool):\n Whether the user account is active.",
|
||||
"members": {
|
||||
"model_config": {
|
||||
@@ -220,7 +206,7 @@
|
||||
"name": "LoginResponse",
|
||||
"kind": "class",
|
||||
"path": "jwtlib.models.app.LoginResponse",
|
||||
"signature": "<bound method Class.signature of Class('LoginResponse', 124, 154)>",
|
||||
"signature": null,
|
||||
"docstring": "Response returned after successful authentication.\n\nAttributes:\n access_token (str):\n `JWT` access token for authenticated requests.\n user (PublicUser):\n Public profile of the authenticated user.",
|
||||
"members": {
|
||||
"access_token": {
|
||||
@@ -250,7 +236,7 @@
|
||||
"name": "LogoutResponse",
|
||||
"kind": "class",
|
||||
"path": "jwtlib.models.app.LogoutResponse",
|
||||
"signature": "<bound method Class.signature of Class('LogoutResponse', 157, 174)>",
|
||||
"signature": null,
|
||||
"docstring": "Response returned after a logout operation.\n\nAttributes:\n message (str):\n Human-readable logout confirmation.",
|
||||
"members": {
|
||||
"message": {
|
||||
@@ -273,7 +259,7 @@
|
||||
"name": "IntrospectResponse",
|
||||
"kind": "class",
|
||||
"path": "jwtlib.models.app.IntrospectResponse",
|
||||
"signature": "<bound method Class.signature of Class('IntrospectResponse', 177, 233)>",
|
||||
"signature": null,
|
||||
"docstring": "Result of a token introspection operation.\n\nAttributes:\n active (bool):\n Indicates whether the token is valid and active.\n user (Optional[PublicUser]):\n Public user details if the token is valid; otherwise null.",
|
||||
"members": {
|
||||
"active": {
|
||||
@@ -301,38 +287,31 @@
|
||||
"name": "jwt_error",
|
||||
"kind": "function",
|
||||
"path": "jwtlib.models.app.IntrospectResponse.jwt_error",
|
||||
"signature": "<bound method Function.signature of Function('jwt_error', 213, 215)>",
|
||||
"signature": "jwt_error(error: Any) -> IntrospectResponse",
|
||||
"docstring": null
|
||||
},
|
||||
"no_username": {
|
||||
"name": "no_username",
|
||||
"kind": "function",
|
||||
"path": "jwtlib.models.app.IntrospectResponse.no_username",
|
||||
"signature": "<bound method Function.signature of Function('no_username', 217, 219)>",
|
||||
"signature": "no_username() -> IntrospectResponse",
|
||||
"docstring": null
|
||||
},
|
||||
"no_user": {
|
||||
"name": "no_user",
|
||||
"kind": "function",
|
||||
"path": "jwtlib.models.app.IntrospectResponse.no_user",
|
||||
"signature": "<bound method Function.signature of Function('no_user', 221, 223)>",
|
||||
"signature": "no_user() -> IntrospectResponse",
|
||||
"docstring": null
|
||||
},
|
||||
"valid_user": {
|
||||
"name": "valid_user",
|
||||
"kind": "function",
|
||||
"path": "jwtlib.models.app.IntrospectResponse.valid_user",
|
||||
"signature": "<bound method Function.signature of Function('valid_user', 225, 233)>",
|
||||
"signature": "valid_user(user: Any) -> IntrospectResponse",
|
||||
"docstring": null
|
||||
}
|
||||
}
|
||||
},
|
||||
"Any": {
|
||||
"name": "Any",
|
||||
"kind": "alias",
|
||||
"path": "jwtlib.models.app.Any",
|
||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
||||
"docstring": null
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user