Vishesh 'ironeagle' Bangotra
a32eeaf2b4
- collect.py copies each repo's built site contents directly to a top-level <repo>/ dir (was libs|apis|wiki/<repo>/site nesting) - nginx uses `index index.html lib/index.html api/index.html` so /dagpipe/ -> lib/index.html, /auth-server/ -> api/index.html are served internally with no redirects - _index regenerates links against the flat layout (/dagpipe/lib/, /auth-server/api/, /mongo-ops/, /blog/...) - config.yml static entries point at vendored blog/ + media-manager/ - Dockerfile copies per-repo dirs flat into the nginx html root - removed stale libs/, apis/, wiki/, tutorials/ category trees
339 lines
15 KiB
JSON
339 lines
15 KiB
JSON
{
|
|
"module": "jwtlib.models.app",
|
|
"content": {
|
|
"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')>",
|
|
"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')>",
|
|
"docstring": null
|
|
}
|
|
}
|
|
},
|
|
"IdentityMixin": {
|
|
"name": "IdentityMixin",
|
|
"kind": "class",
|
|
"path": "jwtlib.models.app.IdentityMixin",
|
|
"signature": "<bound method Alias.signature of Alias('IdentityMixin', 'jwtlib.models.common.IdentityMixin')>",
|
|
"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')>",
|
|
"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')>",
|
|
"docstring": null
|
|
}
|
|
}
|
|
},
|
|
"PasswordMixin": {
|
|
"name": "PasswordMixin",
|
|
"kind": "class",
|
|
"path": "jwtlib.models.app.PasswordMixin",
|
|
"signature": "<bound method Alias.signature of Alias('PasswordMixin', 'jwtlib.models.common.PasswordMixin')>",
|
|
"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')>",
|
|
"docstring": null
|
|
}
|
|
}
|
|
},
|
|
"User": {
|
|
"name": "User",
|
|
"kind": "class",
|
|
"path": "jwtlib.models.app.User",
|
|
"signature": "<bound method Alias.signature of Alias('User', 'jwtlib.models.mongo.User')>",
|
|
"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')>",
|
|
"docstring": null
|
|
}
|
|
}
|
|
},
|
|
"RegisterRequest": {
|
|
"name": "RegisterRequest",
|
|
"kind": "class",
|
|
"path": "jwtlib.models.app.RegisterRequest",
|
|
"signature": "<bound method Class.signature of Class('RegisterRequest', 32, 53)>",
|
|
"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": {
|
|
"name": "model_config",
|
|
"kind": "attribute",
|
|
"path": "jwtlib.models.app.RegisterRequest.model_config",
|
|
"signature": null,
|
|
"docstring": null
|
|
},
|
|
"username": {
|
|
"name": "username",
|
|
"kind": "attribute",
|
|
"path": "jwtlib.models.app.RegisterRequest.username",
|
|
"signature": null,
|
|
"docstring": null
|
|
},
|
|
"email": {
|
|
"name": "email",
|
|
"kind": "attribute",
|
|
"path": "jwtlib.models.app.RegisterRequest.email",
|
|
"signature": null,
|
|
"docstring": null
|
|
},
|
|
"password": {
|
|
"name": "password",
|
|
"kind": "attribute",
|
|
"path": "jwtlib.models.app.RegisterRequest.password",
|
|
"signature": null,
|
|
"docstring": null
|
|
}
|
|
}
|
|
},
|
|
"LoginRequest": {
|
|
"name": "LoginRequest",
|
|
"kind": "class",
|
|
"path": "jwtlib.models.app.LoginRequest",
|
|
"signature": "<bound method Class.signature of Class('LoginRequest', 56, 71)>",
|
|
"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": {
|
|
"name": "model_config",
|
|
"kind": "attribute",
|
|
"path": "jwtlib.models.app.LoginRequest.model_config",
|
|
"signature": null,
|
|
"docstring": null
|
|
},
|
|
"username": {
|
|
"name": "username",
|
|
"kind": "attribute",
|
|
"path": "jwtlib.models.app.LoginRequest.username",
|
|
"signature": null,
|
|
"docstring": null
|
|
},
|
|
"password": {
|
|
"name": "password",
|
|
"kind": "attribute",
|
|
"path": "jwtlib.models.app.LoginRequest.password",
|
|
"signature": null,
|
|
"docstring": null
|
|
}
|
|
}
|
|
},
|
|
"IntrospectRequest": {
|
|
"name": "IntrospectRequest",
|
|
"kind": "class",
|
|
"path": "jwtlib.models.app.IntrospectRequest",
|
|
"signature": "<bound method Class.signature of Class('IntrospectRequest', 74, 93)>",
|
|
"docstring": "Payload for requesting token introspection.\n\nAttributes:\n token (str):\n `JWT` access token to introspect.",
|
|
"members": {
|
|
"token": {
|
|
"name": "token",
|
|
"kind": "attribute",
|
|
"path": "jwtlib.models.app.IntrospectRequest.token",
|
|
"signature": null,
|
|
"docstring": null
|
|
},
|
|
"model_config": {
|
|
"name": "model_config",
|
|
"kind": "attribute",
|
|
"path": "jwtlib.models.app.IntrospectRequest.model_config",
|
|
"signature": null,
|
|
"docstring": null
|
|
}
|
|
}
|
|
},
|
|
"PublicUser": {
|
|
"name": "PublicUser",
|
|
"kind": "class",
|
|
"path": "jwtlib.models.app.PublicUser",
|
|
"signature": "<bound method Class.signature of Class('PublicUser', 99, 121)>",
|
|
"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": {
|
|
"name": "model_config",
|
|
"kind": "attribute",
|
|
"path": "jwtlib.models.app.PublicUser.model_config",
|
|
"signature": null,
|
|
"docstring": null
|
|
},
|
|
"username": {
|
|
"name": "username",
|
|
"kind": "attribute",
|
|
"path": "jwtlib.models.app.PublicUser.username",
|
|
"signature": null,
|
|
"docstring": null
|
|
},
|
|
"email": {
|
|
"name": "email",
|
|
"kind": "attribute",
|
|
"path": "jwtlib.models.app.PublicUser.email",
|
|
"signature": null,
|
|
"docstring": null
|
|
},
|
|
"is_active": {
|
|
"name": "is_active",
|
|
"kind": "attribute",
|
|
"path": "jwtlib.models.app.PublicUser.is_active",
|
|
"signature": null,
|
|
"docstring": null
|
|
}
|
|
}
|
|
},
|
|
"LoginResponse": {
|
|
"name": "LoginResponse",
|
|
"kind": "class",
|
|
"path": "jwtlib.models.app.LoginResponse",
|
|
"signature": "<bound method Class.signature of Class('LoginResponse', 124, 154)>",
|
|
"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": {
|
|
"name": "access_token",
|
|
"kind": "attribute",
|
|
"path": "jwtlib.models.app.LoginResponse.access_token",
|
|
"signature": null,
|
|
"docstring": null
|
|
},
|
|
"user": {
|
|
"name": "user",
|
|
"kind": "attribute",
|
|
"path": "jwtlib.models.app.LoginResponse.user",
|
|
"signature": null,
|
|
"docstring": null
|
|
},
|
|
"model_config": {
|
|
"name": "model_config",
|
|
"kind": "attribute",
|
|
"path": "jwtlib.models.app.LoginResponse.model_config",
|
|
"signature": null,
|
|
"docstring": null
|
|
}
|
|
}
|
|
},
|
|
"LogoutResponse": {
|
|
"name": "LogoutResponse",
|
|
"kind": "class",
|
|
"path": "jwtlib.models.app.LogoutResponse",
|
|
"signature": "<bound method Class.signature of Class('LogoutResponse', 157, 174)>",
|
|
"docstring": "Response returned after a logout operation.\n\nAttributes:\n message (str):\n Human-readable logout confirmation.",
|
|
"members": {
|
|
"message": {
|
|
"name": "message",
|
|
"kind": "attribute",
|
|
"path": "jwtlib.models.app.LogoutResponse.message",
|
|
"signature": null,
|
|
"docstring": null
|
|
},
|
|
"model_config": {
|
|
"name": "model_config",
|
|
"kind": "attribute",
|
|
"path": "jwtlib.models.app.LogoutResponse.model_config",
|
|
"signature": null,
|
|
"docstring": null
|
|
}
|
|
}
|
|
},
|
|
"IntrospectResponse": {
|
|
"name": "IntrospectResponse",
|
|
"kind": "class",
|
|
"path": "jwtlib.models.app.IntrospectResponse",
|
|
"signature": "<bound method Class.signature of Class('IntrospectResponse', 177, 233)>",
|
|
"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": {
|
|
"name": "active",
|
|
"kind": "attribute",
|
|
"path": "jwtlib.models.app.IntrospectResponse.active",
|
|
"signature": null,
|
|
"docstring": null
|
|
},
|
|
"user": {
|
|
"name": "user",
|
|
"kind": "attribute",
|
|
"path": "jwtlib.models.app.IntrospectResponse.user",
|
|
"signature": null,
|
|
"docstring": null
|
|
},
|
|
"model_config": {
|
|
"name": "model_config",
|
|
"kind": "attribute",
|
|
"path": "jwtlib.models.app.IntrospectResponse.model_config",
|
|
"signature": null,
|
|
"docstring": null
|
|
},
|
|
"jwt_error": {
|
|
"name": "jwt_error",
|
|
"kind": "function",
|
|
"path": "jwtlib.models.app.IntrospectResponse.jwt_error",
|
|
"signature": "<bound method Function.signature of Function('jwt_error', 213, 215)>",
|
|
"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)>",
|
|
"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)>",
|
|
"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)>",
|
|
"docstring": null
|
|
}
|
|
}
|
|
},
|
|
"Any": {
|
|
"name": "Any",
|
|
"kind": "alias",
|
|
"path": "jwtlib.models.app.Any",
|
|
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
|
"docstring": null
|
|
}
|
|
}
|
|
}
|
|
} |