Author: ilgrosso
Date: Fri Dec 27 08:58:24 2024
New Revision: 1922706
URL: http://svn.apache.org/viewvc?rev=1922706&view=rev
Log:
Adding missing OpenAPI spec for Keymaster
Added:
syncope/site/3.0.10/rest/3.0/keymaster-openapi.json
Modified:
syncope/site/3.0.10/rest/3.0/index.html
Modified: syncope/site/3.0.10/rest/3.0/index.html
URL:
http://svn.apache.org/viewvc/syncope/site/3.0.10/rest/3.0/index.html?rev=1922706&r1=1922705&r2=1922706&view=diff
==============================================================================
--- syncope/site/3.0.10/rest/3.0/index.html (original)
+++ syncope/site/3.0.10/rest/3.0/index.html Fri Dec 27 08:58:24 2024
@@ -65,7 +65,7 @@ under the License.
name: "Apache Syncope"
},
{
- url: window.location.href.substring(0,
window.location.href.lastIndexOf('/')) + "/rest/keymaster/openapi.json",
+ url: window.location.href.substring(0,
window.location.href.lastIndexOf('/')) + "/keymaster-openapi.json",
name: "Apache Syncope Self Keymaster"
}],
docExpansion: 'none',
Added: syncope/site/3.0.10/rest/3.0/keymaster-openapi.json
URL:
http://svn.apache.org/viewvc/syncope/site/3.0.10/rest/3.0/keymaster-openapi.json?rev=1922706&view=auto
==============================================================================
--- syncope/site/3.0.10/rest/3.0/keymaster-openapi.json (added)
+++ syncope/site/3.0.10/rest/3.0/keymaster-openapi.json Fri Dec 27 08:58:24 2024
@@ -0,0 +1,675 @@
+{
+ "openapi" : "3.0.1",
+ "info" : {
+ "title" : "Apache Syncope Self Keymaster",
+ "description" : "Apache Syncope Self Keymaster3.0.10",
+ "contact" : {
+ "name" : "The Apache Syncope community",
+ "url" : "https://syncope.apache.org";,
+ "email" : "[email protected]"
+ },
+ "license" : {
+ "name" : "Apache 2.0 License",
+ "url" : "http://www.apache.org/licenses/LICENSE-2.0.html";
+ },
+ "version" : "3.0.10"
+ },
+ "servers" : [ {
+ "url" : "/syncope/rest/keymaster"
+ } ],
+ "paths" : {
+ "/conf/{key}" : {
+ "get" : {
+ "tags" : [ "Conf Parameters" ],
+ "summary" : "Returns the value(s) of the given conf parameter, if
defined.",
+ "operationId" : "get",
+ "parameters" : [ {
+ "name" : "key",
+ "in" : "path",
+ "description" : "conf parameter key",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "X-Syncope-Domain",
+ "in" : "header",
+ "required" : true,
+ "schema" : {
+ "description" : "Domains are built to facilitate multitenancy.",
+ "externalDocs" : {
+ "description" : "Apache Syncope Reference Guide",
+ "url" :
"https://syncope.apache.org/docs/3.0/reference-guide.html#domains";
+ },
+ "default" : "Master",
+ "enum" : [ "Master", "Two" ]
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "the value(s) of the given conf parameter, if
defined",
+ "content" : {
+ "application/json" : { }
+ }
+ }
+ },
+ "security" : [ {
+ "BasicAuthentication" : [ ]
+ } ]
+ },
+ "post" : {
+ "tags" : [ "Conf Parameters" ],
+ "summary" : "Sets the value(s) for the given conf parameter.",
+ "operationId" : "set",
+ "parameters" : [ {
+ "name" : "key",
+ "in" : "path",
+ "description" : "conf parameter key",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "X-Syncope-Domain",
+ "in" : "header",
+ "required" : true,
+ "schema" : {
+ "description" : "Domains are built to facilitate multitenancy.",
+ "externalDocs" : {
+ "description" : "Apache Syncope Reference Guide",
+ "url" :
"https://syncope.apache.org/docs/3.0/reference-guide.html#domains";
+ },
+ "default" : "Master",
+ "enum" : [ "Master", "Two" ]
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "204" : {
+ "description" : "Operation was successful"
+ }
+ },
+ "security" : [ {
+ "BasicAuthentication" : [ ]
+ } ]
+ },
+ "delete" : {
+ "tags" : [ "Conf Parameters" ],
+ "summary" : "Deletes the conf parameter matching the provided key.",
+ "operationId" : "remove",
+ "parameters" : [ {
+ "name" : "key",
+ "in" : "path",
+ "description" : "conf parameter key",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "X-Syncope-Domain",
+ "in" : "header",
+ "required" : true,
+ "schema" : {
+ "description" : "Domains are built to facilitate multitenancy.",
+ "externalDocs" : {
+ "description" : "Apache Syncope Reference Guide",
+ "url" :
"https://syncope.apache.org/docs/3.0/reference-guide.html#domains";
+ },
+ "default" : "Master",
+ "enum" : [ "Master", "Two" ]
+ }
+ } ],
+ "responses" : {
+ "204" : {
+ "description" : "Operation was successful"
+ }
+ },
+ "security" : [ {
+ "BasicAuthentication" : [ ]
+ } ]
+ }
+ },
+ "/conf" : {
+ "get" : {
+ "tags" : [ "Conf Parameters" ],
+ "summary" : "Returns the full list of defined conf parameters, with
values.",
+ "operationId" : "list",
+ "parameters" : [ {
+ "name" : "X-Syncope-Domain",
+ "in" : "header",
+ "required" : true,
+ "schema" : {
+ "description" : "Domains are built to facilitate multitenancy.",
+ "externalDocs" : {
+ "description" : "Apache Syncope Reference Guide",
+ "url" :
"https://syncope.apache.org/docs/3.0/reference-guide.html#domains";
+ },
+ "default" : "Master",
+ "enum" : [ "Master", "Two" ]
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "full list of defined conf parameters, with
values",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "object"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security" : [ {
+ "BasicAuthentication" : [ ]
+ } ]
+ }
+ },
+ "/domains/{key}/adjustPoolSize" : {
+ "post" : {
+ "tags" : [ "Domains" ],
+ "summary" : "Adjusts the connection pool to the domain database.",
+ "operationId" : "adjustPoolSize",
+ "parameters" : [ {
+ "name" : "key",
+ "in" : "path",
+ "description" : "key of domain to be updated",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "poolMaxActive",
+ "in" : "query",
+ "description" : "database pool max size",
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ }, {
+ "name" : "poolMinIdle",
+ "in" : "query",
+ "description" : "database pool max size",
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ }, {
+ "name" : "X-Syncope-Domain",
+ "in" : "header",
+ "required" : true,
+ "schema" : {
+ "description" : "Domains are built to facilitate multitenancy.",
+ "externalDocs" : {
+ "description" : "Apache Syncope Reference Guide",
+ "url" :
"https://syncope.apache.org/docs/3.0/reference-guide.html#domains";
+ },
+ "default" : "Master",
+ "enum" : [ "Master", "Two" ]
+ }
+ } ],
+ "responses" : {
+ "204" : {
+ "description" : "Operation was successful"
+ }
+ },
+ "security" : [ {
+ "BasicAuthentication" : [ ]
+ } ]
+ }
+ },
+ "/domains/{key}/changeAdminPassword" : {
+ "post" : {
+ "tags" : [ "Domains" ],
+ "summary" : "Change admin's password for the given domain.",
+ "operationId" : "changeAdminPassword",
+ "parameters" : [ {
+ "name" : "key",
+ "in" : "path",
+ "description" : "key of domain to be updated",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "password",
+ "in" : "query",
+ "description" : "encoded password value",
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "cipherAlgorithm",
+ "in" : "query",
+ "description" : "password cipher algorithm",
+ "schema" : {
+ "type" : "string",
+ "enum" : [ "SHA", "SHA1", "SHA256", "SHA512", "AES", "SMD5",
"SSHA", "SSHA1", "SSHA256", "SSHA512", "BCRYPT" ]
+ }
+ }, {
+ "name" : "X-Syncope-Domain",
+ "in" : "header",
+ "required" : true,
+ "schema" : {
+ "description" : "Domains are built to facilitate multitenancy.",
+ "externalDocs" : {
+ "description" : "Apache Syncope Reference Guide",
+ "url" :
"https://syncope.apache.org/docs/3.0/reference-guide.html#domains";
+ },
+ "default" : "Master",
+ "enum" : [ "Master", "Two" ]
+ }
+ } ],
+ "responses" : {
+ "204" : {
+ "description" : "Operation was successful"
+ }
+ },
+ "security" : [ {
+ "BasicAuthentication" : [ ]
+ } ]
+ }
+ },
+ "/domains" : {
+ "get" : {
+ "tags" : [ "Domains" ],
+ "summary" : "Returns the list of defined domains.",
+ "operationId" : "list_1",
+ "parameters" : [ {
+ "name" : "X-Syncope-Domain",
+ "in" : "header",
+ "required" : true,
+ "schema" : {
+ "description" : "Domains are built to facilitate multitenancy.",
+ "externalDocs" : {
+ "description" : "Apache Syncope Reference Guide",
+ "url" :
"https://syncope.apache.org/docs/3.0/reference-guide.html#domains";
+ },
+ "default" : "Master",
+ "enum" : [ "Master", "Two" ]
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "list of defined domains",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/Domain"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security" : [ {
+ "BasicAuthentication" : [ ]
+ } ]
+ },
+ "post" : {
+ "tags" : [ "Domains" ],
+ "summary" : "Creates a new domain.",
+ "operationId" : "create",
+ "parameters" : [ {
+ "name" : "X-Syncope-Domain",
+ "in" : "header",
+ "description" : "domain to be created",
+ "required" : true,
+ "schema" : {
+ "description" : "Domains are built to facilitate multitenancy.",
+ "externalDocs" : {
+ "description" : "Apache Syncope Reference Guide",
+ "url" :
"https://syncope.apache.org/docs/3.0/reference-guide.html#domains";
+ },
+ "default" : "Master",
+ "enum" : [ "Master", "Two" ]
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/Domain"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "201" : {
+ "description" : "Domain successfully created",
+ "headers" : {
+ "X-Syncope-Key" : {
+ "description" : "Key of the domin created",
+ "style" : "simple",
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ "Location" : {
+ "description" : "URL of the domin created",
+ "style" : "simple",
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ }
+ }
+ },
+ "security" : [ {
+ "BasicAuthentication" : [ ]
+ } ]
+ }
+ },
+ "/domains/{key}" : {
+ "get" : {
+ "tags" : [ "Domains" ],
+ "summary" : "Returns the domain matching the given key.",
+ "operationId" : "read",
+ "parameters" : [ {
+ "name" : "key",
+ "in" : "path",
+ "description" : "key of the domain to be read",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "X-Syncope-Domain",
+ "in" : "header",
+ "required" : true,
+ "schema" : {
+ "description" : "Domains are built to facilitate multitenancy.",
+ "externalDocs" : {
+ "description" : "Apache Syncope Reference Guide",
+ "url" :
"https://syncope.apache.org/docs/3.0/reference-guide.html#domains";
+ },
+ "default" : "Master",
+ "enum" : [ "Master", "Two" ]
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "domain matching the given key",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/Domain"
+ }
+ }
+ }
+ }
+ },
+ "security" : [ {
+ "BasicAuthentication" : [ ]
+ } ]
+ },
+ "delete" : {
+ "tags" : [ "Domains" ],
+ "summary" : "Deletes the domain matching the provided key.",
+ "operationId" : "delete",
+ "parameters" : [ {
+ "name" : "key",
+ "in" : "path",
+ "description" : "key of domain to be deleted",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "X-Syncope-Domain",
+ "in" : "header",
+ "required" : true,
+ "schema" : {
+ "description" : "Domains are built to facilitate multitenancy.",
+ "externalDocs" : {
+ "description" : "Apache Syncope Reference Guide",
+ "url" :
"https://syncope.apache.org/docs/3.0/reference-guide.html#domains";
+ },
+ "default" : "Master",
+ "enum" : [ "Master", "Two" ]
+ }
+ } ],
+ "responses" : {
+ "204" : {
+ "description" : "Operation was successful"
+ }
+ },
+ "security" : [ {
+ "BasicAuthentication" : [ ]
+ } ]
+ }
+ },
+ "/networkServices" : {
+ "post" : {
+ "tags" : [ "Network Services" ],
+ "summary" : "(Un)registers the given service.",
+ "operationId" : "action",
+ "parameters" : [ {
+ "name" : "action",
+ "in" : "query",
+ "description" : "action to perform on the given service",
+ "schema" : {
+ "type" : "string",
+ "enum" : [ "register", "unregister" ]
+ }
+ }, {
+ "name" : "X-Syncope-Domain",
+ "in" : "header",
+ "required" : true,
+ "schema" : {
+ "description" : "Domains are built to facilitate multitenancy.",
+ "externalDocs" : {
+ "description" : "Apache Syncope Reference Guide",
+ "url" :
"https://syncope.apache.org/docs/3.0/reference-guide.html#domains";
+ },
+ "default" : "Master",
+ "enum" : [ "Master", "Two" ]
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/NetworkService"
+ }
+ }
+ },
+ "required" : true
+ },
+ "responses" : {
+ "204" : {
+ "description" : "Operation was successful"
+ }
+ },
+ "security" : [ {
+ "BasicAuthentication" : [ ]
+ } ]
+ }
+ },
+ "/networkServices/{serviceType}/get" : {
+ "get" : {
+ "tags" : [ "Network Services" ],
+ "summary" : "Returns the service instance to invoke, for the given
type.",
+ "operationId" : "get_1",
+ "parameters" : [ {
+ "name" : "serviceType",
+ "in" : "path",
+ "description" : "service type",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "enum" : [ "CORE", "CONSOLE", "ENDUSER", "SRA", "WA" ]
+ }
+ }, {
+ "name" : "X-Syncope-Domain",
+ "in" : "header",
+ "required" : true,
+ "schema" : {
+ "description" : "Domains are built to facilitate multitenancy.",
+ "externalDocs" : {
+ "description" : "Apache Syncope Reference Guide",
+ "url" :
"https://syncope.apache.org/docs/3.0/reference-guide.html#domains";
+ },
+ "default" : "Master",
+ "enum" : [ "Master", "Two" ]
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "service instance to invoke, for the given type",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/NetworkService"
+ }
+ }
+ }
+ }
+ },
+ "security" : [ {
+ "BasicAuthentication" : [ ]
+ } ]
+ }
+ },
+ "/networkServices/{serviceType}" : {
+ "get" : {
+ "tags" : [ "Network Services" ],
+ "summary" : "Returns the list of registered services.",
+ "operationId" : "list_2",
+ "parameters" : [ {
+ "name" : "serviceType",
+ "in" : "path",
+ "description" : "service type",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "enum" : [ "CORE", "CONSOLE", "ENDUSER", "SRA", "WA" ]
+ }
+ }, {
+ "name" : "X-Syncope-Domain",
+ "in" : "header",
+ "required" : true,
+ "schema" : {
+ "description" : "Domains are built to facilitate multitenancy.",
+ "externalDocs" : {
+ "description" : "Apache Syncope Reference Guide",
+ "url" :
"https://syncope.apache.org/docs/3.0/reference-guide.html#domains";
+ },
+ "default" : "Master",
+ "enum" : [ "Master", "Two" ]
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "list of registered services",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/NetworkService"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security" : [ {
+ "BasicAuthentication" : [ ]
+ } ]
+ }
+ }
+ },
+ "components" : {
+ "schemas" : {
+ "Domain" : {
+ "type" : "object",
+ "properties" : {
+ "key" : {
+ "type" : "string"
+ },
+ "jdbcDriver" : {
+ "type" : "string"
+ },
+ "jdbcURL" : {
+ "type" : "string"
+ },
+ "dbSchema" : {
+ "type" : "string"
+ },
+ "dbUsername" : {
+ "type" : "string"
+ },
+ "dbPassword" : {
+ "type" : "string"
+ },
+ "transactionIsolation" : {
+ "type" : "string",
+ "enum" : [ "TRANSACTION_NONE", "TRANSACTION_READ_COMMITTED",
"TRANSACTION_READ_UNCOMMITTED", "TRANSACTION_REPEATABLE_READ",
"TRANSACTION_SERIALIZABLE" ]
+ },
+ "poolMaxActive" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "poolMinIdle" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "auditSql" : {
+ "type" : "string"
+ },
+ "orm" : {
+ "type" : "string"
+ },
+ "databasePlatform" : {
+ "type" : "string"
+ },
+ "adminPassword" : {
+ "type" : "string"
+ },
+ "adminCipherAlgorithm" : {
+ "type" : "string",
+ "enum" : [ "SHA", "SHA1", "SHA256", "SHA512", "AES", "SMD5",
"SSHA", "SSHA1", "SSHA256", "SSHA512", "BCRYPT" ]
+ },
+ "content" : {
+ "type" : "string"
+ },
+ "keymasterConfParams" : {
+ "type" : "string"
+ }
+ }
+ },
+ "NetworkService" : {
+ "type" : "object",
+ "properties" : {
+ "type" : {
+ "type" : "string",
+ "enum" : [ "CORE", "CONSOLE", "ENDUSER", "SRA", "WA" ]
+ },
+ "address" : {
+ "type" : "string"
+ }
+ }
+ }
+ },
+ "securitySchemes" : {
+ "BasicAuthentication" : {
+ "type" : "http",
+ "scheme" : "basic"
+ }
+ }
+ }
+}
\ No newline at end of file
