150 lines
4.5 KiB
JSON
150 lines
4.5 KiB
JSON
{
|
|
"openapi": "3.0.0",
|
|
"info": {
|
|
"title": "REST4i API Specifications Index",
|
|
"description": "This index lists all available OpenAPI specification files for the REST4i API. Each category has its own specification file for easier navigation and consumption.",
|
|
"version": "1.0.7-rest4i",
|
|
"contact": {
|
|
"name": "API Support",
|
|
"url": "https://github.com/rest4i"
|
|
},
|
|
"license": {
|
|
"name": "Apache 2.0",
|
|
"url": "https://www.apache.org/licenses/LICENSE-2.0.html"
|
|
}
|
|
},
|
|
"specifications": [
|
|
{
|
|
"name": "Administration Services",
|
|
"file": "admin.json",
|
|
"description": "Administration Services provide APIs that give information about RSE API and the runtime environment of the RSE API server.",
|
|
"endpoints": 7,
|
|
"paths": [
|
|
"/v1/admin/memory",
|
|
"/v1/admin/settings",
|
|
"/v1/admin/environment",
|
|
"/v1/admin/serverinfo",
|
|
"/v1/admin/sessions"
|
|
]
|
|
},
|
|
{
|
|
"name": "CL Command Services",
|
|
"file": "cl.json",
|
|
"description": "CL Command Services provide APIs for running CL commands.",
|
|
"endpoints": 2,
|
|
"paths": [
|
|
"/v1/cl",
|
|
"/v1/cl/{commandname}"
|
|
]
|
|
},
|
|
{
|
|
"name": "SQL Services",
|
|
"file": "sql.json",
|
|
"description": "SQL Services provide APIs associated with performing SQL operations.",
|
|
"endpoints": 1,
|
|
"paths": [
|
|
"/v1/sql"
|
|
]
|
|
},
|
|
{
|
|
"name": "IFS Services",
|
|
"file": "ifs.json",
|
|
"description": "Integrated File System (IFS) Services provide APIs for accessing objects in a way that is like personal computer and UNIX operating systems.",
|
|
"endpoints": 4,
|
|
"paths": [
|
|
"/v1/ifs/{path}",
|
|
"/v1/ifs/list",
|
|
"/v1/ifs/{path}/info"
|
|
]
|
|
},
|
|
{
|
|
"name": "QSYS Services",
|
|
"file": "qsys.json",
|
|
"description": "QSYS Services provide APIs for accessing QSYS objects.",
|
|
"endpoints": 1,
|
|
"paths": [
|
|
"/v1/qsys/search/{objectName}"
|
|
]
|
|
},
|
|
{
|
|
"name": "Session Services",
|
|
"file": "session.json",
|
|
"description": "Session Services provide APIs for authenticating a user and managing sessions.",
|
|
"endpoints": 4,
|
|
"paths": [
|
|
"/v1/session"
|
|
]
|
|
},
|
|
{
|
|
"name": "Database Services",
|
|
"file": "database.json",
|
|
"description": "Enhanced database services with connection pooling and multiple output formats.",
|
|
"endpoints": 2,
|
|
"paths": [
|
|
"/v1/database/query"
|
|
]
|
|
},
|
|
{
|
|
"name": "File Operations Services",
|
|
"file": "files.json",
|
|
"description": "Enhanced file operations services supporting both IFS and SMB file operations.",
|
|
"endpoints": 5,
|
|
"paths": [
|
|
"/v1/files/list",
|
|
"/v1/files/download",
|
|
"/v1/files/upload",
|
|
"/v1/files/zip",
|
|
"/v1/files/exists"
|
|
]
|
|
},
|
|
{
|
|
"name": "PDF Services",
|
|
"file": "pdf.json",
|
|
"description": "PDF processing services for creating, manipulating, and extracting data from PDF documents.",
|
|
"endpoints": 4,
|
|
"paths": [
|
|
"/v1/pdf/convert",
|
|
"/v1/pdf/merge",
|
|
"/v1/pdf/rotate",
|
|
"/v1/pdf/unprotect"
|
|
]
|
|
},
|
|
{
|
|
"name": "Security Services",
|
|
"file": "security.json",
|
|
"description": "Security Services provide APIs relating to digital certificate management and TLS system information.",
|
|
"endpoints": 14,
|
|
"paths": [
|
|
"/v1/security/dcm/cert/delete",
|
|
"/v1/security/dcm/cert/export",
|
|
"/v1/security/dcm/cert/info",
|
|
"/v1/security/dcm/cert/list",
|
|
"/v1/security/dcm/cert/import",
|
|
"/v1/security/dcm/appdef/associate",
|
|
"/v1/security/dcm/appdef/disassociate",
|
|
"/v1/security/dcm/appdef/list",
|
|
"/v1/security/dcm/appdef/trust",
|
|
"/v1/security/dcm/appdef/untrust",
|
|
"/v1/security/dcm/certstore/changepassword",
|
|
"/v1/security/tls",
|
|
"/v1/security/tls/stats"
|
|
]
|
|
},
|
|
{
|
|
"name": "Health Services",
|
|
"file": "health.json",
|
|
"description": "Health check endpoints for service monitoring and liveness probes.",
|
|
"endpoints": 1,
|
|
"paths": [
|
|
"/v1/health/ping"
|
|
]
|
|
}
|
|
],
|
|
"summary": {
|
|
"totalSpecFiles": 11,
|
|
"totalEndpoints": 45,
|
|
"version": "1.0.7-rest4i",
|
|
"masterSpec": "../scalar.json"
|
|
}
|
|
}
|