aetos/openapi-first
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: nest generated docs under docs/lib and docs/mcp

Browse Source
This commit is contained in:
Vishesh 'ironeagle' Bangotra
2026-09-10 21:15:05 +05:30
parent 0efe68b052
commit 658a98cf19
69 changed files with 8566 additions and 1882 deletions
Download Patch File Download Diff File Expand all files Collapse all files

93
docs/mcp/modules/openapi_first.security.json Normal file
View File

@@ -0,0 +1,93 @@
{
"module": "openapi_first.security",
"content": {
"path": "openapi_first.security",
"docstring": "OpenAPI security scheme parsing and auto-generated auth dependencies.\n\nReads `securitySchemes` and per-operation `security` from an OpenAPI spec,\nresolves `{ENV_VAR}` placeholders in `x-` extension fields, and generates\nFastAPI dependencies for token validation (e.g., Bearer JWT introspection).",
"objects": {
"os": {
"name": "os",
"kind": "alias",
"path": "openapi_first.security.os",
"signature": "<bound method Alias.signature of Alias('os', 'os')>",
"docstring": null
},
"re": {
"name": "re",
"kind": "alias",
"path": "openapi_first.security.re",
"signature": "<bound method Alias.signature of Alias('re', 're')>",
"docstring": null
},
"Callable": {
"name": "Callable",
"kind": "alias",
"path": "openapi_first.security.Callable",
"signature": "<bound method Alias.signature of Alias('Callable', 'collections.abc.Callable')>",
"docstring": null
},
"Any": {
"name": "Any",
"kind": "alias",
"path": "openapi_first.security.Any",
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
"docstring": null
},
"httpx": {
"name": "httpx",
"kind": "alias",
"path": "openapi_first.security.httpx",
"signature": "<bound method Alias.signature of Alias('httpx', 'httpx')>",
"docstring": null
},
"Depends": {
"name": "Depends",
"kind": "alias",
"path": "openapi_first.security.Depends",
"signature": "<bound method Alias.signature of Alias('Depends', 'fastapi.Depends')>",
"docstring": null
},
"HTTPException": {
"name": "HTTPException",
"kind": "alias",
"path": "openapi_first.security.HTTPException",
"signature": "<bound method Alias.signature of Alias('HTTPException', 'fastapi.HTTPException')>",
"docstring": null
},
"Request": {
"name": "Request",
"kind": "alias",
"path": "openapi_first.security.Request",
"signature": "<bound method Alias.signature of Alias('Request', 'fastapi.Request')>",
"docstring": null
},
"HTTPAuthorizationCredentials": {
"name": "HTTPAuthorizationCredentials",
"kind": "alias",
"path": "openapi_first.security.HTTPAuthorizationCredentials",
"signature": "<bound method Alias.signature of Alias('HTTPAuthorizationCredentials', 'fastapi.security.HTTPAuthorizationCredentials')>",
"docstring": null
},
"HTTPBearer": {
"name": "HTTPBearer",
"kind": "alias",
"path": "openapi_first.security.HTTPBearer",
"signature": "<bound method Alias.signature of Alias('HTTPBearer', 'fastapi.security.HTTPBearer')>",
"docstring": null
},
"parse_security_schemes": {
"name": "parse_security_schemes",
"kind": "function",
"path": "openapi_first.security.parse_security_schemes",
"signature": "<bound method Function.signature of Function('parse_security_schemes', 43, 46)>",
"docstring": "Extract and resolve environment variables in security schemes."
},
"make_security_dependencies": {
"name": "make_security_dependencies",
"kind": "function",
"path": "openapi_first.security.make_security_dependencies",
"signature": "<bound method Function.signature of Function('make_security_dependencies', 113, 150)>",
"docstring": "Build a mapping of ``METHOD:/path`` → list of ``Depends(...)``.\n\nThe effective security for each operation is resolved by:\n\n1. Using the operation-level ``security`` field if present.\n2. Falling back to the top-level ``security`` field.\n3. An empty list means *no auth required* for that operation."
}
}
}
}