{
    "openapi":"3.0.0",
    "info":{
        "description":"<p>Provides information about how to use REST APIs with Oracle&reg Backend for Firebase.</p>",
        "version":"2026.07.07",
        "title":"REST APIs for Oracle Backend for Firebase",
        "contact":{
            "name":"Oracle REST Data Services",
            "url":"https://www.oracle.com/database/technologies/appdev/rest.html"
        },
        "x-summary":"Provides information about how to use REST APIs with Oracle? Backend for Firebase."
    },
    "servers":[
        {
            "url":"REPLACED_AT_RUNTIME",
            "description":"There may be more than one server URL for the FUSABASE APIs in this environment. Depending on the configuration, it may be possible to access the paths without specifying a database or schema in the full URL. The URL for this server is derived at runtime."
        }
    ],
    "tags":[
        {
            "name":"Fusabase AppTrust",
            "description":"App attestation exchange endpoints for App Trust enforcement."
        },
        {
            "name":"Fusabase Authentication - IDCS",
            "description":"The operations from the Fusabase Authentication - IDCS category."
        },
        {
            "name":"Fusabase Authentication - OnPrem",
            "description":"OnPrem Authentication Service for Fusabase."
        },
        {
            "name":"Fusabase Database",
            "description":"Database Service for Oracle Fusabase."
        },
        {
            "name":"Fusabase ObjectStore - DBFS",
            "description":"ObjectStore service, via DBFS, for Fusabase."
        },
        {
            "name":"Fusabase ObjectStore - DBFS PAR",
            "description":"Objectstore PreAuthenticated Service URLs, via DBFS, for Fusabase"
        },
        {
            "name":"Fusabase ObjectStore - OCI",
            "description":"ObjectStore service, via OCI Objectstore, for Fusabase."
        },
        {
            "name":"Fusabase Social Authentication - IDCS",
            "description":"Service endpoints exposed to IDCS, as social callback and error handling URLs"
        },
        {
            "name":"Fusabase Social Authentication - OnPrem",
            "description":"Service endpoints for OnPrem Authentication service to enable social login"
        },
        {
            "name":"Oracle Fusabase",
            "description":"All Services related to Oracle Fusabase. The product must be installed in the Oracle database that ORDS is configured to use."
        }
    ],
    "paths":{
        "/_/baas-services/database/{project_id}/v2/runQuery":{
            "post":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase Database"
                ],
                "security":[
                    {
                        "bearerAuth":[
                        ],
                        "AppKey":[
                        ]
                    },
                    {
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Get results from a query",
                "description":"This service executes various types of queries on the database collections or duality views and returns the resulting documents. It supports multiple query types including fetching a single document by path, simple queries with conditions and ordering, collection group queries, join queries on relational models, aggregation queries, and queries on duality views. Specify the query type in the request body. The 'limit' parameter controls the maximum number of results returned (0 for no limit). The version 2 endpoint applies stricter security rule policies. Authentication is required via Bearer token or AppKey. The output will differ based on relational and collection tables.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    },
                    {
                        "$ref":"#/components/parameters/transactionHeader"
                    }
                ],
                "requestBody":{
                    "description":"The query parameters required",
                    "required":true,
                    "content":{
                        "application/json":{
                            "schema":{
                                "oneOf":[
                                    {
                                        "type":"object",
                                        "description":"Get a single document from a collection",
                                        "properties":{
                                            "path":{
                                                "$ref":"#/components/schemas/DocumentPath"
                                            }
                                        },
                                        "required":[
                                            "path"
                                        ],
                                        "additionalProperties":false
                                    },
                                    {
                                        "type":"object",
                                        "description":"Perform a simple SQL query",
                                        "properties":{
                                            "path":{
                                                "$ref":"#/components/schemas/CollectionPath"
                                            },
                                            "conditions":{
                                                "type":"array",
                                                "items":{
                                                    "$ref":"#/components/schemas/QueryCondition"
                                                }
                                            },
                                            "explicitOrder":{
                                                "type":"array",
                                                "items":{
                                                    "$ref":"#/components/schemas/OrderByProperty"
                                                }
                                            },
                                            "limit":{
                                                "type":"integer",
                                                "default":0,
                                                "minimum":0
                                            },
                                            "vectorSearch":{
                                                "$ref":"#/components/schemas/VectorSearch"
                                            }
                                        },
                                        "required":[
                                            "path",
                                            "conditions",
                                            "explicitOrder",
                                            "limit"
                                        ]
                                    },
                                    {
                                        "type":"object",
                                        "description":"Perform a CollectionGroup query",
                                        "properties":{
                                            "col_group":{
                                                "type":"string"
                                            },
                                            "conditions":{
                                                "type":"array",
                                                "items":{
                                                    "$ref":"#/components/schemas/QueryCondition"
                                                }
                                            },
                                            "explicitOrder":{
                                                "type":"array",
                                                "items":{
                                                    "$ref":"#/components/schemas/OrderByProperty"
                                                }
                                            },
                                            "limit":{
                                                "type":"integer",
                                                "default":0,
                                                "minimum":0
                                            },
                                            "vectorSearch":{
                                                "$ref":"#/components/schemas/VectorSearch"
                                            }
                                        },
                                        "required":[
                                            "col_group",
                                            "conditions",
                                            "explicitOrder",
                                            "limit"
                                        ]
                                    },
                                    {
                                        "type":"object",
                                        "description":"Get the resultset for an already created Join View",
                                        "properties":{
                                            "joins":{
                                                "$ref":"#/components/schemas/JoinView"
                                            },
                                            "conditions":{
                                                "type":"array",
                                                "items":{
                                                    "$ref":"#/components/schemas/QueryCondition"
                                                }
                                            },
                                            "explicitOrder":{
                                                "type":"array",
                                                "items":{
                                                    "$ref":"#/components/schemas/OrderByProperty"
                                                }
                                            },
                                            "limit":{
                                                "type":"integer",
                                                "default":0,
                                                "minimum":0
                                            },
                                            "path":{
                                                "description":"Must be empty array",
                                                "$ref":"#/components/schemas/CollectionPath"
                                            }
                                        },
                                        "required":[
                                            "joins",
                                            "path"
                                        ]
                                    },
                                    {
                                        "type":"object",
                                        "description":"Perform aggregation query",
                                        "properties":{
                                            "path":{
                                                "$ref":"#/components/schemas/CollectionPath"
                                            },
                                            "aggregate":{
                                                "type":"array",
                                                "items":{
                                                    "$ref":"#/components/schemas/AggregateByProperty"
                                                }
                                            },
                                            "limit":{
                                                "type":"integer",
                                                "default":0,
                                                "minimum":0
                                            },
                                            "conditions":{
                                                "type":"array",
                                                "items":{
                                                    "$ref":"#/components/schemas/QueryCondition"
                                                },
                                                "default":[
                                                ],
                                                "minItems":0
                                            },
                                            "vectorSearch":{
                                                "$ref":"#/components/schemas/VectorSearch"
                                            }
                                        },
                                        "required":[
                                            "path",
                                            "aggregate",
                                            "limit",
                                            "conditions"
                                        ]
                                    },
                                    {
                                        "type":"object",
                                        "description":"Perform a query on a DualityView",
                                        "properties":{
                                            "dv_name":{
                                                "type":"string",
                                                "description":"Duality View name"
                                            },
                                            "conditions":{
                                                "type":"array",
                                                "items":{
                                                    "$ref":"#/components/schemas/QueryCondition"
                                                }
                                            },
                                            "explicitOrder":{
                                                "type":"array",
                                                "items":{
                                                    "$ref":"#/components/schemas/OrderByProperty"
                                                }
                                            },
                                            "limit":{
                                                "type":"integer",
                                                "default":0,
                                                "minimum":0
                                            }
                                        },
                                        "required":[
                                            "dv_name",
                                            "conditions",
                                            "explicitOrder",
                                            "limit"
                                        ]
                                    }
                                ]
                            },
                            "examples":{
                                "singleDocument":{
                                    "summary":"Get a single user document",
                                    "value":{
                                        "path":[
                                            "users",
                                            "uuid123"
                                        ]
                                    }
                                },
                                "simpleQuery":{
                                    "summary":"Query based on conditions",
                                    "value":{
                                        "path":[
                                            "users",
                                            "uuid123",
                                            "recipes"
                                        ],
                                        "conditions":[
                                            {
                                                "field":"category",
                                                "op":"=",
                                                "value":"dessert"
                                            },
                                            {
                                                "field":"difficulty",
                                                "op":"<=",
                                                "value":3
                                            }
                                        ],
                                        "explicitOrder":[
                                            {
                                                "field":"title",
                                                "direction":"asc"
                                            }
                                        ],
                                        "limit":10
                                    }
                                },
                                "collectionGroup":{
                                    "summary":"Collection group query on notes",
                                    "value":{
                                        "col_group":"notes",
                                        "conditions":[
                                            {
                                                "field":"content",
                                                "op":"like",
                                                "value":"%important%"
                                            }
                                        ],
                                        "explicitOrder":[
                                            {
                                                "field":"createdAt",
                                                "direction":"desc"
                                            }
                                        ],
                                        "limit":5
                                    }
                                },
                                "joinQuery":{
                                    "summary":"Join query example",
                                    "value":{
                                        "path":[
                                        ],
                                        "joins":{
                                            "view_name":"TEST_1"
                                        },
                                        "explicitOrder":[
                                            {
                                                "field":"pid",
                                                "direction":"desc"
                                            }
                                        ],
                                        "limit":10
                                    }
                                },
                                "aggregationQuery":{
                                    "summary":"Aggregate based queries",
                                    "value":{
                                        "path":[
                                            "users",
                                            "uuid123",
                                            "recipes"
                                        ],
                                        "aggregate":[
                                            {
                                                "field":"avgRating",
                                                "func":"avg",
                                                "op_key":"avg_rating"
                                            }
                                        ],
                                        "conditions":[
                                            {
                                                "field":"category",
                                                "op":"=",
                                                "value":"dessert"
                                            }
                                        ],
                                        "limit":1
                                    }
                                },
                                "dualityViewQuery":{
                                    "summary":"Query on UserView duality view",
                                    "value":{
                                        "dv_name":"UserView",
                                        "conditions":[
                                            {
                                                "field":"displayName",
                                                "op":"like",
                                                "value":"John%"
                                            }
                                        ],
                                        "explicitOrder":[
                                            {
                                                "field":"displayName",
                                                "direction":"asc"
                                            }
                                        ],
                                        "limit":10
                                    }
                                },
                                "vectorSimilarityQuery":{
                                    "summary":"SQL query with vector similarity search",
                                    "value":{
                                        "path":[
                                            "myCollection"
                                        ],
                                        "conditions":[
                                        ],
                                        "explicitOrder":[
                                        ],
                                        "limit":10,
                                        "vectorSearch":{
                                            "field":"EMB",
                                            "query":{
                                                "vector":[
                                                    0.12,
                                                    0.34,
                                                    0.56,
                                                    0.78
                                                ]
                                            },
                                            "metric":"COSINE",
                                            "topK":10,
                                            "threshold":0.25
                                        }
                                    }
                                },
                                "sparseVectorSimilarityQuery":{
                                    "summary":"SQL query with sparse vector similarity search",
                                    "value":{
                                        "path":[
                                            "myCollection"
                                        ],
                                        "conditions":[
                                        ],
                                        "explicitOrder":[
                                        ],
                                        "limit":10,
                                        "vectorSearch":{
                                            "field":"SP_EMB",
                                            "query":{
                                                "sparse":{
                                                    "dimension":8,
                                                    "indices":[
                                                        1,
                                                        3
                                                    ],
                                                    "values":[
                                                        0.7,
                                                        0.4
                                                    ]
                                                }
                                            },
                                            "metric":"DOT",
                                            "topK":10
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "responses":{
                    "200":{
                        "description":"Returns list of documents, OID and document Data",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/QueryResponseItem"
                                },
                                "examples":{
                                    "collectionQuery":{
                                        "summary":"Output for collection table query",
                                        "value":{
                                            "ret":[
                                                {
                                                    "osons":{
                                                        "DOCUMENT":{
                                                            "displayName":"User123",
                                                            "email":"user123@example.com"
                                                        },
                                                        "OID":"ABCDEF123456",
                                                        "CREATED":"2023-10-25T14:00:00Z",
                                                        "LAST_MODIFIED":"2023-10-25T14:00:00Z",
                                                        "VERSION":1,
                                                        "SUBCOLLECTION":{
                                                        }
                                                    }
                                                }
                                            ]
                                        }
                                    },
                                    "relationalTableQuery":{
                                        "summary":"Output for relational table query",
                                        "value":{
                                            "ret":[
                                                {
                                                    "osons":{
                                                        "name":"pratik",
                                                        "age":1142568,
                                                        "about":"testapiversion2",
                                                        "OID":"FB03C10200",
                                                        "_id":1,
                                                        "parent_oid":"_docId",
                                                        "_metadata":{
                                                            "etag":"943EEC508908213D2D00FF375854BB48",
                                                            "asof":"0000000000000000"
                                                        }
                                                    }
                                                }
                                            ]
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401":{
                        "description":"Authentication Failure"
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-database-{project_id}-v2-runQuery-post",
                "x-filename-id":"_-baas-services-database-project_id-v2-runquery-post"
            }
        },
        "/_/baas-services/database/{project_id}/v1/runQuery":{
            "post":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase Database"
                ],
                "security":[
                    {
                        "bearerAuth":[
                        ],
                        "AppKey":[
                        ]
                    },
                    {
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Get results from a query",
                "description":"This service executes various types of queries on the database collections or duality views and returns the resulting documents. It supports multiple query types including fetching a single document by path, simple queries with conditions and ordering, collection group queries, join queries on relational models, aggregation queries, and queries on duality views. Specify the query type in the request body. The 'limit' parameter controls the maximum number of results returned (0 for no limit). The version 1 endpoint applies security rules such as Row Level Security. Authentication is required via Bearer token or AppKey. The output will differ based on relational and collection tables.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    },
                    {
                        "$ref":"#/components/parameters/transactionHeader"
                    }
                ],
                "requestBody":{
                    "description":"The query parameters required",
                    "required":true,
                    "content":{
                        "application/json":{
                            "schema":{
                                "oneOf":[
                                    {
                                        "type":"object",
                                        "description":"Get a single document from a collection",
                                        "properties":{
                                            "path":{
                                                "$ref":"#/components/schemas/DocumentPath"
                                            }
                                        },
                                        "required":[
                                            "path"
                                        ],
                                        "additionalProperties":false
                                    },
                                    {
                                        "type":"object",
                                        "description":"Perform a simple SQL query",
                                        "properties":{
                                            "path":{
                                                "$ref":"#/components/schemas/CollectionPath"
                                            },
                                            "conditions":{
                                                "type":"array",
                                                "items":{
                                                    "$ref":"#/components/schemas/QueryCondition"
                                                }
                                            },
                                            "explicitOrder":{
                                                "type":"array",
                                                "items":{
                                                    "$ref":"#/components/schemas/OrderByProperty"
                                                }
                                            },
                                            "limit":{
                                                "type":"integer",
                                                "default":0,
                                                "minimum":0
                                            }
                                        },
                                        "required":[
                                            "path",
                                            "conditions",
                                            "explicitOrder",
                                            "limit"
                                        ]
                                    },
                                    {
                                        "type":"object",
                                        "description":"Perform a CollectionGroup query",
                                        "properties":{
                                            "col_group":{
                                                "type":"string"
                                            },
                                            "conditions":{
                                                "type":"array",
                                                "items":{
                                                    "$ref":"#/components/schemas/QueryCondition"
                                                }
                                            },
                                            "explicitOrder":{
                                                "type":"array",
                                                "items":{
                                                    "$ref":"#/components/schemas/OrderByProperty"
                                                }
                                            },
                                            "limit":{
                                                "type":"integer",
                                                "default":0,
                                                "minimum":0
                                            }
                                        },
                                        "required":[
                                            "col_group",
                                            "conditions",
                                            "explicitOrder",
                                            "limit"
                                        ]
                                    },
                                    {
                                        "type":"object",
                                        "description":"Get the resultset for an already created Join View",
                                        "properties":{
                                            "joins":{
                                                "$ref":"#/components/schemas/JoinView"
                                            },
                                            "conditions":{
                                                "type":"array",
                                                "items":{
                                                    "$ref":"#/components/schemas/QueryCondition"
                                                }
                                            },
                                            "explicitOrder":{
                                                "type":"array",
                                                "items":{
                                                    "$ref":"#/components/schemas/OrderByProperty"
                                                }
                                            },
                                            "limit":{
                                                "type":"integer",
                                                "default":0,
                                                "minimum":0
                                            },
                                            "path":{
                                                "description":"Must be empty array",
                                                "$ref":"#/components/schemas/CollectionPath"
                                            }
                                        },
                                        "required":[
                                            "joins",
                                            "path"
                                        ]
                                    },
                                    {
                                        "type":"object",
                                        "description":"Perform aggregation query",
                                        "properties":{
                                            "path":{
                                                "$ref":"#/components/schemas/CollectionPath"
                                            },
                                            "aggregate":{
                                                "type":"array",
                                                "items":{
                                                    "$ref":"#/components/schemas/AggregateByProperty"
                                                }
                                            },
                                            "limit":{
                                                "type":"integer",
                                                "default":0,
                                                "minimum":0
                                            },
                                            "conditions":{
                                                "type":"array",
                                                "items":{
                                                    "$ref":"#/components/schemas/QueryCondition"
                                                },
                                                "default":[
                                                ],
                                                "minItems":0
                                            }
                                        },
                                        "required":[
                                            "path",
                                            "aggregate",
                                            "limit",
                                            "conditions"
                                        ]
                                    },
                                    {
                                        "type":"object",
                                        "description":"Perform a query on a DualityView",
                                        "properties":{
                                            "dv_name":{
                                                "type":"string",
                                                "description":"Duality View name"
                                            },
                                            "conditions":{
                                                "type":"array",
                                                "items":{
                                                    "$ref":"#/components/schemas/QueryCondition"
                                                }
                                            },
                                            "explicitOrder":{
                                                "type":"array",
                                                "items":{
                                                    "$ref":"#/components/schemas/OrderByProperty"
                                                }
                                            },
                                            "limit":{
                                                "type":"integer",
                                                "default":0,
                                                "minimum":0
                                            }
                                        },
                                        "required":[
                                            "dv_name",
                                            "conditions",
                                            "explicitOrder",
                                            "limit"
                                        ]
                                    }
                                ]
                            },
                            "examples":{
                                "singleDocument":{
                                    "summary":"Get a single user document",
                                    "value":{
                                        "path":[
                                            "users",
                                            "uuid123"
                                        ]
                                    }
                                },
                                "simpleQuery":{
                                    "summary":"Query based on conditions",
                                    "value":{
                                        "path":[
                                            "users",
                                            "uuid123",
                                            "recipes"
                                        ],
                                        "conditions":[
                                            {
                                                "field":"category",
                                                "op":"=",
                                                "value":"dessert"
                                            },
                                            {
                                                "field":"difficulty",
                                                "op":"<=",
                                                "value":3
                                            }
                                        ],
                                        "explicitOrder":[
                                            {
                                                "field":"title",
                                                "direction":"asc"
                                            }
                                        ],
                                        "limit":10
                                    }
                                },
                                "collectionGroup":{
                                    "summary":"Collection group query on notes",
                                    "value":{
                                        "col_group":"notes",
                                        "conditions":[
                                            {
                                                "field":"content",
                                                "op":"like",
                                                "value":"%important%"
                                            }
                                        ],
                                        "explicitOrder":[
                                            {
                                                "field":"createdAt",
                                                "direction":"desc"
                                            }
                                        ],
                                        "limit":5
                                    }
                                },
                                "joinQuery":{
                                    "summary":"Join query example",
                                    "value":{
                                        "path":[
                                        ],
                                        "joins":{
                                            "view_name":"TEST_1"
                                        },
                                        "explicitOrder":[
                                            {
                                                "field":"pid",
                                                "direction":"desc"
                                            }
                                        ],
                                        "limit":10
                                    }
                                },
                                "aggregationQuery":{
                                    "summary":"Aggregate based queries",
                                    "value":{
                                        "path":[
                                            "users",
                                            "uuid123",
                                            "recipes"
                                        ],
                                        "aggregate":[
                                            {
                                                "field":"avgRating",
                                                "func":"avg",
                                                "op_key":"avg_rating"
                                            }
                                        ],
                                        "conditions":[
                                            {
                                                "field":"category",
                                                "op":"=",
                                                "value":"dessert"
                                            }
                                        ],
                                        "limit":1
                                    }
                                },
                                "dualityViewQuery":{
                                    "summary":"Query on UserView duality view",
                                    "value":{
                                        "dv_name":"UserView",
                                        "conditions":[
                                            {
                                                "field":"displayName",
                                                "op":"like",
                                                "value":"John%"
                                            }
                                        ],
                                        "explicitOrder":[
                                            {
                                                "field":"displayName",
                                                "direction":"asc"
                                            }
                                        ],
                                        "limit":10
                                    }
                                }
                            }
                        }
                    }
                },
                "responses":{
                    "200":{
                        "description":"Returns list of documents, OID and document Data",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/QueryResponseItem"
                                },
                                "examples":{
                                    "collectionQuery":{
                                        "summary":"Output for collection table query",
                                        "value":{
                                            "ret":[
                                                {
                                                    "osons":{
                                                        "DOCUMENT":{
                                                            "displayName":"User123",
                                                            "email":"user123@example.com"
                                                        },
                                                        "OID":"ABCDEF123456",
                                                        "CREATED":"2023-10-25T14:00:00Z",
                                                        "LAST_MODIFIED":"2023-10-25T14:00:00Z",
                                                        "VERSION":1,
                                                        "SUBCOLLECTION":{
                                                        }
                                                    }
                                                }
                                            ]
                                        }
                                    },
                                    "relationalTableQuery":{
                                        "summary":"Output for relational table query",
                                        "value":{
                                            "ret":[
                                                {
                                                    "osons":{
                                                        "name":"pratik",
                                                        "age":1142568,
                                                        "about":"testapiversion2",
                                                        "OID":"FB03C10200",
                                                        "_id":1,
                                                        "parent_oid":"_docId",
                                                        "_metadata":{
                                                            "etag":"943EEC508908213D2D00FF375854BB48",
                                                            "asof":"0000000000000000"
                                                        }
                                                    }
                                                }
                                            ]
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401":{
                        "description":"Authentication Failure"
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-database-{project_id}-v1-runQuery-post",
                "x-filename-id":"_-baas-services-database-project_id-v1-runquery-post"
            }
        },
        "/_/baas-services/database/{project_id}/v2/setDocument":{
            "post":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase Database"
                ],
                "security":[
                    {
                        "bearerAuth":[
                        ],
                        "AppKey":[
                        ]
                    },
                    {
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Creates a new document or update an existing one",
                "description":"This service creates a new document in the specified collection or updates an existing one. For creating a new document, provide a collection path (odd-length array) and the data. For updating, provide a document path (even-length array), data, and options (e.g., merge: true to merge with existing data). Supports API version 2 for data formats. For duality views, specify dv_name, data, and optional OID for updates. Returns the OID of the created or updated document. Requires authentication via Bearer token or AppKey. Use 'version' in request Body for optimistic locking on updates. Payload may include \"$embeddings\" in document data for BYOV vector fields. For API version 2 operation-array payloads, `set` on `$embeddings` accepts an object keyed by vector column name, `delete` on `$embeddings` accepts an array of embedding keys, and delete semantics perform key-nulling in the request-resource transform; vector apply treats `null` as clear-column (sets VECTOR column to `NULL`).",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    },
                    {
                        "$ref":"#/components/parameters/transactionHeader"
                    }
                ],
                "requestBody":{
                    "description":"Contains Path, Options, DocumentData",
                    "required":true,
                    "content":{
                        "application/json":{
                            "schema":{
                                "oneOf":[
                                    {
                                        "type":"object",
                                        "properties":{
                                            "path":{
                                                "oneOf":[
                                                    {
                                                        "$ref":"#/components/schemas/CollectionPath"
                                                    },
                                                    {
                                                        "$ref":"#/components/schemas/DocumentPath"
                                                    }
                                                ]
                                            },
                                            "data":{
                                                "$ref":"#/components/schemas/UpdateDocV2"
                                            },
                                            "options":{
                                                "$ref":"#/components/schemas/MergeOptions"
                                            },
                                            "version":{
                                                "$ref":"#/components/schemas/DocVersion"
                                            }
                                        },
                                        "required":[
                                            "path",
                                            "data",
                                            "options"
                                        ]
                                    },
                                    {
                                        "type":"object",
                                        "properties":{
                                            "dv_name":{
                                                "type":"string",
                                                "description":"Duality View Name"
                                            },
                                            "data":{
                                                "type":"object"
                                            },
                                            "oid":{
                                                "type":"string",
                                                "description":"Document Identifier"
                                            },
                                            "version":{
                                                "$ref":"#/components/schemas/DocVersion"
                                            }
                                        },
                                        "required":[
                                            "dv_name",
                                            "data"
                                        ]
                                    }
                                ]
                            },
                            "examples":{
                                "createInCollection":{
                                    "summary":"Create a new document with random ID",
                                    "value":{
                                        "path":[
                                            "users"
                                        ],
                                        "data":{
                                            "displayName":"John Doe",
                                            "photoURL":"https://example.com/photo.jpg"
                                        }
                                    }
                                },
                                "addDocumentWithTimestamp":{
                                    "summary":"Create a new document with random ID w/ fields having servertimestamp",
                                    "value":{
                                        "path":[
                                            "users"
                                        ],
                                        "data":{
                                            "displayName":"John Doe",
                                            "photoURL":"https://example.com/photo.jpg"
                                        },
                                        "servertimestamp":[
                                            "createdAt",
                                            "modifiedAt"
                                        ]
                                    }
                                },
                                "createDocumentWithId":{
                                    "summary":"Create a Document with specific Document ID",
                                    "value":{
                                        "path":[
                                            "users",
                                            "uuid123",
                                            "recipes",
                                            "recipe456"
                                        ],
                                        "data":[
                                            {
                                                "field":"id",
                                                "op":"set",
                                                "value":"n123"
                                            },
                                            {
                                                "field":"ingredients",
                                                "op":"arrayUnion",
                                                "value":[
                                                    "sugar"
                                                ]
                                            },
                                            {
                                                "field":"updatedAt",
                                                "op":"servertimestamp",
                                                "value":null
                                            }
                                        ],
                                        "options":{
                                            "merge":false
                                        }
                                    }
                                },
                                "addDocumentWithVectors":{
                                    "summary":"Create new Document with vector embeddings",
                                    "value":{
                                        "path":[
                                            "myCollection"
                                        ],
                                        "data":{
                                            "title":"v1 vector doc",
                                            "category":"demo",
                                            "$embeddings":{
                                                "EMB":{
                                                    "type":"dense",
                                                    "values":[
                                                        0.11,
                                                        0.22,
                                                        0.33,
                                                        0.44
                                                    ]
                                                },
                                                "SP_EMB":{
                                                    "type":"sparse",
                                                    "dimension":384,
                                                    "indices":[
                                                        2,
                                                        5,
                                                        9
                                                    ],
                                                    "values":[
                                                        0.13,
                                                        0.23,
                                                        0.43
                                                    ]
                                                }
                                            }
                                        }
                                    }
                                },
                                "updateWithOperations":{
                                    "summary":"Targeted update using operations",
                                    "value":{
                                        "path":[
                                            "users",
                                            "uuid123",
                                            "recipes",
                                            "recipe456"
                                        ],
                                        "data":[
                                            {
                                                "field":"ingredients",
                                                "op":"arrayUnion",
                                                "value":[
                                                    "sugar"
                                                ]
                                            },
                                            {
                                                "field":"updatedAt",
                                                "op":"servertimestamp",
                                                "value":null
                                            },
                                            {
                                                "field":"deprecatedField",
                                                "op":"delete",
                                                "value":null
                                            }
                                        ],
                                        "options":{
                                            "merge":true
                                        }
                                    }
                                },
                                "optimisticUpdateWithVersion":{
                                    "summary":"Operations update with optimistic locking",
                                    "value":{
                                        "path":[
                                            "users",
                                            "uuid123"
                                        ],
                                        "data":[
                                            {
                                                "field":"email",
                                                "op":"set",
                                                "value":"john.new@example.com"
                                            }
                                        ],
                                        "options":{
                                            "merge":true
                                        },
                                        "version":"5"
                                    }
                                },
                                "upsertWithMerge":{
                                    "summary":"Upsert using merge (include options only for upsert)",
                                    "value":{
                                        "path":[
                                            "users",
                                            "uuid123"
                                        ],
                                        "data":[
                                            {
                                                "field":"tags",
                                                "op":"arrayUnion",
                                                "value":[
                                                    "pro",
                                                    "beta"
                                                ]
                                            },
                                            {
                                                "field":"loginCount",
                                                "op":"increment",
                                                "value":1
                                            }
                                        ],
                                        "options":{
                                            "merge":true
                                        }
                                    }
                                },
                                "dualityViewInsert":{
                                    "summary":"Set via duality view (insert)",
                                    "value":{
                                        "dv_name":"UserView",
                                        "data":{
                                            "displayName":"Jane Smith",
                                            "photoURL":"https://example.com/jane.jpg"
                                        }
                                    }
                                },
                                "setDocVectorEmbeddingsV2Ops":{
                                    "summary":"SetDocument v2 with $embeddings set/delete operations",
                                    "value":{
                                        "path":[
                                            "myCollection",
                                            "doc1"
                                        ],
                                        "data":[
                                            {
                                                "field":"text",
                                                "op":"set",
                                                "value":"v2 vector doc"
                                            },
                                            {
                                                "op":"set",
                                                "field":"$embeddings",
                                                "value":{
                                                    "EMB":{
                                                        "type":"dense",
                                                        "values":[
                                                            0.11,
                                                            0.22,
                                                            0.33,
                                                            0.44
                                                        ]
                                                    },
                                                    "SP_EMB":{
                                                        "type":"sparse",
                                                        "dimension":384,
                                                        "indices":[
                                                            2,
                                                            5,
                                                            9
                                                        ],
                                                        "values":[
                                                            0.13,
                                                            0.23,
                                                            0.43
                                                        ]
                                                    }
                                                }
                                            },
                                            {
                                                "op":"delete",
                                                "field":"$embeddings",
                                                "value":[
                                                    "SP_EMB"
                                                ]
                                            }
                                        ],
                                        "options":{
                                            "merge":true
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "responses":{
                    "200":{
                        "description":"Returns OID of the new/updated document",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/DocumentOID"
                                }
                            }
                        }
                    },
                    "401":{
                        "description":"Authentication Failure"
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-database-{project_id}-v2-setDocument-post",
                "x-filename-id":"_-baas-services-database-project_id-v2-setdocument-post"
            }
        },
        "/_/baas-services/database/{project_id}/v1/setDocument":{
            "post":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase Database"
                ],
                "security":[
                    {
                        "bearerAuth":[
                        ],
                        "AppKey":[
                        ]
                    },
                    {
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Creates a new document or update an existing one",
                "description":"This service creates a new document in the specified collection or updates an existing one. For creating a new document, provide a collection path (odd-length array) and the data. For updating, provide a document path (even-length array), data, and options (e.g., merge: true to merge with existing data). Supports API versions 1 for data formats. For duality views, specify dv_name, data, and optional OID for updates. Returns the OID of the created or updated document. Requires authentication via Bearer token or AppKey. Use 'version' in requestBody for optimistic locking on updates.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    },
                    {
                        "$ref":"#/components/parameters/transactionHeader"
                    }
                ],
                "requestBody":{
                    "description":"Contains Path, Options, DocumentData",
                    "required":true,
                    "content":{
                        "application/json":{
                            "schema":{
                                "oneOf":[
                                    {
                                        "type":"object",
                                        "properties":{
                                            "path":{
                                                "oneOf":[
                                                    {
                                                        "$ref":"#/components/schemas/CollectionPath"
                                                    },
                                                    {
                                                        "$ref":"#/components/schemas/DocumentPath"
                                                    }
                                                ]
                                            },
                                            "data":{
                                                "$ref":"#/components/schemas/UpdateDocV1"
                                            },
                                            "options":{
                                                "$ref":"#/components/schemas/MergeOptions"
                                            },
                                            "version":{
                                                "$ref":"#/components/schemas/DocVersion"
                                            }
                                        },
                                        "required":[
                                            "path",
                                            "data"
                                        ]
                                    },
                                    {
                                        "type":"object",
                                        "properties":{
                                            "dv_name":{
                                                "type":"string",
                                                "description":"Duality View Name"
                                            },
                                            "data":{
                                                "type":"object"
                                            },
                                            "oid":{
                                                "type":"string",
                                                "description":"Document Identifier"
                                            },
                                            "version":{
                                                "$ref":"#/components/schemas/DocVersion"
                                            }
                                        },
                                        "required":[
                                            "dv_name",
                                            "data"
                                        ]
                                    }
                                ]
                            },
                            "examples":{
                                "addToCollection":{
                                    "summary":"Add a new document to a collection",
                                    "value":{
                                        "path":[
                                            "users"
                                        ],
                                        "data":{
                                            "displayName":"John Doe",
                                            "photoURL":"https://example.com/photo.jpg"
                                        }
                                    }
                                },
                                "addDocumentWithTimestamp":{
                                    "summary":"Create a new document with random ID w/ fields having servertimestamp",
                                    "value":{
                                        "path":[
                                            "users"
                                        ],
                                        "data":{
                                            "displayName":"John Doe",
                                            "photoURL":"https://example.com/photo.jpg"
                                        },
                                        "servertimestamp":[
                                            "createdAt",
                                            "modifiedAt"
                                        ]
                                    }
                                },
                                "createDocumentWithId":{
                                    "summary":"Create a new document with a fixed ID",
                                    "value":{
                                        "path":[
                                            "users",
                                            "uuid123"
                                        ],
                                        "data":{
                                            "displayName":"John Doe",
                                            "email":"john@example.com",
                                            "createdAt":"2023-10-31T12:00:00Z"
                                        },
                                        "options":{
                                            "merge":false
                                        }
                                    }
                                },
                                "replaceDocument":{
                                    "summary":"Replace entire document (no merge)",
                                    "value":{
                                        "path":[
                                            "users",
                                            "uuid123"
                                        ],
                                        "data":{
                                            "displayName":"Johnathan Doe",
                                            "email":"johnathan@example.com"
                                        },
                                        "options":{
                                            "merge":false
                                        }
                                    }
                                },
                                "optimisticReplaceWithVersion":{
                                    "summary":"Replace with optimistic locking (VERSION check)",
                                    "value":{
                                        "path":[
                                            "users",
                                            "uuid123"
                                        ],
                                        "data":{
                                            "email":"new-email@example.com"
                                        },
                                        "options":{
                                            "merge":false
                                        },
                                        "version":"5"
                                    }
                                },
                                "upsertWithMerge":{
                                    "summary":"Upsert using merge (include options only for upsert)",
                                    "value":{
                                        "path":[
                                            "users",
                                            "uuid123"
                                        ],
                                        "data":{
                                            "profile":{
                                                "bio":"Hello world"
                                            }
                                        },
                                        "options":{
                                            "merge":true
                                        }
                                    }
                                },
                                "dualityViewInsert":{
                                    "summary":"Insert via duality view",
                                    "value":{
                                        "dv_name":"UserView",
                                        "data":{
                                            "displayName":"Jane Smith",
                                            "photoURL":"https://example.com/jane.jpg"
                                        }
                                    }
                                },
                                "dualityViewUpdateWithVersion":{
                                    "summary":"Update via duality view with version",
                                    "value":{
                                        "dv_name":"UserView",
                                        "oid":"abc123",
                                        "data":{
                                            "displayName":"Jane S."
                                        },
                                        "version":"7"
                                    }
                                }
                            }
                        }
                    }
                },
                "responses":{
                    "200":{
                        "description":"Returns OID of the new/updated document",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/DocumentOID"
                                }
                            }
                        }
                    },
                    "401":{
                        "description":"Authentication Failure"
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-database-{project_id}-v1-setDocument-post",
                "x-filename-id":"_-baas-services-database-project_id-v1-setdocument-post"
            }
        },
        "/_/baas-services/database/{project_id}/v2/updateDocument":{
            "put":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase Database"
                ],
                "security":[
                    {
                        "bearerAuth":[
                        ],
                        "AppKey":[
                        ]
                    },
                    {
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Update a document in a collection",
                "description":"This service updates an existing document in a specified collection and returns the OID (Object Identifier) of the updated document upon successful operation. The update requires specifying the document's path and the data fields to modify. For collection-based updates, provide the path as an array alternating between collection names and document IDs (e.g., ['users', 'user123']). The 'data' field can be an array of operations for targeted updates (API version 2), supporting actions like set, delete, arrayUnion, arrayRemove, increment, and servertimestamp. For duality view updates, specify the view name ('dv_name'), the document OID, and the data object to update. If a version is provided in request payload, it ensures optimistic locking. This endpoint requires authentication via Bearer token or AppKey. Payload may include \"$embeddings\" in document data for BYOV vector fields. For API version 2 operation-array payloads, `set` on `$embeddings` accepts an object keyed by vector column name, `delete` on `$embeddings` accepts an array of embedding keys, and delete semantics perform key-nulling in the request-resource transform; vector apply treats `null` as clear-column (sets VECTOR column to `NULL`).",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    },
                    {
                        "$ref":"#/components/parameters/transactionHeader"
                    }
                ],
                "requestBody":{
                    "required":true,
                    "content":{
                        "application/json":{
                            "schema":{
                                "oneOf":[
                                    {
                                        "type":"object",
                                        "properties":{
                                            "path":{
                                                "$ref":"#/components/schemas/DocumentPath"
                                            },
                                            "data":{
                                                "$ref":"#/components/schemas/UpdateDocV2"
                                            },
                                            "options":{
                                                "$ref":"#/components/schemas/MergeOptions"
                                            },
                                            "version":{
                                                "$ref":"#/components/schemas/DocVersion"
                                            }
                                        },
                                        "required":[
                                            "path",
                                            "data"
                                        ],
                                        "additionalProperties":false
                                    },
                                    {
                                        "type":"object",
                                        "properties":{
                                            "dv_name":{
                                                "type":"string",
                                                "description":"Duality View Name"
                                            },
                                            "data":{
                                                "type":"object"
                                            },
                                            "oid":{
                                                "type":"string",
                                                "description":"Document Identifier"
                                            },
                                            "version":{
                                                "$ref":"#/components/schemas/DocVersion"
                                            }
                                        },
                                        "required":[
                                            "dv_name",
                                            "oid",
                                            "data"
                                        ]
                                    }
                                ]
                            },
                            "examples":{
                                "targetedPathUpdate":{
                                    "summary":"Targeted operations update using path (API version 2)",
                                    "value":{
                                        "path":[
                                            "users",
                                            "user123"
                                        ],
                                        "data":[
                                            {
                                                "field":"age",
                                                "op":"increment",
                                                "value":1
                                            },
                                            {
                                                "field":"tags",
                                                "op":"arrayUnion",
                                                "value":[
                                                    "developer",
                                                    "engineer"
                                                ]
                                            },
                                            {
                                                "field":"lastUpdated",
                                                "op":"servertimestamp",
                                                "value":null
                                            }
                                        ]
                                    }
                                },
                                "targetedDualityViewUpdate":{
                                    "summary":"Targeted operations update using path (API version 2)",
                                    "value":{
                                        "dv_name":"UserView",
                                        "oid":"abc123",
                                        "data":[
                                            {
                                                "field":"age",
                                                "op":"increment",
                                                "value":1
                                            },
                                            {
                                                "field":"tags",
                                                "op":"arrayUnion",
                                                "value":[
                                                    "developer",
                                                    "engineer"
                                                ]
                                            },
                                            {
                                                "field":"lastUpdated",
                                                "op":"servertimestamp",
                                                "value":null
                                            }
                                        ]
                                    }
                                },
                                "updateDocVectorEmbeddingsV2Ops":{
                                    "summary":"UpdateDocument v2 with $embeddings set/delete operations",
                                    "value":{
                                        "path":[
                                            "myCollection",
                                            "doc1"
                                        ],
                                        "data":[
                                            {
                                                "field":"text",
                                                "op":"set",
                                                "value":"v2 vector doc"
                                            },
                                            {
                                                "op":"set",
                                                "field":"$embeddings",
                                                "value":{
                                                    "EMB":{
                                                        "type":"dense",
                                                        "values":[
                                                            0.11,
                                                            0.22,
                                                            0.33,
                                                            0.44
                                                        ]
                                                    },
                                                    "SP_EMB":{
                                                        "type":"sparse",
                                                        "dimension":384,
                                                        "indices":[
                                                            2,
                                                            5,
                                                            9
                                                        ],
                                                        "values":[
                                                            0.13,
                                                            0.23,
                                                            0.43
                                                        ]
                                                    }
                                                }
                                            },
                                            {
                                                "op":"delete",
                                                "field":"$embeddings",
                                                "value":[
                                                    "SP_EMB"
                                                ]
                                            }
                                        ]
                                    }
                                }
                            }
                        }
                    }
                },
                "responses":{
                    "200":{
                        "description":"Returns OID of the updated document",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/DocumentOID"
                                }
                            }
                        }
                    },
                    "401":{
                        "description":"Authentication Failure"
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-database-{project_id}-v2-updateDocument-put",
                "x-filename-id":"_-baas-services-database-project_id-v2-updatedocument-put"
            }
        },
        "/_/baas-services/database/{project_id}/v1/updateDocument":{
            "put":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase Database"
                ],
                "security":[
                    {
                        "bearerAuth":[
                        ],
                        "AppKey":[
                        ]
                    },
                    {
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Update a document in a collection",
                "description":"This service updates an existing document in a specified collection and returns the OID (Object Identifier) of the updated document upon successful operation. The update requires specifying the document's path and the data fields to modify. For collection-based updates, provide the path as an array alternating between collection names and document IDs (e.g., ['users', 'user123']). The 'data' field can be a direct object for replacement (API version 1). For duality view updates, specify the view name ('dv_name'), the document OID, and the data object to update. If a version is provided in the payload, it ensures optimistic locking. This endpoint requires authentication via Bearer token or AppKey.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    },
                    {
                        "$ref":"#/components/parameters/transactionHeader"
                    }
                ],
                "requestBody":{
                    "required":true,
                    "content":{
                        "application/json":{
                            "schema":{
                                "oneOf":[
                                    {
                                        "type":"object",
                                        "properties":{
                                            "path":{
                                                "$ref":"#/components/schemas/DocumentPath"
                                            },
                                            "data":{
                                                "$ref":"#/components/schemas/UpdateDocV1"
                                            },
                                            "version":{
                                                "$ref":"#/components/schemas/DocVersion"
                                            }
                                        },
                                        "required":[
                                            "path",
                                            "data"
                                        ],
                                        "additionalProperties":false
                                    },
                                    {
                                        "type":"object",
                                        "properties":{
                                            "dv_name":{
                                                "type":"string",
                                                "description":"Duality View Name"
                                            },
                                            "data":{
                                                "type":"object"
                                            },
                                            "oid":{
                                                "type":"string",
                                                "description":"Document Identifier"
                                            },
                                            "version":{
                                                "$ref":"#/components/schemas/DocVersion"
                                            }
                                        },
                                        "required":[
                                            "dv_name",
                                            "oid",
                                            "data"
                                        ]
                                    }
                                ]
                            },
                            "examples":{
                                "simplePathUpdate":{
                                    "summary":"Simple update using path (API version 1)",
                                    "value":{
                                        "path":[
                                            "users",
                                            "user123"
                                        ],
                                        "data":{
                                            "name":"John Doe",
                                            "age":30,
                                            "email":"john@example.com"
                                        }
                                    }
                                },
                                "dualityViewUpdate":{
                                    "summary":"Update using duality view (API Version 1)",
                                    "value":{
                                        "dv_name":"UserView",
                                        "oid":"abc123",
                                        "data":{
                                            "name":"Jane Smith",
                                            "age":28,
                                            "address":{
                                                "street":"123 Main St",
                                                "city":"Anytown"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "responses":{
                    "200":{
                        "description":"Returns OID of the updated document",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/DocumentOID"
                                }
                            }
                        }
                    },
                    "401":{
                        "description":"Authentication Failure"
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-database-{project_id}-v1-updateDocument-put",
                "x-filename-id":"_-baas-services-database-project_id-v1-updatedocument-put"
            }
        },
        "/_/baas-services/database/{project_id}/deleteDocument":{
            "put":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase Database"
                ],
                "security":[
                    {
                        "bearerAuth":[
                        ],
                        "AppKey":[
                        ]
                    },
                    {
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Deletes a document from a collection",
                "description":"This service deletes a document from the specified collection or via a duality view. Provide the document path (even-length array) for collection deletion or dv_name and oid for duality view deletion. Returns the OID of the deleted document upon success. Supports optimistic locking with the 'version' query parameter. Requires authentication via Bearer token or AppKey.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    },
                    {
                        "$ref":"#/components/parameters/transactionHeader"
                    }
                ],
                "requestBody":{
                    "required":true,
                    "content":{
                        "application/json":{
                            "schema":{
                                "oneOf":[
                                    {
                                        "type":"object",
                                        "properties":{
                                            "path":{
                                                "$ref":"#/components/schemas/DocumentPath"
                                            },
                                            "version":{
                                                "$ref":"#/components/schemas/DocVersion"
                                            }
                                        },
                                        "required":[
                                            "path"
                                        ],
                                        "additionalProperties":false
                                    },
                                    {
                                        "type":"object",
                                        "properties":{
                                            "dv_name":{
                                                "type":"string",
                                                "description":"Duality View name"
                                            },
                                            "oid":{
                                                "type":"string",
                                                "description":"Document Identifier"
                                            },
                                            "version":{
                                                "$ref":"#/components/schemas/DocVersion"
                                            }
                                        },
                                        "required":[
                                            "dv_name"
                                        ],
                                        "additionalProperties":false
                                    }
                                ]
                            },
                            "examples":{
                                "deleteByPath":{
                                    "summary":"Delete document by path",
                                    "value":{
                                        "path":[
                                            "users",
                                            "uuid123"
                                        ]
                                    }
                                },
                                "deleteByDualityView":{
                                    "summary":"Delete via duality view",
                                    "value":{
                                        "dv_name":"UserView",
                                        "oid":"abc123"
                                    }
                                }
                            }
                        }
                    }
                },
                "responses":{
                    "200":{
                        "description":"Returns OID of the deleted document",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/DocumentOID"
                                }
                            }
                        }
                    },
                    "401":{
                        "description":"Authentication Failure"
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-database-{project_id}-deleteDocument-put",
                "x-filename-id":"_-baas-services-database-project_id-deletedocument-put"
            }
        },
        "/_/baas-services/dbfs/{project_id}/getmetadata/b/{bucket}":{
            "get":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase ObjectStore - DBFS"
                ],
                "security":[
                    {
                        "bearerAuth":[
                        ],
                        "AppKey":[
                        ]
                    },
                    {
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Fetch metadata for a stored object",
                "description":"Retrieves metadata for a specific object in the specified bucket. The metadata includes details such as full path, bucket, size, creation time, update time, MD5 hash, name, and content type. Requires authentication via Bearer token or AppKey.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    },
                    {
                        "$ref":"#/components/parameters/storageBucket"
                    },
                    {
                        "$ref":"#/components/parameters/objectLocatorHeader"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Returns the metadata for the object",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "type":"object",
                                    "properties":{
                                        "fullPath":{
                                            "$ref":"#/components/schemas/ObjectPath"
                                        },
                                        "bucket":{
                                            "$ref":"#/components/schemas/StorageBucket"
                                        },
                                        "size":{
                                            "type":"integer",
                                            "minimum":0,
                                            "format":"int64"
                                        },
                                        "timeCreated":{
                                            "type":"string",
                                            "format":"date-time",
                                            "maxLength":64
                                        },
                                        "updated":{
                                            "type":"string",
                                            "format":"date-time",
                                            "maxLength":64
                                        },
                                        "md5Hash":{
                                            "type":"string",
                                            "description":"MD5 Hash of the object uploaded through PutObject",
                                            "maxLength":32
                                        },
                                        "opc-multipart-md5":{
                                            "type":"string",
                                            "description":"MD5 Hash of the object uploaded through Multipart Upload",
                                            "maxLength":32
                                        },
                                        "name":{
                                            "type":"string",
                                            "description":"Name of the Object",
                                            "maxLength":32
                                        },
                                        "contentType":{
                                            "type":"string",
                                            "description":"Content type of the data uploaded",
                                            "maxLength":32
                                        }
                                    },
                                    "required":[
                                        "fullPath",
                                        "name",
                                        "bucket",
                                        "timeCreated",
                                        "updated",
                                        "contentType",
                                        "size"
                                    ],
                                    "additionalProperties":false
                                },
                                "examples":{
                                    "exampleMetadata":{
                                        "summary":"Example object metadata",
                                        "value":{
                                            "fullPath":"images/profile.jpg",
                                            "bucket":"userBucket",
                                            "size":102400,
                                            "timeCreated":"2023-10-24T12:00:00Z",
                                            "updated":"2023-10-24T12:05:00Z",
                                            "md5Hash":"d41d8cd98f00b204e9800998ecf8427e",
                                            "name":"profile.jpg",
                                            "contentType":"image/jpeg"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401":{
                        "description":"Authentication Failure"
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-dbfs-{project_id}-getmetadata-b-{bucket}-get",
                "x-filename-id":"_-baas-services-dbfs-project_id-getmetadata-b-bucket-get"
            }
        },
        "/_/baas-services/dbfs/{project_id}/o/operation":{
            "post":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase ObjectStore - DBFS"
                ],
                "security":[
                    {
                        "bearerAuth":[
                        ],
                        "AppKey":[
                        ]
                    },
                    {
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Upload object in single request",
                "description":"Uploads an object to the specified path in the bucket in a single request. Suitable for small files. The request body is the binary content of the object. Returns metadata of the uploaded object upon success. Requires authentication.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    },
                    {
                        "$ref":"#/components/parameters/objectLocatorHeader"
                    }
                ],
                "requestBody":{
                    "description":"Contains the object content",
                    "required":true,
                    "content":{
                        "*/*":{
                            "schema":{
                                "type":"string",
                                "format":"binary"
                            }
                        }
                    }
                },
                "responses":{
                    "200":{
                        "description":"Returns the metadata for the uploaded object",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "type":"object",
                                    "properties":{
                                        "metadata":{
                                            "$ref":"#/components/schemas/ObjectMetadata"
                                        }
                                    },
                                    "additionalProperties":false
                                },
                                "examples":{
                                    "uploadedMetadata":{
                                        "summary":"Metadata of uploaded object",
                                        "value":{
                                            "metadata":{
                                                "contentType":"image/png",
                                                "name":"logo.png",
                                                "bucket":"appBucket",
                                                "size":20480,
                                                "md5sum":"098f6bcd4621d373cade4e832627b4f6",
                                                "updated":"2023-10-24T12:05:00Z",
                                                "timeCreated":"2023-10-24T12:05:00Z"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401":{
                        "description":"Authentication Failure"
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-dbfs-{project_id}-o-operation-post",
                "x-filename-id":"_-baas-services-dbfs-project_id-o-operation-post"
            },
            "get":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase ObjectStore - DBFS"
                ],
                "security":[
                    {
                        "bearerAuth":[
                        ],
                        "AppKey":[
                        ]
                    },
                    {
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Download object from the store",
                "description":"Downloads the object from the specified path in the bucket. The response is the binary content of the object. Requires authentication.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    },
                    {
                        "$ref":"#/components/parameters/objectLocatorHeader"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Downloads the object",
                        "content":{
                            "*/*":{
                                "schema":{
                                    "type":"string",
                                    "format":"binary"
                                }
                            }
                        }
                    },
                    "401":{
                        "description":"Authentication Failure"
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-dbfs-{project_id}-o-operation-get",
                "x-filename-id":"_-baas-services-dbfs-project_id-o-operation-get"
            },
            "delete":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase ObjectStore - DBFS"
                ],
                "security":[
                    {
                        "bearerAuth":[
                        ],
                        "AppKey":[
                        ]
                    },
                    {
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Delete object from the store",
                "description":"Deletes the object from the specified path in the bucket. Returns success status upon deletion. Requires authentication.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    },
                    {
                        "$ref":"#/components/parameters/objectLocatorHeader"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Deleted the object successfully",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "type":"object",
                                    "properties":{
                                        "success":{
                                            "type":"integer",
                                            "enum":[
                                                1
                                            ]
                                        }
                                    }
                                },
                                "examples":{
                                    "deleteSuccess":{
                                        "summary":"Successful deletion",
                                        "value":{
                                            "success":1
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401":{
                        "description":"Authentication Failure"
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-dbfs-{project_id}-o-operation-delete",
                "x-filename-id":"_-baas-services-dbfs-project_id-o-operation-delete"
            }
        },
        "/_/baas-services/dbfs/{project_id}/listallobj/b/{bucket}":{
            "get":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase ObjectStore - DBFS"
                ],
                "security":[
                    {
                        "bearerAuth":[
                        ],
                        "AppKey":[
                        ]
                    },
                    {
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"List all files within a directory",
                "description":"Lists all objects and prefixes (folders) in the specified bucket and path. Supports recursion and pagination via header parameters. Returns a list of items and prefixes, with next page token if more results are available. Requires authentication.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    },
                    {
                        "$ref":"#/components/parameters/storageBucket"
                    },
                    {
                        "name":"x-dbfs-list-opts",
                        "in":"header",
                        "description":"Specifies object path and recurse attributes",
                        "schema":{
                            "type":"object",
                            "properties":{
                                "path":{
                                    "$ref":"#/components/schemas/ObjectPath"
                                },
                                "recurse":{
                                    "type":"boolean",
                                    "default":"false"
                                },
                                "pageToken":{
                                    "type":"integer",
                                    "default":0
                                },
                                "maxResults":{
                                    "type":"integer",
                                    "minimum":1,
                                    "default":1000
                                }
                            },
                            "additionalProperties":false,
                            "required":[
                                "path",
                                "recurse"
                            ]
                        }
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Listed files(items) and folders(prefixes)",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "type":"object",
                                    "properties":{
                                        "items":{
                                            "type":"array",
                                            "description":"Files",
                                            "items":{
                                                "type":"object",
                                                "properties":{
                                                    "name":{
                                                        "$ref":"#/components/schemas/ObjectPath"
                                                    }
                                                }
                                            }
                                        },
                                        "prefixes":{
                                            "type":"array",
                                            "description":"Folders",
                                            "items":{
                                                "type":"object",
                                                "properties":{
                                                    "name":{
                                                        "$ref":"#/components/schemas/ObjectPath"
                                                    }
                                                }
                                            }
                                        },
                                        "nextPageToken":{
                                            "type":"integer",
                                            "description":"Token to pass in the next request to fetch next results"
                                        }
                                    },
                                    "required":[
                                        "items",
                                        "prefixes",
                                        "nextPageToken"
                                    ]
                                }
                            }
                        }
                    },
                    "401":{
                        "description":"Authentication Failure"
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-dbfs-{project_id}-listallobj-b-{bucket}-get",
                "x-filename-id":"_-baas-services-dbfs-project_id-listallobj-b-bucket-get"
            }
        },
        "/_/baas-services/dbfs/{project_id}/genpreauth":{
            "post":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase ObjectStore - DBFS"
                ],
                "security":[
                    {
                        "bearerAuth":[
                        ],
                        "AppKey":[
                        ]
                    },
                    {
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Generate PreAuthenticated Request URLs for download/upload",
                "description":"This service allows Pre-Authenticated Request URLs for download/multipart upload objects. The URLs will be generated if Security rules allow it, but the generated URL itself will bypass the security rules and perform the operation.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    }
                ],
                "requestBody":{
                    "content":{
                        "application/json":{
                            "schema":{
                                "type":"object",
                                "properties":{
                                    "path":{
                                        "$ref":"#/components/schemas/ObjectPath"
                                    },
                                    "bucket":{
                                        "$ref":"#/components/schemas/StorageBucket"
                                    },
                                    "access_type":{
                                        "type":"string",
                                        "enum":[
                                            "ObjectWrite",
                                            "ObjectRead"
                                        ]
                                    },
                                    "metadata":{
                                        "type":"object",
                                        "description":"Can pass an empty object for ObjectRead access type",
                                        "properties":{
                                            "contentType":{
                                                "type":"string",
                                                "example":"image/png"
                                            },
                                            "size":{
                                                "type":"integer"
                                            }
                                        },
                                        "additionalProperties":true
                                    }
                                },
                                "required":[
                                    "path",
                                    "bucket",
                                    "access_type",
                                    "metadata"
                                ],
                                "additionalProperties":false
                            }
                        }
                    }
                },
                "responses":{
                    "200":{
                        "description":"Created the PreAuthenticated Request(PAR) URL successfully",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "oneOf":[
                                        {
                                            "type":"object",
                                            "properties":{
                                                "accessUri":{
                                                    "type":"string"
                                                },
                                                "bucket":{
                                                    "$ref":"#/components/schemas/StorageBucket"
                                                },
                                                "object":{
                                                    "$ref":"#/components/schemas/ObjectPath"
                                                },
                                                "uploadId":{
                                                    "$ref":"#/components/schemas/GUID"
                                                },
                                                "timeCreated":{
                                                    "type":"string",
                                                    "format":"date-time",
                                                    "maxLength":30
                                                }
                                            }
                                        },
                                        {
                                            "type":"object",
                                            "properties":{
                                                "PAR_ID":{
                                                    "$ref":"#/components/schemas/GUID"
                                                },
                                                "URL":{
                                                    "type":"string"
                                                }
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401":{
                        "description":"Authentication Failure"
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-dbfs-{project_id}-genpreauth-post",
                "x-filename-id":"_-baas-services-dbfs-project_id-genpreauth-post"
            }
        },
        "/_/baas-services/dbfs/par/{project_id}/accessuri/{par_id}/r/b/{bucket}/o/{filepath}":{
            "get":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase ObjectStore - DBFS PAR"
                ],
                "summary":"Download object from the object store.",
                "description":"This service downloads the object, based on the PreAuthenticated Request ID generated, without involving security rule or any auth method.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    },
                    {
                        "$ref":"#/components/parameters/preAuthRequestID"
                    },
                    {
                        "$ref":"#/components/parameters/storageBucket"
                    },
                    {
                        "$ref":"#/components/parameters/filePathURL"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Successfully downloaded the object",
                        "content":{
                            "*/*":{
                                "schema":{
                                    "type":"string",
                                    "format":"binary"
                                }
                            }
                        }
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-dbfs-par-{project_id}-accessuri-{par_id}-r-b-{bucket}-o-{filepath}-get",
                "x-filename-id":"_-baas-services-dbfs-par-project_id-accessuri-par_id-r-b-bucket-o-filepath-get"
            }
        },
        "/_/baas-services/dbfs/par/{project_id}/accessuri/w/b/{bucket}/u/{filepath}/id/{multipart_id}/":{
            "post":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase ObjectStore - DBFS PAR"
                ],
                "summary":"Commit the multipart request chunks to the ObjectStore.",
                "description":"This service combines all the uploaded chunks, creates an object in the Store and commits the Multipart Request ID generated, without involving security rule or any auth method.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    },
                    {
                        "$ref":"#/components/parameters/multipartRequestID"
                    },
                    {
                        "$ref":"#/components/parameters/storageBucket"
                    },
                    {
                        "$ref":"#/components/parameters/filePathURL"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Successfully created object and committed the multipart request",
                        "headers":{
                            "opc-multipart-md5":{
                                "description":"MD5Hash calculated for the multipart Upload. Each part MD5 hash is calculated and concatenated. Finally, the MD5 Hash of the concatenated hashes is returned.",
                                "schema":{
                                    "type":"string",
                                    "maxLength":32
                                }
                            },
                            "last-modified":{
                                "description":"Last modified time for the object",
                                "schema":{
                                    "type":"string",
                                    "format":"date-time"
                                }
                            },
                            "time-created":{
                                "description":"Creation time for the object",
                                "schema":{
                                    "type":"string",
                                    "format":"date-time"
                                }
                            }
                        }
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-dbfs-par-{project_id}-accessuri-w-b-{bucket}-u-{filepath}-id-{multipart_id}--post",
                "x-filename-id":"_-baas-services-dbfs-par-project_id-accessuri-w-b-bucket-u-filepath-id-multipart_id-post"
            },
            "delete":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase ObjectStore - DBFS PAR"
                ],
                "summary":"Abort the multipart request and delete the uploaded chunks.",
                "description":"This service deletes all the uploaded chunks, aborts the Multipart Request generated, without involving security rule or any auth method.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    },
                    {
                        "$ref":"#/components/parameters/multipartRequestID"
                    },
                    {
                        "$ref":"#/components/parameters/storageBucket"
                    },
                    {
                        "$ref":"#/components/parameters/filePathURL"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Successfully aborted the multipart request"
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-dbfs-par-{project_id}-accessuri-w-b-{bucket}-u-{filepath}-id-{multipart_id}--delete",
                "x-filename-id":"_-baas-services-dbfs-par-project_id-accessuri-w-b-bucket-u-filepath-id-multipart_id-delete"
            }
        },
        "/_/baas-services/dbfs/par/{project_id}/accessuri/w/b/{bucket}/u/{filepath}/id/{multipart_id}/{upload_part}":{
            "put":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase ObjectStore - DBFS PAR"
                ],
                "summary":"Upload chunk of an object to the objectStore.",
                "description":"This service uploads a chunk of an object, indexed by <upload_part>, based on the Multipart Request ID generated, without involving security rule or any auth method.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    },
                    {
                        "$ref":"#/components/parameters/multipartRequestID"
                    },
                    {
                        "$ref":"#/components/parameters/storageBucket"
                    },
                    {
                        "$ref":"#/components/parameters/filePathURL"
                    },
                    {
                        "name":"upload_part",
                        "in":"path",
                        "required":true,
                        "schema":{
                            "type":"integer",
                            "format":"int64",
                            "minimum":1
                        }
                    }
                ],
                "requestBody":{
                    "required":true,
                    "content":{
                        "*/*":{
                            "schema":{
                                "type":"string",
                                "format":"binary"
                            }
                        }
                    }
                },
                "responses":{
                    "200":{
                        "description":"Successfully uploaded the chunk"
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-dbfs-par-{project_id}-accessuri-w-b-{bucket}-u-{filepath}-id-{multipart_id}-{upload_part}-put",
                "x-filename-id":"_-baas-services-dbfs-par-project_id-accessuri-w-b-bucket-u-filepath-id-multipart_id-upload_part-put"
            }
        },
        "/_/baas-services/oci-objs/{project_id}/getmetadata/b/{bucket}":{
            "get":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase ObjectStore - OCI"
                ],
                "security":[
                    {
                        "bearerAuth":[
                        ],
                        "AppKey":[
                        ]
                    },
                    {
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Fetch metadata for a stored object",
                "description":"Retrieves metadata for a specific object in the OCI bucket, including name, bucket, size, update time, content type, MD5 hash, and storage tier. Requires authentication.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    },
                    {
                        "$ref":"#/components/parameters/storageBucket"
                    },
                    {
                        "$ref":"#/components/parameters/objectLocatorHeader"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Returns the metadata for the object",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "type":"object",
                                    "properties":{
                                        "name":{
                                            "$ref":"#/components/schemas/ObjectPath"
                                        },
                                        "bucket":{
                                            "$ref":"#/components/schemas/StorageBucket"
                                        },
                                        "size":{
                                            "type":"integer",
                                            "minimum":0,
                                            "format":"int64"
                                        },
                                        "updated":{
                                            "type":"string",
                                            "format":"date-time",
                                            "maxLength":64
                                        },
                                        "contentType":{
                                            "type":"string",
                                            "description":"Type of the content uploaded",
                                            "maxLength":32
                                        },
                                        "md5Hash":{
                                            "type":"string",
                                            "description":"MD5 Hash of the object uploaded through PutObject",
                                            "maxLength":32
                                        },
                                        "opc-multipart-md5":{
                                            "type":"string",
                                            "description":"MD5 Hash of the object uploaded through Multipart Upload",
                                            "maxLength":32
                                        },
                                        "storageTier":{
                                            "type":"string",
                                            "description":"Storage tier of the Object",
                                            "maxLength":32
                                        }
                                    },
                                    "required":[
                                        "name",
                                        "bucket",
                                        "size",
                                        "updated",
                                        "contentType"
                                    ],
                                    "additionalProperties":false
                                },
                                "examples":{
                                    "ociMetadata":{
                                        "summary":"Example OCI object metadata",
                                        "value":{
                                            "name":"documents/report.pdf",
                                            "bucket":"projectBucket",
                                            "size":512000,
                                            "updated":"2023-10-24T13:00:00Z",
                                            "contentType":"application/pdf",
                                            "md5Hash":"3f00af7d4a4ded1c5c94f5e4f9c4a4b1",
                                            "storageTier":"Standard"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401":{
                        "description":"Authentication Failure"
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-oci-objs-{project_id}-getmetadata-b-{bucket}-get",
                "x-filename-id":"_-baas-services-oci-objs-project_id-getmetadata-b-bucket-get"
            }
        },
        "/_/baas-services/oci-objs/{project_id}/o/operation":{
            "post":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase ObjectStore - OCI"
                ],
                "security":[
                    {
                        "bearerAuth":[
                        ],
                        "AppKey":[
                        ]
                    },
                    {
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Upload object in single request",
                "description":"Uploads an object to the OCI bucket in a single request. Returns the name and metadata of the uploaded object. Suitable for small files.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    },
                    {
                        "$ref":"#/components/parameters/objectLocatorHeader"
                    }
                ],
                "requestBody":{
                    "description":"Contains the object content",
                    "required":true,
                    "content":{
                        "*/*":{
                            "schema":{
                                "type":"string",
                                "format":"binary"
                            }
                        }
                    }
                },
                "responses":{
                    "200":{
                        "description":"Returns the metadata for the uploaded object",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "type":"object",
                                    "properties":{
                                        "name":{
                                            "type":"string",
                                            "maxLength":128,
                                            "pattern":"[a-zA-Z][a-zA-Z0-9.]*[a-zA-Z]$"
                                        },
                                        "metadata":{
                                            "type":"object",
                                            "properties":{
                                                "size":{
                                                    "type":"integer",
                                                    "format":"int64"
                                                },
                                                "contentType":{
                                                    "type":"string",
                                                    "pattern":"^[a-zA-Z]*/[a-zA-Z]*$",
                                                    "example":"application/octet-stream"
                                                },
                                                "md5sum":{
                                                    "type":"string",
                                                    "pattern":"^[a-fA-F0-9]{32}$",
                                                    "maxLength":32
                                                },
                                                "updated":{
                                                    "type":"string",
                                                    "format":"date-time"
                                                }
                                            },
                                            "required":[
                                                "md5sum"
                                            ],
                                            "additionalProperties":false
                                        }
                                    },
                                    "additionalProperties":false
                                },
                                "examples":{
                                    "uploadResponse":{
                                        "summary":"Example upload response",
                                        "value":{
                                            "name":"file.txt",
                                            "metadata":{
                                                "size":1234,
                                                "contentType":"text/plain",
                                                "md5sum":"d41d8cd98f00b204e9800998ecf8427e",
                                                "updated":"2023-10-24T13:00:00Z"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401":{
                        "description":"Authentication Failure"
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-oci-objs-{project_id}-o-operation-post",
                "x-filename-id":"_-baas-services-oci-objs-project_id-o-operation-post"
            },
            "get":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase ObjectStore - OCI"
                ],
                "security":[
                    {
                        "bearerAuth":[
                        ],
                        "AppKey":[
                        ]
                    },
                    {
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Download object from the store",
                "description":"Downloads the object from the OCI bucket. The response is the binary content.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    },
                    {
                        "$ref":"#/components/parameters/objectLocatorHeader"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Downloads the object",
                        "content":{
                            "*/*":{
                                "schema":{
                                    "type":"string",
                                    "format":"binary"
                                }
                            }
                        }
                    },
                    "401":{
                        "description":"Authentication Failure"
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-oci-objs-{project_id}-o-operation-get",
                "x-filename-id":"_-baas-services-oci-objs-project_id-o-operation-get"
            },
            "delete":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase ObjectStore - OCI"
                ],
                "security":[
                    {
                        "bearerAuth":[
                        ],
                        "AppKey":[
                        ]
                    },
                    {
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Delete object from the store",
                "description":"Deletes the object from the OCI bucket. Returns success status.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    },
                    {
                        "$ref":"#/components/parameters/objectLocatorHeader"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Deleted the object successfully",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "type":"object",
                                    "properties":{
                                        "success":{
                                            "type":"integer",
                                            "enum":[
                                                1
                                            ]
                                        }
                                    }
                                },
                                "examples":{
                                    "successResponse":{
                                        "summary":"Successful deletion",
                                        "value":{
                                            "success":1
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401":{
                        "description":"Authentication Failure"
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-oci-objs-{project_id}-o-operation-delete",
                "x-filename-id":"_-baas-services-oci-objs-project_id-o-operation-delete"
            }
        },
        "/_/baas-services/oci-objs/{project_id}/listallobj/b/{bucket}":{
            "get":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase ObjectStore - OCI"
                ],
                "security":[
                    {
                        "bearerAuth":[
                        ],
                        "AppKey":[
                        ]
                    },
                    {
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"List all files within a directory",
                "description":"Lists objects in the OCI bucket with options for path, recursion, pagination. Returns items, prefixes, and next token.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    },
                    {
                        "$ref":"#/components/parameters/storageBucket"
                    },
                    {
                        "name":"x-dbfs-list-opts",
                        "in":"header",
                        "description":"Specifies object path and recurse attributes",
                        "schema":{
                            "type":"object",
                            "properties":{
                                "path":{
                                    "$ref":"#/components/schemas/ObjectPath"
                                },
                                "recurse":{
                                    "type":"boolean",
                                    "default":"false"
                                },
                                "pageToken":{
                                    "type":"string",
                                    "description":"The parameter is sent by a previous call to listObjects, if there are more results."
                                },
                                "maxResults":{
                                    "type":"integer",
                                    "minimum":1,
                                    "default":1000
                                }
                            },
                            "additionalProperties":false,
                            "required":[
                                "path",
                                "recurse"
                            ]
                        }
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Listed files(items) and folders(prefixes)",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "type":"object",
                                    "properties":{
                                        "items":{
                                            "type":"array",
                                            "description":"Files",
                                            "items":{
                                                "$ref":"#/components/schemas/ObjectSummary"
                                            }
                                        },
                                        "prefixes":{
                                            "type":"array",
                                            "description":"Folders",
                                            "items":{
                                                "$ref":"#/components/schemas/ObjectPath"
                                            }
                                        },
                                        "nextPageToken":{
                                            "type":"string",
                                            "description":"Token to pass in the next request to fetch next results"
                                        }
                                    },
                                    "required":[
                                        "items",
                                        "prefixes",
                                        "nextPageToken"
                                    ]
                                },
                                "examples":{
                                    "listResponse":{
                                        "summary":"Example list response",
                                        "value":{
                                            "items":[
                                                {
                                                    "name":"file1.txt",
                                                    "size":100,
                                                    "md5Hash":"abc123",
                                                    "timeCreated":"2023-10-24T12:00:00Z",
                                                    "updated":"2023-10-24T12:00:00Z"
                                                }
                                            ],
                                            "prefixes":[
                                                "folder/"
                                            ],
                                            "nextPageToken":"token123"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401":{
                        "description":"Authentication Failure"
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-oci-objs-{project_id}-listallobj-b-{bucket}-get",
                "x-filename-id":"_-baas-services-oci-objs-project_id-listallobj-b-bucket-get"
            }
        },
        "/_/baas-services/oci-objs/{project_id}/genpreauth":{
            "post":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase ObjectStore - OCI"
                ],
                "security":[
                    {
                        "bearerAuth":[
                        ],
                        "AppKey":[
                        ]
                    },
                    {
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Generate PreAuthenticated Request URLs for download/upload",
                "description":"Generates pre-authenticated URL for upload or download in OCI. Includes expiration time. Returns PAR details.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    }
                ],
                "requestBody":{
                    "content":{
                        "application/json":{
                            "schema":{
                                "type":"object",
                                "properties":{
                                    "path":{
                                        "$ref":"#/components/schemas/ObjectPath"
                                    },
                                    "bucket":{
                                        "$ref":"#/components/schemas/StorageBucket"
                                    },
                                    "access_type":{
                                        "type":"string",
                                        "enum":[
                                            "ObjectWrite",
                                            "ObjectRead"
                                        ]
                                    },
                                    "metadata":{
                                        "type":"object",
                                        "properties":{
                                            "contentType":{
                                                "type":"string",
                                                "example":"image/png"
                                            }
                                        },
                                        "additionalProperties":true
                                    },
                                    "timeExpires":{
                                        "type":"string",
                                        "description":"The Time after which the request will become unauthorized. The date-time must be in RFC3339 format.",
                                        "format":"date-time"
                                    }
                                },
                                "required":[
                                    "path",
                                    "bucket",
                                    "access_type"
                                ],
                                "additionalProperties":false
                            }
                        }
                    }
                },
                "responses":{
                    "200":{
                        "description":"Created the PreAuthenticated Request(PAR) URL successfully",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "oneOf":[
                                        {
                                            "type":"object",
                                            "properties":{
                                                "PAR_ID":{
                                                    "$ref":"#/components/schemas/GUID"
                                                },
                                                "URL":{
                                                    "type":"string"
                                                }
                                            }
                                        },
                                        {
                                            "type":"object",
                                            "properties":{
                                                "accessUri":{
                                                    "type":"string"
                                                },
                                                "bucket":{
                                                    "$ref":"#/components/schemas/StorageBucket"
                                                },
                                                "object":{
                                                    "$ref":"#/components/schemas/ObjectPath"
                                                },
                                                "uploadId":{
                                                    "$ref":"#/components/schemas/GUID"
                                                },
                                                "timeCreated":{
                                                    "type":"string",
                                                    "format":"date-time",
                                                    "maxLength":30
                                                }
                                            }
                                        }
                                    ]
                                },
                                "examples":{
                                    "readPAR":{
                                        "summary":"PAR for read",
                                        "value":{
                                            "PAR_ID":"12345678-1234-1234-1234-123456789abc",
                                            "URL":"https://objectstorage.region.oraclecloud.com/p/.../n/.../b/bucket/o/object"
                                        }
                                    },
                                    "writePAR":{
                                        "summary":"PAR for write",
                                        "value":{
                                            "accessUri":"https://objectstorage.region.oraclecloud.com/p/...",
                                            "bucket":"bucket",
                                            "object":"object.txt",
                                            "uploadId":"87654321-4321-4321-4321-87654321cba9",
                                            "timeCreated":"2023-10-24T12:00:00Z"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "401":{
                        "description":"Authentication Failure"
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-oci-objs-{project_id}-genpreauth-post",
                "x-filename-id":"_-baas-services-oci-objs-project_id-genpreauth-post"
            }
        },
        "/_/baas-services/idm/onprem/{project_id}/useradd":{
            "post":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase Authentication - OnPrem"
                ],
                "security":[
                    {
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Create app user for fusabase project",
                "description":"Creates a new app user for the fusabase project with the provided first name, last name, email, and password. Returns an access token upon success.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    }
                ],
                "requestBody":{
                    "content":{
                        "application/json":{
                            "schema":{
                                "type":"object",
                                "properties":{
                                    "first_name":{
                                        "type":"string",
                                        "maxLength":32
                                    },
                                    "last_name":{
                                        "type":"string",
                                        "maxLength":32
                                    },
                                    "email":{
                                        "type":"string",
                                        "format":"email"
                                    },
                                    "password":{
                                        "type":"string",
                                        "minLength":6,
                                        "maxLength":15
                                    }
                                },
                                "required":[
                                    "last_name",
                                    "email",
                                    "password"
                                ],
                                "additionalProperties":false
                            },
                            "examples":{
                                "userCreation":{
                                    "summary":"Create new user",
                                    "value":{
                                        "first_name":"John",
                                        "last_name":"Doe",
                                        "email":"john.doe@example.com",
                                        "password":"securepass"
                                    }
                                }
                            }
                        }
                    }
                },
                "responses":{
                    "200":{
                        "description":"Returns access_token for successfully created user.",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/OnPremAuthSuccess"
                                }
                            }
                        }
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-idm-onprem-{project_id}-useradd-post",
                "x-filename-id":"_-baas-services-idm-onprem-project_id-useradd-post"
            }
        },
        "/_/baas-services/idm/onprem/{project_id}/authenticate":{
            "post":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase Authentication - OnPrem"
                ],
                "security":[
                    {
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Authenticates app user for fusabase project",
                "description":"Authenticates an app user using email and password or refreshes a token. Returns access token, refresh token, etc.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    }
                ],
                "requestBody":{
                    "content":{
                        "application/json":{
                            "schema":{
                                "oneOf":[
                                    {
                                        "type":"object",
                                        "properties":{
                                            "grant_type":{
                                                "type":"string",
                                                "default":"user_credentials"
                                            },
                                            "username":{
                                                "type":"string",
                                                "format":"email"
                                            },
                                            "password":{
                                                "type":"string",
                                                "minLength":6,
                                                "maxLength":15
                                            }
                                        },
                                        "additionalProperties":false,
                                        "required":[
                                            "grant_type",
                                            "username",
                                            "password"
                                        ]
                                    },
                                    {
                                        "type":"object",
                                        "properties":{
                                            "grant_type":{
                                                "type":"string",
                                                "default":"refresh_token"
                                            },
                                            "refresh_token":{
                                                "type":"string"
                                            }
                                        },
                                        "additionalProperties":false,
                                        "required":[
                                            "grant_type",
                                            "refresh_token"
                                        ]
                                    }
                                ]
                            },
                            "examples":{
                                "userCredentials":{
                                    "summary":"Authenticate with credentials",
                                    "value":{
                                        "grant_type":"user_credentials",
                                        "username":"john.doe@example.com",
                                        "password":"securepass"
                                    }
                                },
                                "refreshToken":{
                                    "summary":"Refresh token",
                                    "value":{
                                        "grant_type":"refresh_token",
                                        "refresh_token":"refresh_token_string"
                                    }
                                }
                            }
                        }
                    }
                },
                "responses":{
                    "200":{
                        "description":"Returns access_token for successfully authenticated user.",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/OnPremAuthSuccess"
                                }
                            }
                        }
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-idm-onprem-{project_id}-authenticate-post",
                "x-filename-id":"_-baas-services-idm-onprem-project_id-authenticate-post"
            }
        },
        "/_/baas-services/idm/signingKey/{project_id}/jwk":{
            "get":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase Authentication - OnPrem"
                ],
                "summary":"Get The Signing JWK for Token verification",
                "description":"Retrieves the signing JWK for verifying fusabase minted tokens.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Returns access_token for successfully authenticated user.",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "type":"object",
                                    "properties":{
                                        "n":{
                                            "type":"string"
                                        },
                                        "e":{
                                            "type":"string"
                                        },
                                        "kty":{
                                            "type":"string",
                                            "enum":[
                                                "RSA"
                                            ]
                                        },
                                        "alg":{
                                            "type":"string",
                                            "enum":[
                                                "RS256"
                                            ]
                                        },
                                        "kid":{
                                            "type":"string",
                                            "default":"SIGNING_KEY"
                                        }
                                    },
                                    "required":[
                                        "n",
                                        "e",
                                        "kty",
                                        "alg",
                                        "kid"
                                    ]
                                },
                                "examples":{
                                    "jwkExample":{
                                        "summary":"Example JWK",
                                        "value":{
                                            "n":"base64encodedn",
                                            "e":"AQAB",
                                            "kty":"RSA",
                                            "alg":"RS256",
                                            "kid":"SIGNING_KEY"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-idm-signingKey-{project_id}-jwk-get",
                "x-filename-id":"_-baas-services-idm-signingkey-project_id-jwk-get"
            }
        },
        "/_/baas-services/idm/onprem/{project_id}/authorizeSnapshot":{
            "get":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase Authentication - OnPrem"
                ],
                "security":[
                    {
                        "bearerAuth":[
                        ],
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Get an authorized token for fusabase snapshot",
                "description":"Mints an access token with scope 'baas-snapshot' for the authenticated user.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Returns access_token for successfully authenticated user.",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/OnPremAuthSuccess"
                                }
                            }
                        }
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-idm-onprem-{project_id}-authorizeSnapshot-get",
                "x-filename-id":"_-baas-services-idm-onprem-project_id-authorizesnapshot-get"
            }
        },
        "/_/baas-services/idm/onprem/{project_id}/rf/revoke":{
            "put":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase Authentication - OnPrem"
                ],
                "security":[
                    {
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Revoke refresh token from re-authenticating",
                "description":"Revokes a refresh token, preventing further use for authentication.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    }
                ],
                "requestBody":{
                    "content":{
                        "application/json":{
                            "schema":{
                                "type":"object",
                                "properties":{
                                    "token":{
                                        "type":"string"
                                    }
                                },
                                "required":[
                                    "token"
                                ],
                                "additionalProperties":false
                            },
                            "examples":{
                                "revokeToken":{
                                    "summary":"Revoke refresh token",
                                    "value":{
                                        "token":"refresh_token_string"
                                    }
                                }
                            }
                        }
                    }
                },
                "responses":{
                    "200":{
                        "description":"Successfully revoked Refresh Token",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "type":"object",
                                    "properties":{
                                        "success":{
                                            "type":"integer",
                                            "default":1
                                        }
                                    },
                                    "required":[
                                        "success"
                                    ],
                                    "additionalProperties":false
                                }
                            }
                        }
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-idm-onprem-{project_id}-rf-revoke-put",
                "x-filename-id":"_-baas-services-idm-onprem-project_id-rf-revoke-put"
            }
        },
        "/_/baas-services/idm/onprem/{project_id}/srp/getsharedkey":{
            "get":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase Authentication - OnPrem"
                ],
                "security":[
                    {
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Get Shared Key for the User (SRP Protocol)",
                "description":"Fetches shared keys (N, G, K) for SRP authentication for the given email.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    },
                    {
                        "name":"email",
                        "in":"query",
                        "description":"The Email to initiate authentication process for.",
                        "required":true,
                        "schema":{
                            "type":"string",
                            "format":"email"
                        }
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Successfully fetched the Shared Keys",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "type":"object",
                                    "properties":{
                                        "N":{
                                            "type":"string"
                                        },
                                        "G":{
                                            "type":"string"
                                        },
                                        "K":{
                                            "type":"string"
                                        }
                                    },
                                    "required":[
                                        "N",
                                        "G",
                                        "K"
                                    ],
                                    "additionalProperties":false
                                },
                                "examples":{
                                    "sharedKey":{
                                        "summary":"Example shared keys",
                                        "value":{
                                            "N":"large_prime",
                                            "G":"generator",
                                            "K":"key"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-idm-onprem-{project_id}-srp-getsharedkey-get",
                "x-filename-id":"_-baas-services-idm-onprem-project_id-srp-getsharedkey-get"
            }
        },
        "/_/baas-services/idm/onprem/{project_id}/srp/authenticate":{
            "post":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase Authentication - OnPrem"
                ],
                "security":[
                    {
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Perform various steps for SRP Authentication",
                "description":"Performs SRP authentication steps: key exchange or session match.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    },
                    {
                        "$ref":"#/components/parameters/srpRequestType"
                    }
                ],
                "requestBody":{
                    "content":{
                        "application/json":{
                            "schema":{
                                "oneOf":[
                                    {
                                        "type":"object",
                                        "description":"When reqtype is key_exchange",
                                        "properties":{
                                            "email":{
                                                "type":"string",
                                                "format":"email"
                                            },
                                            "A":{
                                                "type":"string"
                                            }
                                        },
                                        "required":[
                                            "email",
                                            "A"
                                        ],
                                        "additionalProperties":false
                                    },
                                    {
                                        "type":"object",
                                        "description":"When reqtype is session_match",
                                        "properties":{
                                            "email":{
                                                "type":"string",
                                                "format":"email"
                                            },
                                            "shared_key":{
                                                "type":"string"
                                            }
                                        },
                                        "required":[
                                            "email",
                                            "shared_key"
                                        ],
                                        "additionalProperties":false
                                    }
                                ]
                            },
                            "examples":{
                                "keyExchange":{
                                    "summary":"Key exchange",
                                    "value":{
                                        "email":"user@example.com",
                                        "A":"public_value_A"
                                    }
                                },
                                "sessionMatch":{
                                    "summary":"Session match",
                                    "value":{
                                        "email":"user@example.com",
                                        "shared_key":"session_key"
                                    }
                                }
                            }
                        }
                    }
                },
                "responses":{
                    "200":{
                        "description":"Successfully performed the authentication step",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "oneOf":[
                                        {
                                            "type":"object",
                                            "description":"When reqtype is key_exchange",
                                            "properties":{
                                                "N":{
                                                    "type":"string"
                                                },
                                                "G":{
                                                    "type":"string"
                                                },
                                                "K":{
                                                    "type":"string"
                                                },
                                                "V":{
                                                    "type":"string"
                                                },
                                                "salt":{
                                                    "type":"string"
                                                },
                                                "B":{
                                                    "type":"string"
                                                }
                                            },
                                            "required":[
                                                "N",
                                                "G",
                                                "K",
                                                "V",
                                                "salt",
                                                "B"
                                            ],
                                            "additionalProperties":false
                                        },
                                        {
                                            "$ref":"#/components/schemas/OnPremAuthSuccess"
                                        }
                                    ]
                                },
                                "examples":{
                                    "keyExchangeResponse":{
                                        "summary":"Key exchange response",
                                        "value":{
                                            "N":"large_prime",
                                            "G":"generator",
                                            "K":"key",
                                            "V":"verifier",
                                            "salt":"salt_value",
                                            "B":"public_value_B"
                                        }
                                    },
                                    "sessionMatchResponse":{
                                        "summary":"Session match response",
                                        "value":{
                                            "access_token":"token",
                                            "expires_in":3600,
                                            "token_type":"Bearer",
                                            "refresh_token":"refresh"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-idm-onprem-{project_id}-srp-authenticate-post",
                "x-filename-id":"_-baas-services-idm-onprem-project_id-srp-authenticate-post"
            }
        },
        "/_/baas-services/idm/onprem/{project_id}/srp/useradd":{
            "post":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase Authentication - OnPrem"
                ],
                "security":[
                    {
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Register a new User with SRP Protocol",
                "description":"Registers a new user using SRP protocol with provided parameters.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    }
                ],
                "requestBody":{
                    "content":{
                        "application/json":{
                            "schema":{
                                "type":"object",
                                "properties":{
                                    "n":{
                                        "type":"string"
                                    },
                                    "g":{
                                        "type":"string"
                                    },
                                    "k":{
                                        "type":"string"
                                    },
                                    "v":{
                                        "type":"string"
                                    },
                                    "s":{
                                        "type":"string"
                                    },
                                    "email":{
                                        "type":"string",
                                        "format":"email"
                                    },
                                    "first_name":{
                                        "type":"string",
                                        "maxLength":128
                                    },
                                    "last_name":{
                                        "type":"string",
                                        "maxLength":128
                                    }
                                },
                                "required":[
                                    "email",
                                    "n",
                                    "g",
                                    "k",
                                    "v",
                                    "s",
                                    "last_name"
                                ],
                                "additionalProperties":false
                            }
                        }
                    }
                },
                "responses":{
                    "200":{
                        "description":"Successfully registered the new user",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/OnPremAuthSuccess"
                                }
                            }
                        }
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-idm-onprem-{project_id}-srp-useradd-post",
                "x-filename-id":"_-baas-services-idm-onprem-project_id-srp-useradd-post"
            }
        },
        "/_/baas-services/idm/onprem/{project_id}/srp/updatepassword":{
            "post":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase Authentication - OnPrem"
                ],
                "security":[
                    {
                        "onPremAuthToken":[
                        ],
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Register a new User with SRP Protocol",
                "description":"Updates the password for the authenticated user using SRP protocol, involving key exchange and session match steps.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    },
                    {
                        "$ref":"#/components/parameters/srpRequestType"
                    }
                ],
                "requestBody":{
                    "content":{
                        "application/json":{
                            "schema":{
                                "oneOf":[
                                    {
                                        "type":"object",
                                        "description":"When reqtype is key_exchange",
                                        "properties":{
                                            "email":{
                                                "type":"string",
                                                "format":"email"
                                            },
                                            "A":{
                                                "type":"string"
                                            }
                                        },
                                        "required":[
                                            "email",
                                            "A"
                                        ],
                                        "additionalProperties":false
                                    },
                                    {
                                        "type":"object",
                                        "description":"When reqtype is session_match",
                                        "properties":{
                                            "v":{
                                                "type":"string"
                                            },
                                            "salt":{
                                                "type":"string"
                                            },
                                            "email":{
                                                "type":"string",
                                                "format":"email"
                                            },
                                            "shared_key":{
                                                "type":"string"
                                            }
                                        },
                                        "required":[
                                            "email",
                                            "v",
                                            "salt",
                                            "shared_key"
                                        ],
                                        "additionalProperties":false
                                    }
                                ]
                            },
                            "examples":{
                                "keyExchange":{
                                    "summary":"Key exchange for password update",
                                    "value":{
                                        "email":"user@example.com",
                                        "A":"public_value_A"
                                    }
                                },
                                "sessionMatch":{
                                    "summary":"Session match with new verifier",
                                    "value":{
                                        "v":"new_verifier",
                                        "salt":"new_salt",
                                        "email":"user@example.com",
                                        "shared_key":"session_key"
                                    }
                                }
                            }
                        }
                    }
                },
                "responses":{
                    "200":{
                        "description":"Successfully registered the new user",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "oneOf":[
                                        {
                                            "type":"object",
                                            "description":"When reqtype is key_exchange",
                                            "properties":{
                                                "N":{
                                                    "type":"string"
                                                },
                                                "G":{
                                                    "type":"string"
                                                },
                                                "K":{
                                                    "type":"string"
                                                },
                                                "V":{
                                                    "type":"string"
                                                },
                                                "salt":{
                                                    "type":"string"
                                                },
                                                "B":{
                                                    "type":"string"
                                                }
                                            },
                                            "required":[
                                                "N",
                                                "G",
                                                "K",
                                                "V",
                                                "salt",
                                                "B"
                                            ],
                                            "additionalProperties":false
                                        },
                                        {
                                            "type":"object",
                                            "description":"When reqtype is session_match",
                                            "properties":{
                                                "success":{
                                                    "type":"number",
                                                    "enum":[
                                                        1
                                                    ]
                                                }
                                            },
                                            "additionalProperties":false
                                        }
                                    ]
                                },
                                "examples":{
                                    "keyExchangeResponse":{
                                        "summary":"Key exchange response",
                                        "value":{
                                            "N":"large_prime",
                                            "G":"generator",
                                            "K":"key",
                                            "V":"verifier",
                                            "salt":"salt_value",
                                            "B":"public_value_B"
                                        }
                                    },
                                    "sessionMatchResponse":{
                                        "summary":"Successful password update",
                                        "value":{
                                            "success":1
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-idm-onprem-{project_id}-srp-updatepassword-post",
                "x-filename-id":"_-baas-services-idm-onprem-project_id-srp-updatepassword-post"
            }
        },
        "/_/baas-services/idm/onprem/{project_id}/srp/resetpwd":{
            "post":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase Authentication - OnPrem"
                ],
                "security":[
                    {
                        "onPremAuthToken":[
                        ],
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Register a new User with SRP Protocol",
                "description":"Resets the password using SRP protocol with the provided code, verifier, and salt.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    },
                    {
                        "$ref":"#/components/parameters/srpRequestType"
                    }
                ],
                "requestBody":{
                    "content":{
                        "application/json":{
                            "schema":{
                                "type":"object",
                                "description":"When reqtype is key_exchange",
                                "properties":{
                                    "email":{
                                        "type":"string",
                                        "format":"email"
                                    },
                                    "code":{
                                        "type":"string"
                                    },
                                    "V":{
                                        "type":"string"
                                    },
                                    "salt":{
                                        "type":"string"
                                    }
                                },
                                "required":[
                                    "email",
                                    "code",
                                    "V",
                                    "salt"
                                ],
                                "additionalProperties":false
                            },
                            "examples":{
                                "resetPassword":{
                                    "summary":"Reset password with SRP",
                                    "value":{
                                        "email":"user@example.com",
                                        "code":"reset_code",
                                        "V":"verifier",
                                        "salt":"salt_value"
                                    }
                                }
                            }
                        }
                    }
                },
                "responses":{
                    "200":{
                        "description":"Successfully registered the new user",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "oneOf":[
                                        {
                                            "type":"object",
                                            "description":"When reqtype is key_exchange",
                                            "properties":{
                                                "N":{
                                                    "type":"string"
                                                },
                                                "G":{
                                                    "type":"string"
                                                },
                                                "K":{
                                                    "type":"string"
                                                },
                                                "V":{
                                                    "type":"string"
                                                },
                                                "salt":{
                                                    "type":"string"
                                                },
                                                "B":{
                                                    "type":"string"
                                                }
                                            },
                                            "required":[
                                                "N",
                                                "G",
                                                "K",
                                                "V",
                                                "salt",
                                                "B"
                                            ],
                                            "additionalProperties":false
                                        },
                                        {
                                            "type":"object",
                                            "description":"When reqtype is session_match",
                                            "properties":{
                                                "success":{
                                                    "type":"number",
                                                    "enum":[
                                                        1
                                                    ]
                                                }
                                            },
                                            "additionalProperties":false
                                        }
                                    ]
                                },
                                "examples":{
                                    "keyExchangeResponse":{
                                        "summary":"Key exchange for reset",
                                        "value":{
                                            "N":"large_prime",
                                            "G":"generator",
                                            "K":"key",
                                            "V":"verifier",
                                            "salt":"salt_value",
                                            "B":"public_value_B"
                                        }
                                    },
                                    "sessionMatchResponse":{
                                        "summary":"Successful reset",
                                        "value":{
                                            "success":1
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-idm-onprem-{project_id}-srp-resetpwd-post",
                "x-filename-id":"_-baas-services-idm-onprem-project_id-srp-resetpwd-post"
            }
        },
        "/_/baas-services/idm/onprem/{project_id}/changePassword":{
            "put":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase Authentication - OnPrem"
                ],
                "security":[
                    {
                        "onPremAuthToken":[
                        ],
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Change password for the authenticated User.",
                "description":"Changes the password for the authenticated user by providing old and new passwords.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    }
                ],
                "requestBody":{
                    "content":{
                        "application/json":{
                            "schema":{
                                "type":"object",
                                "properties":{
                                    "oldPassword":{
                                        "type":"string",
                                        "minLength":6,
                                        "maxLength":15
                                    },
                                    "password":{
                                        "type":"string",
                                        "minLength":6,
                                        "maxLength":15
                                    }
                                },
                                "required":[
                                    "oldPassword",
                                    "password"
                                ],
                                "additionalProperties":false
                            },
                            "examples":{
                                "changePassword":{
                                    "summary":"Change password",
                                    "value":{
                                        "oldPassword":"oldpass",
                                        "password":"newsecurepass"
                                    }
                                }
                            }
                        }
                    }
                },
                "responses":{
                    "200":{
                        "description":"Successfully changed the Password",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "type":"object",
                                    "properties":{
                                        "success":{
                                            "type":"integer",
                                            "default":1
                                        }
                                    },
                                    "required":[
                                        "success"
                                    ],
                                    "additionalProperties":false
                                }
                            }
                        }
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-idm-onprem-{project_id}-changePassword-put",
                "x-filename-id":"_-baas-services-idm-onprem-project_id-changepassword-put"
            }
        },
        "/_/baas-services/idm/onprem/{project_id}/updateProfile":{
            "put":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase Authentication - OnPrem"
                ],
                "security":[
                    {
                        "onPremAuthToken":[
                        ],
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Change profile details for the authenticated User.",
                "description":"Updates profile details like displayName or phoneNumber for the authenticated user using operations.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    }
                ],
                "requestBody":{
                    "content":{
                        "application/json":{
                            "schema":{
                                "type":"object",
                                "properties":{
                                    "Operations":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "op":{
                                                    "type":"string",
                                                    "enum":[
                                                        "add",
                                                        "replace"
                                                    ]
                                                },
                                                "path":{
                                                    "type":"string",
                                                    "enum":[
                                                        "displayName",
                                                        "phoneNumber"
                                                    ]
                                                },
                                                "value":{
                                                    "type":"string",
                                                    "description":"Valid Phone number or a DisplayName, based on path"
                                                }
                                            },
                                            "required":[
                                                "op",
                                                "path",
                                                "value"
                                            ],
                                            "additionalProperties":false
                                        },
                                        "minItems":1,
                                        "maxItems":2
                                    }
                                },
                                "required":[
                                    "Operations"
                                ],
                                "additionalProperties":false
                            },
                            "examples":{
                                "updateProfile":{
                                    "summary":"Update display name and phone",
                                    "value":{
                                        "Operations":[
                                            {
                                                "op":"replace",
                                                "path":"displayName",
                                                "value":"John Doe"
                                            },
                                            {
                                                "op":"add",
                                                "path":"phoneNumber",
                                                "value":"+1234567890"
                                            }
                                        ]
                                    }
                                }
                            }
                        }
                    }
                },
                "responses":{
                    "200":{
                        "description":"Successfully updated User Profile",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "type":"object",
                                    "properties":{
                                        "success":{
                                            "type":"integer",
                                            "default":1
                                        }
                                    },
                                    "required":[
                                        "success"
                                    ],
                                    "additionalProperties":false
                                }
                            }
                        }
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-idm-onprem-{project_id}-updateProfile-put",
                "x-filename-id":"_-baas-services-idm-onprem-project_id-updateprofile-put"
            }
        },
        "/_/baas-services/idm/onprem/{project_id}/resetpwd":{
            "post":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase Authentication - OnPrem"
                ],
                "summary":"Reset the password for a user.",
                "description":"Resets the password for a user using the provided code and new password.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    }
                ],
                "requestBody":{
                    "content":{
                        "application/json":{
                            "schema":{
                                "type":"object",
                                "properties":{
                                    "code":{
                                        "$ref":"#/components/schemas/GUID"
                                    },
                                    "password":{
                                        "type":"string",
                                        "minLength":6,
                                        "maxLength":15
                                    }
                                },
                                "required":[
                                    "code",
                                    "password"
                                ],
                                "additionalProperties":false
                            },
                            "examples":{
                                "resetPassword":{
                                    "summary":"Reset password",
                                    "value":{
                                        "code":"reset_code",
                                        "password":"newpass"
                                    }
                                }
                            }
                        }
                    }
                },
                "responses":{
                    "200":{
                        "description":"Changed the password for the user successfully.",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "type":"object",
                                    "properties":{
                                        "success":{
                                            "type":"boolean",
                                            "default":true
                                        }
                                    },
                                    "required":[
                                        "success"
                                    ],
                                    "additionalProperties":false
                                }
                            }
                        }
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-idm-onprem-{project_id}-resetpwd-post",
                "x-filename-id":"_-baas-services-idm-onprem-project_id-resetpwd-post"
            },
            "get":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase Authentication - OnPrem"
                ],
                "summary":"Get the HTML form to reset the password for a user.",
                "description":"Provides an HTML form to reset the password using the provided code.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/actionCode"
                    },
                    {
                        "$ref":"#/components/parameters/projectId"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Returns a HTML form to type in the newPassword to reset to.",
                        "content":{
                            "text/html":{
                            }
                        }
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-idm-onprem-{project_id}-resetpwd-get",
                "x-filename-id":"_-baas-services-idm-onprem-project_id-resetpwd-get"
            }
        },
        "/_/baas-services/idm/onprem/{project_id}/sendemail":{
            "get":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase Authentication - OnPrem"
                ],
                "summary":"Sends an email to the user for resetting password.",
                "description":"Sends an email for email verification or password reset.",
                "parameters":[
                    {
                        "name":"email",
                        "in":"query",
                        "description":"The User's email address to send the link to.",
                        "required":true,
                        "schema":{
                            "type":"string",
                            "format":"email"
                        }
                    },
                    {
                        "$ref":"#/components/parameters/actionCodeRequestType"
                    },
                    {
                        "$ref":"#/components/parameters/projectId"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Successfully sent the email."
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-idm-onprem-{project_id}-sendemail-get",
                "x-filename-id":"_-baas-services-idm-onprem-project_id-sendemail-get"
            }
        },
        "/_/baas-services/idm/onprem/{project_id}/verifycode":{
            "get":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase Authentication - OnPrem"
                ],
                "summary":"Checks if the code is correct or not",
                "description":"Verifies the code for email verification or other actions.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/actionCode"
                    },
                    {
                        "$ref":"#/components/parameters/actionCodeRequestType"
                    },
                    {
                        "$ref":"#/components/parameters/projectId"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Successfully verified the code.",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "type":"object",
                                    "properties":{
                                        "username":{
                                            "type":"string",
                                            "format":"email"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-idm-onprem-{project_id}-verifycode-get",
                "x-filename-id":"_-baas-services-idm-onprem-project_id-verifycode-get"
            }
        },
        "/_/baas-services/idm/onprem/{project_id}/socialidp":{
            "get":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase Social Authentication - OnPrem"
                ],
                "security":[
                    {
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Start the social login flow for a Social Id Provider",
                "description":"Initiates social login flow for providers like Google, Facebook, GitHub.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    },
                    {
                        "$ref":"#/components/parameters/socialmethod"
                    },
                    {
                        "name":"device",
                        "in":"query",
                        "description":"The device platform, requesting for Social Login",
                        "required":true,
                        "schema":{
                            "type":"string",
                            "enum":[
                                "web",
                                "mobile"
                            ]
                        }
                    },
                    {
                        "name":"context_uri",
                        "in":"query",
                        "description":"The application uri to redirect to, when using signInWithRedirect flow.",
                        "schema":{
                            "type":"string"
                        }
                    },
                    {
                        "name":"code_challenge",
                        "in":"query",
                        "description":"The code_challenge passed for PKCE. To be used with signInWithRedirect flow only",
                        "schema":{
                            "type":"string"
                        }
                    },
                    {
                        "name":"code_challenge_method",
                        "in":"query",
                        "description":"The encryption method used for code challenge method. To be used with signInWithRedirect flow only",
                        "schema":{
                            "type":"string",
                            "default":"S256"
                        }
                    },
                    {
                        "name":"link",
                        "in":"query",
                        "description":"Start Linking Social account flow",
                        "schema":{
                            "type":"number",
                            "enum":[
                                0,
                                1
                            ]
                        }
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Returns SAML Form for submission",
                        "content":{
                            "text/html":{
                            }
                        }
                    },
                    "302":{
                        "description":"Redirects to Google/Facebook/Github/OIDC providers"
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-idm-onprem-{project_id}-socialidp-get",
                "x-filename-id":"_-baas-services-idm-onprem-project_id-socialidp-get"
            }
        },
        "/_/baas-services/idm/onprem/{project_id}/getcredential":{
            "post":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase Social Authentication - OnPrem"
                ],
                "security":[
                    {
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Exchange social provider id token with fusabase tokens",
                "description":"Exchanges social provider ID token for fusabase tokens.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    },
                    {
                        "$ref":"#/components/parameters/socialmethod"
                    }
                ],
                "requestBody":{
                    "content":{
                        "application/json":{
                            "schema":{
                                "type":"object",
                                "properties":{
                                    "token":{
                                        "type":"string",
                                        "maxLength":256
                                    }
                                },
                                "required":[
                                    "token"
                                ],
                                "additionalProperties":false
                            },
                            "examples":{
                                "exchangeToken":{
                                    "summary":"Exchange ID token",
                                    "value":{
                                        "token":"social_id_token"
                                    }
                                }
                            }
                        }
                    }
                },
                "responses":{
                    "200":{
                        "description":"Returns access_token for successfully created user.",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/OnPremAuthSuccess"
                                }
                            }
                        }
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-idm-onprem-{project_id}-getcredential-post",
                "x-filename-id":"_-baas-services-idm-onprem-project_id-getcredential-post"
            }
        },
        "/_/baas-services/idm/onprem/{project_id}/callback":{
            "get":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase Social Authentication - OnPrem"
                ],
                "summary":"Gets back the Authorization code from the social provider.",
                "description":"Callback endpoint for social login to receive authorization code and authenticate.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    },
                    {
                        "name":"code",
                        "in":"query",
                        "description":"The code sent by the Social Provider",
                        "required":true,
                        "schema":{
                            "type":"string"
                        }
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Redirects to the Mobile App, or Returns a SignIn Success page with the Onprem AccessToken. Response will be based on the device used during Social Login Initiation.",
                        "content":{
                            "text/html":{
                                "schema":{
                                    "description":"In case of a WebApp using SignIn/Link with Popup, Original IdToken or Fusabase Token is returned from the popup."
                                }
                            },
                            "application/json":{
                                "schema":{
                                    "description":"In case of SignIn/Link With Redirect or a Mobile Device, Authorization code is returned to the calling application. To complete the PKCE flow, this code is sent with the code verifier to another endpoint from the calling device."
                                }
                            }
                        }
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-idm-onprem-{project_id}-callback-get",
                "x-filename-id":"_-baas-services-idm-onprem-project_id-callback-get"
            },
            "post":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase Social Authentication - OnPrem"
                ],
                "summary":"Gets back the SAML Response from the SAML provider.",
                "description":"Callback for SAML response in social login.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    }
                ],
                "requestBody":{
                    "content":{
                        "application/x-www-form-urlencoded":{
                            "schema":{
                                "type":"object",
                                "properties":{
                                    "SAMLResponse":{
                                        "type":"string"
                                    },
                                    "RelayState":{
                                        "type":"string"
                                    }
                                }
                            }
                        }
                    }
                },
                "responses":{
                    "200":{
                        "description":"Redirects to the Mobile App, or Returns a SignIn Success page with the Onprem AccessToken. Response will be based on the device used during Social Login Initiation.",
                        "content":{
                            "text/html":{
                                "schema":{
                                    "description":"In case of a WebApp using SignIn/Link with Popup, Original IdToken or fusabase Token is returned from the popup."
                                }
                            },
                            "application/json":{
                                "schema":{
                                    "description":"In case of SignIn/Link With Redirect or a Mobile Device, Authorization code is returned to the calling application. To complete the PKCE flow, this code is sent with the code verifier to another endpoint from the calling device."
                                }
                            }
                        }
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-idm-onprem-{project_id}-callback-post",
                "x-filename-id":"_-baas-services-idm-onprem-project_id-callback-post"
            }
        },
        "/_/baas-services/idm/onprem/{project_id}/redirectResult":{
            "post":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase Social Authentication - OnPrem"
                ],
                "summary":"Gets the fusabase access token for SignInWithRedirect Flow",
                "description":"Exchanges authorization code for fusabase access token in redirect flow.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    }
                ],
                "requestBody":{
                    "content":{
                        "application/json":{
                            "schema":{
                                "type":"object",
                                "properties":{
                                    "code":{
                                        "type":"string",
                                        "description":"The authorization code to get the access token using SignInWithRedirect flow"
                                    },
                                    "code_verifier":{
                                        "type":"string",
                                        "description":"The code_verifier for the corresponding code_challenge in OAuth PKCE flow"
                                    }
                                }
                            },
                            "examples":{
                                "redirectResult":{
                                    "summary":"Get token from code",
                                    "value":{
                                        "code":"auth_code",
                                        "code_verifier":"verifier"
                                    }
                                }
                            }
                        }
                    }
                },
                "responses":{
                    "200":{
                        "description":"Returns access_token for successfully authenticated user.",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "oneOf":[
                                        {
                                            "$ref":"#/components/schemas/OnPremAuthSuccess"
                                        },
                                        {
                                            "type":"object",
                                            "description":"In case of Social Account Linking",
                                            "properties":{
                                                "id_token":{
                                                    "type":"string",
                                                    "description":"The original token from the social provider"
                                                }
                                            }
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-idm-onprem-{project_id}-redirectResult-post",
                "x-filename-id":"_-baas-services-idm-onprem-project_id-redirectresult-post"
            }
        },
        "/_/baas-services/idm/idcs/{project_id}/tokenExchange":{
            "post":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase Social Authentication - IDCS"
                ],
                "security":[
                    {
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Gets back the fusabase-native token using the ORACLE IDCS Token.",
                "description":"The REST API returns the fusabase resource server token with scope (baas-database baas-storage) when the Authentication Service provider is Oracle IDCS",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    }
                ],
                "requestBody":{
                    "content":{
                        "application/json":{
                            "schema":{
                                "type":"object",
                                "properties":{
                                    "token":{
                                        "type":"string",
                                        "maxLength":4000
                                    }
                                },
                                "required":[
                                    "token"
                                ],
                                "additionalProperties":false
                            },
                            "examples":{
                                "exchangeToken":{
                                    "summary":"Exchange IDCS access token",
                                    "value":{
                                        "token":"idcs_access_token"
                                    }
                                }
                            }
                        }
                    }
                },
                "responses":{
                    "200":{
                        "description":"Returns the fusabase-native token in exchange for the Oracle IDCS Token",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "type":"object",
                                    "properties":{
                                        "access_token":{
                                            "type":"string"
                                        },
                                        "expires_in":{
                                            "type":"integer",
                                            "default":3600
                                        },
                                        "token_type":{
                                            "type":"string",
                                            "default":"Bearer"
                                        }
                                    },
                                    "required":[
                                        "access_token",
                                        "expires_in",
                                        "token_type"
                                    ]
                                }
                            }
                        }
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-idm-idcs-{project_id}-tokenExchange-post",
                "x-filename-id":"_-baas-services-idm-idcs-project_id-tokenexchange-post"
            }
        },
        "/_/baas-services/idm/idcs/{project_id}/useradd":{
            "post":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase Authentication - IDCS"
                ],
                "security":[
                    {
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Create IDCS user through ORDS proxy",
                "description":"Creates a new IDCS self-registered user using server-side IDCS configuration.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    }
                ],
                "requestBody":{
                    "content":{
                        "application/json":{
                            "schema":{
                                "type":"object",
                                "properties":{
                                    "first_name":{
                                        "type":"string",
                                        "maxLength":64
                                    },
                                    "last_name":{
                                        "type":"string",
                                        "maxLength":64
                                    },
                                    "email":{
                                        "type":"string",
                                        "format":"email"
                                    },
                                    "password":{
                                        "type":"string",
                                        "minLength":6
                                    }
                                },
                                "required":[
                                    "email",
                                    "password"
                                ],
                                "additionalProperties":false
                            },
                            "examples":{
                                "idcsUserCreation":{
                                    "summary":"Create IDCS user",
                                    "value":{
                                        "first_name":"John",
                                        "last_name":"Doe",
                                        "email":"john.doe@example.com",
                                        "password":"securepass"
                                    }
                                }
                            }
                        }
                    }
                },
                "responses":{
                    "200":{
                        "description":"Returns success response for successfully registered user.",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "type":"object",
                                    "properties":{
                                        "message":{
                                            "type":"string",
                                            "default":"User Registered"
                                        }
                                    },
                                    "required":[
                                        "message"
                                    ],
                                    "additionalProperties":false
                                }
                            }
                        }
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-idm-idcs-{project_id}-useradd-post",
                "x-filename-id":"_-baas-services-idm-idcs-project_id-useradd-post"
            }
        },
        "/_/baas-services/idm/idcs/{project_id}/social":{
            "get":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase Social Authentication - IDCS"
                ],
                "security":[
                    {
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Peform Social Login through IDCS",
                "description":"Initiates the social login process through IDCS for providers like Google, Facebook, GitHub, etc. Redirects to the IDCS authentication page.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    },
                    {
                        "name":"method",
                        "in":"query",
                        "description":"The social provider to use",
                        "required":true,
                        "schema":{
                            "type":"string",
                            "enum":[
                                "google-idcs",
                                "facebook-idcs",
                                "github-idcs",
                                "saml_%",
                                "oidc_%"
                            ]
                        }
                    },
                    {
                        "name":"device",
                        "in":"query",
                        "description":"The device platform, requesting for Social Login",
                        "required":true,
                        "schema":{
                            "type":"string",
                            "enum":[
                                "web",
                                "mobile"
                            ]
                        }
                    },
                    {
                        "name":"context_uri",
                        "in":"query",
                        "description":"The application uri to redirect to, when using signInWithRedirect flow.",
                        "schema":{
                            "type":"string"
                        }
                    },
                    {
                        "name":"code_challenge",
                        "in":"query",
                        "description":"The code_challenge passed for PKCE. To be used with signInWithRedirect flow only",
                        "schema":{
                            "type":"string"
                        }
                    },
                    {
                        "name":"code_challenge_method",
                        "in":"query",
                        "description":"The encryption method used for code challenge method. To be used with signInWithRedirect flow only",
                        "schema":{
                            "type":"string",
                            "default":"S256"
                        }
                    }
                ],
                "responses":{
                    "302":{
                        "description":"Redirects to IDCS Authentication Page"
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-idm-idcs-{project_id}-social-get",
                "x-filename-id":"_-baas-services-idm-idcs-project_id-social-get"
            }
        },
        "/_/baas-services/idm/idcs/{project_id}/callback":{
            "get":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase Social Authentication - IDCS"
                ],
                "summary":"Gets back the Authorization code from the social provider.",
                "description":"Callback to handle the authorization code from IDCS and complete the login process. Redirects or returns success page with access token based on device.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    },
                    {
                        "name":"code",
                        "in":"query",
                        "description":"The code sent by the Social Provider",
                        "required":true,
                        "schema":{
                            "type":"string"
                        }
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Redirects to the Mobile App, or Returns a SignIn Success page with the IDCS AccessToken. Response will be based on the device used during Social Login Initiation.",
                        "content":{
                            "text/html":{
                            }
                        }
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-idm-idcs-{project_id}-callback-get",
                "x-filename-id":"_-baas-services-idm-idcs-project_id-callback-get"
            }
        },
        "/_/baas-services/idm/idcs/{project_id}/redirectResult":{
            "post":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase Social Authentication - IDCS"
                ],
                "summary":"Gets the IDCS access token for SignInWithRedirect Flow",
                "description":"Exchanges the authorization code for an IDCS access token in the SignInWithRedirect flow.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    }
                ],
                "requestBody":{
                    "content":{
                        "application/json":{
                            "schema":{
                                "type":"object",
                                "properties":{
                                    "code":{
                                        "type":"string",
                                        "description":"The authorization code to get the access token using SignInWithRedirect flow"
                                    },
                                    "code_verifier":{
                                        "type":"string",
                                        "description":"The code_verifier for the corresponding code_challenge in OAuth PKCE flow"
                                    }
                                }
                            },
                            "examples":{
                                "exchangeCode":{
                                    "summary":"Exchange code for token",
                                    "value":{
                                        "code":"auth_code",
                                        "code_verifier":"verifier_string"
                                    }
                                }
                            }
                        }
                    }
                },
                "responses":{
                    "200":{
                        "description":"Returns access_token for successfully authenticated user.",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/OnPremAuthSuccess"
                                }
                            }
                        }
                    },
                    "default":{
                        "description":"Error",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-idm-idcs-{project_id}-redirectResult-post",
                "x-filename-id":"_-baas-services-idm-idcs-project_id-redirectresult-post"
            }
        },
        "/_/baas-services/appcheck/{project_id}/attest":{
            "post":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase AppTrust"
                ],
                "security":[
                    {
                        "bearerAuth":[
                        ],
                        "AppKey":[
                        ]
                    },
                    {
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Verify attestation and mint AppTrust token",
                "description":"Verifies a provider attestation token and, when allowed, returns an Fusabase AppTrust token for subsequent protected service calls.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    }
                ],
                "requestBody":{
                    "required":true,
                    "content":{
                        "application/json":{
                            "schema":{
                                "type":"object",
                                "required":[
                                    "provider",
                                    "attestationToken",
                                    "action"
                                ],
                                "properties":{
                                    "provider":{
                                        "type":"string",
                                        "description":"Canonical provider identifier. Required. For Flutter apps this must match the provider key derived from the instanceId header."
                                    },
                                    "attestationToken":{
                                        "type":"string",
                                        "description":"Attestation assertion/token from provider SDK."
                                    },
                                    "action":{
                                        "type":"string",
                                        "description":"Client action being protected (for example login, signup, payment)."
                                    },
                                    "deviceInfo":{
                                        "type":"object",
                                        "description":"Optional provider-specific context data."
                                    },
                                    "challengeNonce":{
                                        "type":"string",
                                        "description":"Optional nonce used for provider challenge binding."
                                    }
                                }
                            }
                        }
                    }
                },
                "responses":{
                    "200":{
                        "description":"Attestation allowed. Returns minted AppTrust token.",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "type":"object",
                                    "required":[
                                        "attestToken"
                                    ],
                                    "properties":{
                                        "attestToken":{
                                            "type":"string"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "400":{
                        "description":"Bad Request - Invalid payload or provider identifier.",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    },
                    "401":{
                        "description":"Unauthorized - Invalid API key.",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    },
                    "403":{
                        "description":"Attestation blocked or provider disabled.",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    },
                    "404":{
                        "description":"Provider not found.",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    },
                    "500":{
                        "description":"Error - Verification or token generation failed.",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    },
                    "503":{
                        "description":"Service unavailable - Provider configuration store is temporarily unavailable.",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-appcheck-{project_id}-attest-post",
                "x-filename-id":"_-baas-services-appcheck-project_id-attest-post"
            }
        },
        "/_/baas-services/appcheck/{project_id}/nonce":{
            "post":{
                "tags":[
                    "Oracle Fusabase",
                    "Fusabase AppTrust"
                ],
                "security":[
                    {
                        "AppKey":[
                        ]
                    }
                ],
                "summary":"Generate AppTrust nonce",
                "description":"Generates a short-lived nonce for AppTrust client attestation flows and stores it in fusabase social states.",
                "parameters":[
                    {
                        "$ref":"#/components/parameters/projectId"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Nonce generated successfully.",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "type":"object",
                                    "required":[
                                        "nonce",
                                        "state",
                                        "expiresIn"
                                    ],
                                    "properties":{
                                        "nonce":{
                                            "type":"string",
                                            "description":"Generated nonce value for provider SDK challenge binding."
                                        },
                                        "state":{
                                            "type":"string",
                                            "description":"State key used to store nonce in fusabase backend."
                                        },
                                        "expiresIn":{
                                            "type":"integer",
                                            "description":"Nonce validity window in seconds."
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "400":{
                        "description":"Bad Request - Missing required parameters.",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    },
                    "500":{
                        "description":"Error - Nonce generation or storage failed.",
                        "content":{
                            "application/json":{
                                "schema":{
                                    "$ref":"#/components/schemas/ErrorResponseItem"
                                }
                            }
                        }
                    }
                },
                "x-internal-id":"_-baas-services-appcheck-{project_id}-nonce-post",
                "x-filename-id":"_-baas-services-appcheck-project_id-nonce-post"
            }
        }
    },
    "components":{
        "securitySchemes":{
            "bearerAuth":{
                "type":"http",
                "bearerFormat":"JWT",
                "scheme":"bearer"
            },
            "onPremAuthToken":{
                "type":"apiKey",
                "in":"header",
                "name":"X-AUTHZ"
            },
            "AppKey":{
                "type":"apiKey",
                "in":"query",
                "name":"apiKey"
            }
        },
        "parameters":{
            "applicationId":{
                "name":"app_id",
                "in":"path",
                "description":"Specifies a valid application id registered with fusabase service.",
                "required":true,
                "schema":{
                    "$ref":"#/components/schemas/GUID"
                }
            },
            "projectId":{
                "name":"project_id",
                "in":"path",
                "description":"Specifies a unique Project ID, associated with the fusabase Project",
                "required":true,
                "schema":{
                    "$ref":"#/components/schemas/GUID"
                }
            },
            "email":{
                "name":"email",
                "in":"query",
                "description":"Specifies the email, associated with the user to perform action like verify email or reset password",
                "required":true,
                "schema":{
                    "type":"string",
                    "format":"email"
                }
            },
            "socialmethod":{
                "name":"method",
                "in":"query",
                "description":"Sign-In Method for Social Login. Note: % in (oidc and saml) represents custom social providers name.",
                "required":true,
                "schema":{
                    "type":"string",
                    "pattern":"^[A-Za-z]+$",
                    "maxLength":128,
                    "enum":[
                        "google",
                        "facebook",
                        "github",
                        "oidc_%",
                        "saml_%"
                    ]
                }
            },
            "actionCode":{
                "name":"code",
                "in":"query",
                "description":"Specifies the code, associated with the user to perform action like verify email or reset password",
                "required":true,
                "schema":{
                    "$ref":"#/components/schemas/GUID"
                }
            },
            "actionCodeRequestType":{
                "name":"requesttype",
                "in":"query",
                "description":"Specifies the action to perform like verify email or reset password",
                "required":true,
                "schema":{
                    "type":"string",
                    "enum":[
                        "resetpwd",
                        "verifyemail"
                    ]
                }
            },
            "transactionHeader":{
                "name":"x-transaction",
                "in":"header",
                "required":true,
                "description":"Used for facilitating transactions",
                "schema":{
                    "$ref":"#/components/schemas/Transaction"
                }
            },
            "storageBucket":{
                "name":"bucket",
                "in":"path",
                "required":true,
                "description":"The storage bucket to operate on",
                "schema":{
                    "$ref":"#/components/schemas/StorageBucket"
                }
            },
            "objectLocatorHeader":{
                "name":"x-object-path",
                "in":"header",
                "required":true,
                "description":"Object Path and Bucket",
                "schema":{
                    "type":"object",
                    "additionalProperties":false,
                    "properties":{
                        "path":{
                            "$ref":"#/components/schemas/ObjectPath"
                        },
                        "bucket":{
                            "$ref":"#/components/schemas/StorageBucket"
                        }
                    },
                    "required":[
                        "path"
                    ]
                }
            },
            "preAuthRequestID":{
                "name":"par_id",
                "in":"path",
                "required":true,
                "description":"PreAuthenticated Request ID for the service",
                "schema":{
                    "$ref":"#/components/schemas/GUID"
                }
            },
            "filePathURL":{
                "name":"filepath",
                "description":"URLEncoded path for the object",
                "in":"path",
                "required":true,
                "schema":{
                    "type":"string",
                    "maxLength":10000,
                    "pattern":"^([a-zA-Z][a-zA-Z0-9]*%2F)*[a-zA-Z0-9][a-zA-Z0-9.]*[a-zA-Z0-9]$"
                }
            },
            "multipartRequestID":{
                "name":"multipart_id",
                "in":"path",
                "required":true,
                "description":"Multipart Request ID for the service",
                "schema":{
                    "$ref":"#/components/schemas/GUID"
                }
            },
            "srpRequestType":{
                "name":"reqtype",
                "in":"query",
                "description":"The Step to perform currently for authentication",
                "required":true,
                "schema":{
                    "type":"string",
                    "enum":[
                        "key_exchange",
                        "session_match"
                    ]
                }
            },
            "vectorPathQuery":{
                "name":"path",
                "in":"query",
                "description":"Collection path encoded as JSON array string, e.g. [\"myCollection\"].",
                "required":true,
                "schema":{
                    "type":"string"
                },
                "example":"[\"myCollection\"]"
            }
        },
        "schemas":{
            "CollectionPath":{
                "type":"array",
                "description":"This object describes the path to a collection/sub-collection. The number of elements must be Odd.",
                "items":{
                    "type":"string",
                    "maxLength":128,
                    "pattern":"^[a-zA-Z0-9]*$"
                },
                "minItems":1
            },
            "DocVersion":{
                "type":"string",
                "description":"Document version"
            },
            "ApiVersion":{
                "type":"integer",
                "description":"Tells the Oracle DB Api version to use.",
                "enum":[
                    1,
                    2
                ],
                "default":1
            },
            "DocumentPath":{
                "type":"array",
                "description":"This object describes the path to a document in a collection/sub-collection. The number of elements must be Even.",
                "items":{
                    "type":"string",
                    "maxLength":128,
                    "pattern":"^[a-zA-Z0-9]*$"
                },
                "minItems":2
            },
            "QueryCondition":{
                "type":"object",
                "properties":{
                    "field":{
                        "type":"string",
                        "pattern":"^[a-zA-Z][a-zA-Z0-9]*$",
                        "maxLength":128
                    },
                    "op":{
                        "type":"string",
                        "enum":[
                            "==",
                            ">=",
                            "<=",
                            "<",
                            ">",
                            "in",
                            "not in",
                            "like",
                            "!="
                        ]
                    },
                    "value":{
                    }
                },
                "required":[
                    "field",
                    "op",
                    "value"
                ]
            },
            "Transaction":{
                "type":"object",
                "properties":{
                    "begin_trans":{
                        "type":"integer",
                        "default":0,
                        "enum":[
                            0,
                            1
                        ]
                    },
                    "end_trans":{
                        "type":"integer",
                        "default":0,
                        "enum":[
                            0,
                            1
                        ]
                    },
                    "trans_name":{
                        "type":"string",
                        "nullable":true,
                        "maxLength":128
                    }
                },
                "required":[
                    "begin_trans",
                    "end_trans"
                ]
            },
            "OrderByProperty":{
                "type":"object",
                "description":"Sorts the resultset based on field in ascending or descending",
                "properties":{
                    "field":{
                        "type":"string",
                        "maxLength":128
                    },
                    "direction":{
                        "type":"string",
                        "enum":[
                            "asc",
                            "desc"
                        ]
                    }
                },
                "required":[
                    "field",
                    "direction"
                ]
            },
            "AggregateByProperty":{
                "type":"object",
                "properties":{
                    "field":{
                        "type":"string",
                        "pattern":"^[a-zA-Z][a-zA-Z0-9]*$",
                        "maxLength":128
                    },
                    "op_key":{
                        "type":"string",
                        "pattern":"^[a-zA-Z][a-zA-Z0-9]*$",
                        "maxLength":128
                    },
                    "func":{
                        "type":"string",
                        "enum":[
                            "count",
                            "sum",
                            "avg"
                        ]
                    }
                },
                "required":[
                    "field",
                    "func"
                ],
                "additionalProperties":false
            },
            "JoinView":{
                "type":"object",
                "properties":{
                    "view_name":{
                        "type":"string",
                        "description":"View that describes the Join. Note: Generally, the suffix \"_BAAS\" is omitted from the view name."
                    }
                },
                "required":[
                    "view_name"
                ]
            },
            "MergeOptions":{
                "type":"object",
                "properties":{
                    "merge":{
                        "type":"boolean",
                        "default":false
                    }
                },
                "required":[
                    "merge"
                ]
            },
            "GUID":{
                "type":"string",
                "pattern":"^[a-zA-Z0-9]*$",
                "maxLength":60
            },
            "DocumentOID":{
                "type":"object",
                "description":"Document OID as Response",
                "additionalProperties":false,
                "properties":{
                    "OID":{
                        "$ref":"#/components/schemas/GUID"
                    },
                    "VERSION":{
                        "oneOf":[
                            {
                                "type":"string"
                            },
                            {
                                "type":"integer"
                            }
                        ]
                    }
                },
                "required":[
                    "OID",
                    "VERSION"
                ]
            },
            "UpdateDocV1":{
                "type":"object",
                "description":"Exact data representation to update/insert. Only used when api_version = 1"
            },
            "UpdateDocV2":{
                "type":"array",
                "description":"API format to be used with api_version = 2 when updating the document",
                "items":{
                    "type":"object",
                    "properties":{
                        "field":{
                            "type":"string"
                        },
                        "op":{
                            "type":"string",
                            "enum":[
                                "set",
                                "delete",
                                "arrayUnion",
                                "arrayRemove",
                                "increment",
                                "servertimestamp"
                            ]
                        },
                        "value":{
                        }
                    },
                    "required":[
                        "field",
                        "op",
                        "value"
                    ]
                }
            },
            "DocumentData":{
                "type":"object",
                "description":"Document Data",
                "properties":{
                    "osons":{
                        "type":"object",
                        "properties":{
                            "DOCUMENT":{
                                "type":"object",
                                "additionalProperties":true
                            },
                            "OID":{
                                "$ref":"#/components/schemas/GUID"
                            },
                            "CREATED":{
                                "type":"string",
                                "format":"date-time",
                                "maxLength":60
                            },
                            "LAST_MODIFIED":{
                                "type":"string",
                                "format":"date-time",
                                "maxLength":60
                            },
                            "VERSION":{
                                "type":"integer"
                            },
                            "SUBCOLLECTION":{
                                "type":"object"
                            }
                        },
                        "required":[
                            "DOCUMENT",
                            "OID"
                        ],
                        "additionalProperties":false
                    }
                }
            },
            "ErrorResponseItem":{
                "type":"object",
                "properties":{
                    "error":{
                        "type":"string",
                        "maxLength":128
                    }
                },
                "additionalProperties":false
            },
            "QueryResponseItem":{
                "type":"object",
                "description":"Document Data List",
                "properties":{
                    "ret":{
                        "type":"array",
                        "items":{
                            "$ref":"#/components/schemas/DocumentData"
                        }
                    }
                }
            },
            "StorageBucket":{
                "type":"string",
                "maxLength":128,
                "pattern":"^[a-zA-Z][a-zA-Z0-9-_]*[a-zA-Z0-9]$"
            },
            "ObjectPath":{
                "type":"string",
                "maxLength":10000,
                "example":"files/folders/image.jpg",
                "pattern":"^([a-zA-Z][a-zA-Z0-9]*/)*[a-zA-Z0-9][a-zA-Z0-9.]*[a-zA-Z0-9]$"
            },
            "ObjectMetadata":{
                "type":"object",
                "properties":{
                    "contentType":{
                        "type":"string",
                        "pattern":"^[a-zA-Z]*/[a-zA-Z]*$"
                    },
                    "name":{
                        "type":"string",
                        "pattern":"^[a-zA-Z]*/[a-zA-Z]*$"
                    },
                    "bucket":{
                        "type":"string",
                        "pattern":"^[a-zA-Z]*/[a-zA-Z]*$"
                    },
                    "size":{
                        "type":"integer"
                    },
                    "md5sum":{
                        "type":"string",
                        "pattern":"^[a-fA-F0-9]{32}$",
                        "maxLength":32
                    },
                    "updated":{
                        "type":"string",
                        "format":"date-time"
                    },
                    "timeCreated":{
                        "type":"string",
                        "format":"date-time"
                    }
                },
                "required":[
                    "md5sum",
                    "timeCreated",
                    "updated"
                ]
            },
            "ObjectSummary":{
                "type":"object",
                "properties":{
                    "name":{
                        "$ref":"#/components/schemas/ObjectPath"
                    },
                    "size":{
                        "type":"integer"
                    },
                    "md5Hash":{
                        "type":"string",
                        "maxLength":32
                    },
                    "timeCreated":{
                        "type":"string",
                        "format":"date-time"
                    },
                    "updated":{
                        "type":"string",
                        "format":"date-time"
                    }
                },
                "required":[
                    "name"
                ],
                "additionalProperties":false
            },
            "OnPremAuthSuccess":{
                "type":"object",
                "description":"On successful authentication",
                "properties":{
                    "access_token":{
                        "type":"string"
                    },
                    "expires_in":{
                        "type":"integer",
                        "default":3600
                    },
                    "token_type":{
                        "type":"string",
                        "default":"Bearer"
                    },
                    "refresh_token":{
                        "type":"string"
                    }
                },
                "required":[
                    "access_token",
                    "expires_in",
                    "token_type"
                ],
                "additionalProperties":false
            },
            "DenseEmbeddingInput":{
                "type":"object",
                "properties":{
                    "type":{
                        "type":"string",
                        "enum":[
                            "dense"
                        ]
                    },
                    "values":{
                        "type":"array",
                        "items":{
                            "type":"number"
                        }
                    }
                },
                "required":[
                    "values"
                ]
            },
            "SparseEmbeddingInput":{
                "type":"object",
                "properties":{
                    "type":{
                        "type":"string",
                        "enum":[
                            "sparse"
                        ]
                    },
                    "dimension":{
                        "type":"integer",
                        "minimum":1
                    },
                    "indices":{
                        "type":"array",
                        "items":{
                            "type":"integer",
                            "minimum":0
                        }
                    },
                    "values":{
                        "type":"array",
                        "items":{
                            "type":"number"
                        }
                    }
                },
                "required":[
                    "dimension",
                    "indices",
                    "values"
                ]
            },
            "EmbeddingsPayload":{
                "type":"object",
                "description":"BYOV embeddings keyed by vector field name. Dense shorthand array is also accepted.",
                "additionalProperties":{
                    "oneOf":[
                        {
                            "$ref":"#/components/schemas/DenseEmbeddingInput"
                        },
                        {
                            "$ref":"#/components/schemas/SparseEmbeddingInput"
                        },
                        {
                            "type":"array",
                            "items":{
                                "type":"number"
                            }
                        }
                    ]
                }
            },
            "VectorSearch":{
                "type":"object",
                "properties":{
                    "field":{
                        "type":"string"
                    },
                    "query":{
                        "type":"object",
                        "properties":{
                            "vector":{
                                "type":"array",
                                "items":{
                                    "type":"number"
                                }
                            },
                            "sparse":{
                                "$ref":"#/components/schemas/SparseEmbeddingInput"
                            }
                        }
                    },
                    "metric":{
                        "type":"string",
                        "enum":[
                            "COSINE",
                            "EUCLIDEAN",
                            "DOT"
                        ],
                        "default":"COSINE"
                    },
                    "topK":{
                        "type":"integer",
                        "minimum":1
                    },
                    "threshold":{
                        "type":"number"
                    }
                },
                "required":[
                    "field",
                    "query",
                    "metric"
                ]
            },
            "VectorProfileResponse":{
                "type":"object",
                "properties":{
                    "path":{
                        "$ref":"#/components/schemas/CollectionPath"
                    },
                    "profile":{
                        "type":"object",
                        "additionalProperties":true
                    }
                }
            }
        }
    },
    "swagger":"2.0"
}