dexter has uploaded this change for review. ( https://gerrit.osmocom.org/c/onomondo-eim/+/42879?usp=email )
Change subject: rest_api: revert json schema re-formatting ......................................................................
rest_api: revert json schema re-formatting
The JSON schema got reformatted in patch 78810e9d0e2c4fcfa0bff2e16aedd225c7145055, however, the reformatted version now follows a scheme that is incompatible with the emacs default settings. This makes it very hard to work with those files, so let's revert this change.
Change-Id: I2361891875a8e190fff7003196c2df76fd877080 Related: SYS#8100 --- M contrib/rest_api_info_schema.json M contrib/rest_api_resource_schema.json M contrib/rest_api_response_schema.json 3 files changed, 829 insertions(+), 829 deletions(-)
git pull ssh://gerrit.osmocom.org:29418/onomondo-eim refs/changes/79/42879/1
diff --git a/contrib/rest_api_info_schema.json b/contrib/rest_api_info_schema.json index d808dd6..2bf1291 100644 --- a/contrib/rest_api_info_schema.json +++ b/contrib/rest_api_info_schema.json @@ -1,61 +1,61 @@ { - "$id": "https://onomondo.com/schemas/info", - "$schema": "https://json-schema.org/draft/2020-12/schema", - "title": "REST API info", - "type": "object", - "properties": { - "hostname": { - "description": "hostname of the machine where onomondo-eim is running on", - "type": "string" - }, - "node": { - "description": "erlang node name of the onomondo-eim instance", - "type": "string" - }, - "version": { - "description": "version number of the onomondo-eim instance", - "type": "string" - }, - "eimId": { - "description": "eIM identifier (see also GSMA GSP.32)", - "type": "string" - }, - "esipaIp": { - "description": "IP-Address where the ESipa interface is bound to", - "type": "string" - }, - "esipaPort": { - "description": "IP-Port where the ESipa interface is bound to", - "type": "string" - }, - "esipaSslCert": { - "description": "SSL certificate that is used for the ESipa interface (HTTPS)", - "type": "string" - }, - "eimCert": { - "description": "eIM certificate (used for creating signatures)", - "type": "string" - }, - "rootCiCerts": { - "description": "List of configured eUICC root CI certificates", - "type": "array", - "items": { - "type": "string" - } - }, - "addInitialEimRequest": { - "description": "ASN.1 encoded eIM configuration (see also GSMA SGP.32)", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "eimConfigurationData": { - "description": "ASN.1 encoded eIM configuration (see also GSMA SGP.32)", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "counterValue": { - "description": "Initial counter value for signature generation (see also GSMA SGP.32)", - "type": "integer" + "$id": "https://onomondo.com/schemas/info", + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "REST API info", + "type": "object", + "properties": { + "hostname": { + "description": "hostname of the machine where onomondo-eim is running on", + "type": "string" + }, + "node": { + "description": "erlang node name of the onomondo-eim instance", + "type": "string" + }, + "version": { + "description": "version number of the onomondo-eim instance", + "type": "string" + }, + "eimId": { + "description": "eIM identifier (see also GSMA GSP.32)", + "type": "string" + }, + "esipaIp": { + "description": "IP-Address where the ESipa interface is bound to", + "type": "string" + }, + "esipaPort": { + "description": "IP-Port where the ESipa interface is bound to", + "type": "string" + }, + "esipaSslCert": { + "description": "SSL certificate that is used for the ESipa interface (HTTPS)", + "type": "string" + }, + "eimCert": { + "description": "eIM certificate (used for creating signatures)", + "type": "string" + }, + "rootCiCerts": { + "description": "List of configured eUICC root CI certificates", + "type": "array", + "items": { + "type": "string" + } + }, + "addInitialEimRequest": { + "description": "ASN.1 encoded eIM configuration (see also GSMA SGP.32)", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "eimConfigurationData": { + "description": "ASN.1 encoded eIM configuration (see also GSMA SGP.32)", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "counterValue": { + "description": "Initial counter value for signature generation (see also GSMA SGP.32)", + "type": "integer" + } } - } } diff --git a/contrib/rest_api_resource_schema.json b/contrib/rest_api_resource_schema.json index 27726ff..12fd049 100644 --- a/contrib/rest_api_resource_schema.json +++ b/contrib/rest_api_resource_schema.json @@ -1,285 +1,285 @@ { - "$id": "https://onomondo.com/schemas/resource", - "$schema": "https://json-schema.org/draft/2020-12/schema", - "title": "REST API resource", - "type": "object", - "properties": { - "eidValue": { - "description": "EID value of the eUICC to be addressed", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "order": { - "description": "Order to be executed", - "type": "object", - "anyOf": [ - { - "download": { - "description": "order to trigger a profile download", - "type": "object", - "properties": { - "activationCode": { - "description": "see GSMA SGP.22, section 4.1", - "type": "string" - }, - "required": [ - "activationCode" - ] - } - } - }, - { - "psmo": { - "description": "order the execution of a PSMO, see also GSMA SGP.32, section 2.11.1.1.2", - "type": "array", - "items": { - "type": "object", - "properties": { - "anyOf": [ - { - "enable": { - "description": "order the execution of a profile enable PSMO, see also GSMA SGP.32, section 3.4.1", - "type": "object", - "properties": { - "iccid": { - "description": "ICCID of the profile. (ICCID in nibble-swapped raw format)", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "rollback": { - "description": "see also GSMA SGP.32, section 3.4.1, subsection 'Profile Rollback Procedure'", - "type": "boolean" - } - }, - "required": [ - "iccid" - ] - } - }, - { - "disable": { - "description": "order the execution of a profile disable PSMO, see also GSMA SGP.32, section 3.4.2", - "type": "object", - "properties": { - "iccid": { - "description": "ICCID of the profile. (ICCID in nibble-swapped raw format)", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - } - }, - "required": [ - "iccid" - ] - } - }, - { - "delete": { - "description": "order the execution of a profile delete PSMO, see also GSMA SGP.32, section 3.4.3", - "type": "object", - "properties": { - "iccid": { - "description": "ICCID of the profile. (ICCID in nibble-swapped raw format)", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - } - }, - "required": [ - "iccid" - ] - } - }, - { - "listProfileInfo": { - "description": "order the execution of a listProfileInfo PSMO", - "type": "object", - "properties": { - "searchCriteria": { - "anyOf": [ - { - "isdpAid": { - "description": "AID of the ISDP (identifies a profile)", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - } - }, - { - "iccid": { - "description": "ICCID of the profile. (ICCID in nibble-swapped raw format)", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - } - }, - { - "profileClass": { - "description": "0=test, 1=provisioning, 2=operational", - "type": "integer" - } - } - ] - }, - "taglist": { - "description": "concatonation of the BER-TLV tags that shall be included in the response", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "required": [ - "searchCriteria" - ] - } - } - }, - { - "getRAT": { - "description": "order the execution of a getRAT PSMO, see also GSMA SGP.32, section 5.9.13", - "type": "object", - "properties": {} - } - }, - { - "configureImmediateEnable": { - "description": "order the execution of a configureImmediateEnable PSMO, see also GSMA SGP.32, section 5.13.6", - "type": "object", - "properties": { - "immediateEnableFlag": { - "description": "enable/disable automatic profile enabeling", - "type": "boolean" - }, - "defaultSmdpOid": { - "description": "object ID of the default SMDP+", - "type": "string" - }, - "defaultSmdpAddress": { - "description": "FQDN of the default SMDP+", - "type": "string" - }, - "required": [ - "immediateEnableFlag" - ] - } - } - } - ] - } - } - } - }, - { - "eco": { - "description": "order the execition of a eCO, see also GSMA SGP.32, section 2.11.1.1.3", - "type": "array", - "items": { - "type": "object", - "properties": { - "anyOf": [ - { - "addEim": { - "description": "add an eIM", - "type": "object", - "properties": { - "eimConfigurationData": { - "description": "ASN.1 encoded EimConfigurationData", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - } - }, - "required": [ - "eimConfigurationData" - ] - } - }, - { - "deleteEim": { - "description": "delete an eIM", - "type": "object", - "properties": { - "eimId": { - "description": "eimId of the eIM", - "type": "string" - } - }, - "required": [ - "eimId" - ] - } - }, - { - "updateEim": { - "description": "update an eIM", - "type": "object", - "properties": { - "eimConfigurationData": { - "description": "ASN.1 encoded EimConfigurationData", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - } - }, - "required": [ - "eimConfigurationData" - ] - } - }, - { - "listEim": { - "description": "list all configured eIMs", - "type": "object", - "properties": {} - } - } - ] - } - } - } - }, - { - "edr": { - "description": "order to perform an IpaEuiccDataRequest", - "type": "object", - "properties": { - "tagList": { - "description": "see GSMA SGP.32, section 2.11.1.2", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "required": [ - "tagList" - ] - } - } - }, - { - "euicc": { - "description": "set a parameter in the euicc master data table", - "type": "array", - "items": { - "counterValue": { - "description": "sets the signature counter to a specified value (use with caution)", - "type": "integer" - }, - "consumerEuicc": { - "description": "tells the eIM that the remote end (IPAd) uses a consumer eUICC with an IoT eUICC emulation mode", - "type": "boolean" - }, - "associationToken": { - "description": "association token that the eUICC uses to identify this eIM internally", - "type": "integer" - }, - "signAlgo": { - "description": "algorithm to be used for checking eUICC package results", - "type": "string", - "enum": [ - "prime256v1", - "brainpoolP256r1" - ] - }, - "signPubKey": { - "description": "public key to be used for checking eUICC package results", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - } - } - } - } - ] + "$id": "https://onomondo.com/schemas/resource", + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "REST API resource", + "type": "object", + "properties": { + "eidValue": { + "description": "EID value of the eUICC to be addressed", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "order": { + "description": "Order to be executed", + "type": "object", + "anyOf": [ + { + "download": { + "description": "order to trigger a profile download", + "type": "object", + "properties": { + "activationCode": { + "description": "see GSMA SGP.22, section 4.1", + "type": "string" + }, + "required": [ + "activationCode" + ] + } + } + }, + { + "psmo": { + "description": "order the execution of a PSMO, see also GSMA SGP.32, section 2.11.1.1.2", + "type": "array", + "items": { + "type": "object", + "properties": { + "anyOf": [ + { + "enable": { + "description": "order the execution of a profile enable PSMO, see also GSMA SGP.32, section 3.4.1", + "type": "object", + "properties": { + "iccid": { + "description": "ICCID of the profile. (ICCID in nibble-swapped raw format)", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "rollback": { + "description": "see also GSMA SGP.32, section 3.4.1, subsection 'Profile Rollback Procedure'", + "type": "boolean" + } + }, + "required": [ + "iccid" + ] + } + }, + { + "disable": { + "description": "order the execution of a profile disable PSMO, see also GSMA SGP.32, section 3.4.2", + "type": "object", + "properties": { + "iccid": { + "description": "ICCID of the profile. (ICCID in nibble-swapped raw format)", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + } + }, + "required": [ + "iccid" + ] + } + }, + { + "delete": { + "description": "order the execution of a profile delete PSMO, see also GSMA SGP.32, section 3.4.3", + "type": "object", + "properties": { + "iccid": { + "description": "ICCID of the profile. (ICCID in nibble-swapped raw format)", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + } + }, + "required": [ + "iccid" + ] + } + }, + { + "listProfileInfo": { + "description": "order the execution of a listProfileInfo PSMO", + "type": "object", + "properties": { + "searchCriteria": { + "anyOf": [ + { + "isdpAid": { + "description": "AID of the ISDP (identifies a profile)", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + } + }, + { + "iccid": { + "description": "ICCID of the profile. (ICCID in nibble-swapped raw format)", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + } + }, + { + "profileClass": { + "description": "0=test, 1=provisioning, 2=operational", + "type": "integer" + } + } + ] + }, + "taglist": { + "description": "concatonation of the BER-TLV tags that shall be included in the response", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "required": [ + "searchCriteria" + ] + } + } + }, + { + "getRAT": { + "description": "order the execution of a getRAT PSMO, see also GSMA SGP.32, section 5.9.13", + "type": "object", + "properties": {} + } + }, + { + "configureImmediateEnable": { + "description": "order the execution of a configureImmediateEnable PSMO, see also GSMA SGP.32, section 5.13.6", + "type": "object", + "properties": { + "immediateEnableFlag": { + "description": "enable/disable automatic profile enabeling", + "type": "boolean" + }, + "defaultSmdpOid": { + "description": "object ID of the default SMDP+", + "type": "string" + }, + "defaultSmdpAddress": { + "description": "FQDN of the default SMDP+", + "type": "string" + }, + "required": [ + "immediateEnableFlag" + ] + } + } + } + ] + } + } + } + }, + { + "eco": { + "description": "order the execition of a eCO, see also GSMA SGP.32, section 2.11.1.1.3", + "type": "array", + "items": { + "type": "object", + "properties": { + "anyOf": [ + { + "addEim": { + "description": "add an eIM", + "type": "object", + "properties": { + "eimConfigurationData": { + "description": "ASN.1 encoded EimConfigurationData", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + } + }, + "required": [ + "eimConfigurationData" + ] + } + }, + { + "deleteEim": { + "description": "delete an eIM", + "type": "object", + "properties": { + "eimId": { + "description": "eimId of the eIM", + "type": "string" + } + }, + "required": [ + "eimId" + ] + } + }, + { + "updateEim": { + "description": "update an eIM", + "type": "object", + "properties": { + "eimConfigurationData": { + "description": "ASN.1 encoded EimConfigurationData", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + } + }, + "required": [ + "eimConfigurationData" + ] + } + }, + { + "listEim": { + "description": "list all configured eIMs", + "type": "object", + "properties": {} + } + } + ] + } + } + } + }, + { + "edr": { + "description": "order to perform an IpaEuiccDataRequest", + "type": "object", + "properties": { + "tagList": { + "description": "see GSMA SGP.32, section 2.11.1.2", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "required": [ + "tagList" + ] + } + } + }, + { + "euicc": { + "description": "set a parameter in the euicc master data table", + "type": "array", + "items": { + "counterValue": { + "description": "sets the signature counter to a specified value (use with caution)", + "type": "integer" + }, + "consumerEuicc": { + "description": "tells the eIM that the remote end (IPAd) uses a consumer eUICC with an IoT eUICC emulation mode", + "type": "boolean" + }, + "associationToken": { + "description": "association token that the eUICC uses to identify this eIM internally", + "type": "integer" + }, + "signAlgo": { + "description": "algorithm to be used for checking eUICC package results", + "type": "string", + "enum": [ + "prime256v1", + "brainpoolP256r1" + ] + }, + "signPubKey": { + "description": "public key to be used for checking eUICC package results", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + } + } + } + } + ] + } } - } } diff --git a/contrib/rest_api_response_schema.json b/contrib/rest_api_response_schema.json index 5b00450..45ccb79 100644 --- a/contrib/rest_api_response_schema.json +++ b/contrib/rest_api_response_schema.json @@ -1,492 +1,492 @@ { - "$id": "https://onomondo.com/schemas/response", - "$schema": "https://json-schema.org/draft/2020-12/schema", - "title": "REST API response", - "type": "object", - "properties": { - "status": { - "description": "general processing status of the order", - "type": "string", - "enum": [ - "new", - "work", - "done", - "deleted", - "absent" - ] - }, - "timestamp": { - "description": "unix-timestamp of the last status update", - "type": "string" - }, - "resource": { - "$ref": "/schemas/resource" - }, - "outcome": { - "description": "specific result if the executed order", - "type": "array", - "items": { - "type": "object", - "properties": { - "anyOf": [ - { - "enableResult": { - "description": "profile enable PSMO result, see also SGP32Definitions.asn1", - "type": "string", - "enum": [ - "ok", - "iccidOrAidNotFound", - "profileNotInDisabledState", - "undefinedError" - ] - } - }, - { - "disableResult": { - "description": "profile disable PSMO result, see also SGP32Definitions.asn1", - "type": "string", - "enum": [ - "ok", - "iccidOrAidNotFound", - "profileNotInEnabledState", - "undefinedError" - ] - } - }, - { - "deleteResult": { - "description": "profile delete PSMO result, see also SGP32Definitions.asn1", - "type": "string", - "enum": [ - "ok", - "iccidOrAidNotFound", - "profileNotInDisabledState", - "undefinedError" - ] - } - }, - { - "listProfileInfoResult": { - "description": "listProfileInfoResult PSMO result, see also SGP32Definitions.asn1", - "type": "object", - "properties": { - "finalResult": { - "description": "overall status code to inform about success or failure", - "type": "string", - "enum": [ - "successResult", - "errorResult" - ] - }, - "profileInfoList": { - "description": "contains a list of installed profiles and their meta data, see also RSPDefinitions.asn1", - "type": "array", - "items": { - "type": "object", - "properties": { - "iccid": { - "description": "ICCID of the profile. (ICCID in nibble-swapped raw format)", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "isdpAid": { - "description": "AID of the ISDP (identifies a profile)", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "profileState": { - "description": "usage state of the prifle", - "type": "string", - "enum": [ - "disabled", - "enabled" - ] - }, - "profileNickname": { - "description": "human readable nickname name of the profile", - "type": "string" - }, - "serviceProviderName": { - "description": "human readable name of the related service provider", - "type": "string" - }, - "profileName": { - "description": "human readable name of the profile", - "type": "string" - }, - "iconType": { - "description": "graphics format in which the profile icon is supplied", - "type": "string" - }, - "icon": { - "description": "icon graphic", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "profileClass": { - "description": "0=test, 1=provisioning, 2=operational", - "type": "integer" - } - } - } - }, - "required": [ - "finalResult" - ] - } - } - }, - { - "getRATResult": { - "description": "getRAT (rules authorization table) PSMO result, see also RSPDefinitions.asn1", - "type": "array", - "items": { - "type": "object", - "properties": { - "pprUpdateControl": { - "description": "defines how to update PPRs via ES6", - "type": "boolean" - }, - "ppr1": { - "description": "Indicator for PPR1 'Disabling of this Profile is not allowed'", - "type": "boolean" - }, - "ppr2": { - "description": "Indicator for PPR2 'Deletion of this Profile is not allowed'", - "type": "boolean" - }, - "allowedOperators": { - "description": "list of allowed operaters, see also GSMA SGP.22, section 2.9.2.1", - "type": "array", - "items": { - "mccMnc": { - "description": "MCC and MNC coded as defined in 3GPP TS 24.008", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "gid1": { - "description": "referring to content of EF GID1 (file identifier '6F3E') as defined in 3GPP TS 31.102", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "gid2": { - "description": "referring to content of EF GID2 (file identifier '6F3F') as defined in 3GPP TS 31.102", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "required": [ - "mccMnc" - ] - } - }, - "consentRequired": { - "description": "indicates that the End User consent is required", - "type": "boolean" - }, - "required": [ - "pprUpdateControl", - "ppr1", - "ppr2", - "allowedOperators", - "consentRequired" - ] - } - } - } - }, - { - "configureImmediateEnableResult": { - "description": "configureImmediateEnableResult (automatic profile enabeling) PSMO result, see also SGP32Definitions.asn1", - "type": "string", - "enum": [ - "ok", - "insufficientMemory", - "commandError", - "undefinedError" - ] - } - }, - { - "addEimResult": { - "description": "addEimResult eCO result", - "type": "object", - "properties": { - "addEimResultCode": { - "description": "overall status code to inform about success or failure", - "type": "string", - "enum": [ - "ok", - "insufficientMemory", - "ciPKUnknown", - "invalidAssociationToken", - "counterValueOutOfRange", - "commandError", - "undefinedError", - "malformedResult" - ] - }, - "associationToken": { - "description": "resulting association token, see also GSMA SGP.32, section 2.11.1.1.1", - "type": "integer" - }, - "required": [ - "addEimResultCode" - ] - } - } - }, - { - "deleteEimResult": { - "description": "deleteEimResult eCO result, see also SGP32Definitions.asn1", - "type": "string", - "enum": [ - "ok", - "eimNotFound", - "lastEimDeleted", - "commandError", - "undefinedError" - ] - } - }, - { - "updateEimResult": { - "description": "updateEimResult eCO result, see also SGP32Definitions.asn1", - "type": "string", - "enum": [ - "ok", - "eimNotFound", - "ciPKUnknown", - "counterValueOutOfRange", - "commandError", - "undefinedError" - ] - } - }, - { - "listEimResult": { - "description": "listEimResult eCO result, see also SGP32Definitions.asn1", - "type": "object", - "properties": { - "finalResult": { - "description": "overall status code to inform about success or failure", - "type": "string", - "enum": [ - "successResult", - "errorResult" - ] - }, - "eimIdList": { - "description": "list containing the IDs of all configured eIM servers", - "type": "array", - "items": { - "eimId": { - "description": "eIM ID", - "type": "string" - }, - "eimIdType": { - "description": "specifies the type of the eIM ID", - "type": "string", - "enum": [ - "eimIdTypeOid", - "eimIdTypeFqdn", - "eimIdTypeProprietary" - ] - }, - "required": [ - "eimId" - ] - } - }, - "required": [ - "finalResult" - ] - } - } - }, - { - "rollbackResult": { - "description": "Status code of the execution of a profile rollback maneuver, see also GSMA SGP.32, section 2.11.1.13 and SGP32Definitions.asn1", - "type": "string", - "enum": [ - "ok", - "undefinedError" - ] - } - }, - { - "processingTerminated": { - "description": "Error code in case the eUICC has terminated the overall eUICC package execution, see also SGP32Definitions.asn1", - "type": "string", - "enum": [ - "resultSizeOverflow", - "unknownOrDamagedCommand", - "interruption", - "undefinedError" - ] - } - }, - { - "notificationResult": { - "description": "Status code to indicate that an otherSignedNotification has been received", - "type": "string", - "enum": [ - "otherSignedNotification" - ] - } - }, - { - "cancelSessionResult": { - "description": "Status code to indicate that the session has been canceled", - "type": "string", - "enum": [ - "ok", - "undefinedError" - ] - } - }, - { - "profileInstallationResult": { - "description": "Final result of a profile download, see also SGP32Definitions.asn1", - "type": "object", - "properties": { - "finalResult": { - "description": "overall status code to inform about succes or failure", - "enum": [ - "successResult", - "errorResult" - ] - }, - "iccid": { - "description": "ICCID of the profile. (ICCID in nibble-swapped raw format)", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "required": [ - "finalResult" - ] - } - } - }, - { - "euiccUpdateResult": { - "description": "contains the result of a parameter update in the euicc master data table", - "type": "string", - "enum": [ - "ok", - "badParamFormat", - "badParam" - ] - } - }, - { - "euiccDataResult": { - "description": "contains the result of an ipaEuiccDataRequest request (see also GSMA SGP.32, section 2.11.1.2)", - "type": "object", - "properties": { - "edrResult": { - "description": "status code of the execution of the ipaEuiccDataRequest", - "type": "string", - "enum": [ - "ok", - "incorrectTagList", - "euiccCiPKIdNotFound", - "undefinedError" - ] - }, - "euiccData": { - "description": "contains the resulting eUICC data objects", - "type": "object", - "properties": { - "defaultSmdpAddress": { - "description": "see GSMA SGP.32", - "type": "string" - }, - "euiccInfo1": { - "description": "ASN.1 encoded, see GSMA SGP.22", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "euiccInfo2": { - "description": "ASN.1 encoded, see GSMA SGP.22 and GSMA SGP.32", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "rootSmdsAddress": { - "description": "see GSMA SGP.32", - "type": "string" - }, - "associationToken": { - "description": "see GSMA SGP.32", - "type": "integer" - }, - "eumCertificate": { - "description": "ASN.1 encoded, see GSMA SGP.22", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "euiccCertificate": { - "description": "ASN.1 encoded, see GSMA SGP.22", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "ipaCapabilities": { - "description": "ASN.1 encoded, see GSMA SGP.32", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "deviceInfo": { - "description": "ASN.1 encoded, see GSMA SGP.32", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "notificationsList": { - "description": "ASN.1 encoded, see GSMA SGP.32", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - } - } - }, - "required": [ - "edrResult" - ] - } - } - }, - { - "procedureError": { - "description": "indicates a problem that lead to a termination of a procedure", - "type": "string", - "enum": [ - "initiateAuthenticationError", - "authenticateResponseError", - "authenticateClientError", - "downloadResponseError", - "getBoundProfilePackageError", - "cancelSessionResponseError", - "handleNotificationError", - "euiccSignatureInvalid", - "undefinedError", - "badPsmo", - "badEco", - "badEdr", - "badOrder", - "abortedOrder", - "stuckOrder", - "noshowOrder" - ] - } - } - ] - } - }, - "debuginfo": { - "description": "Erlang ETS encoded debug information string, for debugging/diagnosis only", - "type": "string", - "pattern": "^[0-9,A-F]{2,32}$" - }, - "required": [ - "status" - ] + "$id": "https://onomondo.com/schemas/response", + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "REST API response", + "type": "object", + "properties": { + "status": { + "description": "general processing status of the order", + "type": "string", + "enum": [ + "new", + "work", + "done", + "deleted", + "absent" + ] + }, + "timestamp": { + "description": "unix-timestamp of the last status update", + "type": "string" + }, + "resource": { + "$ref": "/schemas/resource" + }, + "outcome": { + "description": "specific result if the executed order", + "type": "array", + "items": { + "type": "object", + "properties": { + "anyOf": [ + { + "enableResult": { + "description": "profile enable PSMO result, see also SGP32Definitions.asn1", + "type": "string", + "enum": [ + "ok", + "iccidOrAidNotFound", + "profileNotInDisabledState", + "undefinedError" + ] + } + }, + { + "disableResult": { + "description": "profile disable PSMO result, see also SGP32Definitions.asn1", + "type": "string", + "enum": [ + "ok", + "iccidOrAidNotFound", + "profileNotInEnabledState", + "undefinedError" + ] + } + }, + { + "deleteResult": { + "description": "profile delete PSMO result, see also SGP32Definitions.asn1", + "type": "string", + "enum": [ + "ok", + "iccidOrAidNotFound", + "profileNotInDisabledState", + "undefinedError" + ] + } + }, + { + "listProfileInfoResult": { + "description": "listProfileInfoResult PSMO result, see also SGP32Definitions.asn1", + "type": "object", + "properties": { + "finalResult": { + "description": "overall status code to inform about success or failure", + "type": "string", + "enum": [ + "successResult", + "errorResult" + ] + }, + "profileInfoList": { + "description": "contains a list of installed profiles and their meta data, see also RSPDefinitions.asn1", + "type": "array", + "items": { + "type": "object", + "properties": { + "iccid": { + "description": "ICCID of the profile. (ICCID in nibble-swapped raw format)", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "isdpAid": { + "description": "AID of the ISDP (identifies a profile)", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "profileState": { + "description": "usage state of the prifle", + "type": "string", + "enum": [ + "disabled", + "enabled" + ] + }, + "profileNickname": { + "description": "human readable nickname name of the profile", + "type": "string" + }, + "serviceProviderName": { + "description": "human readable name of the related service provider", + "type": "string" + }, + "profileName": { + "description": "human readable name of the profile", + "type": "string" + }, + "iconType": { + "description": "graphics format in which the profile icon is supplied", + "type": "string" + }, + "icon": { + "description": "icon graphic", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "profileClass": { + "description": "0=test, 1=provisioning, 2=operational", + "type": "integer" + } + } + } + }, + "required": [ + "finalResult" + ] + } + } + }, + { + "getRATResult": { + "description": "getRAT (rules authorization table) PSMO result, see also RSPDefinitions.asn1", + "type": "array", + "items": { + "type": "object", + "properties": { + "pprUpdateControl": { + "description": "defines how to update PPRs via ES6", + "type": "boolean" + }, + "ppr1": { + "description": "Indicator for PPR1 'Disabling of this Profile is not allowed'", + "type": "boolean" + }, + "ppr2": { + "description": "Indicator for PPR2 'Deletion of this Profile is not allowed'", + "type": "boolean" + }, + "allowedOperators": { + "description": "list of allowed operaters, see also GSMA SGP.22, section 2.9.2.1", + "type": "array", + "items": { + "mccMnc": { + "description": "MCC and MNC coded as defined in 3GPP TS 24.008", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "gid1": { + "description": "referring to content of EF GID1 (file identifier '6F3E') as defined in 3GPP TS 31.102", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "gid2": { + "description": "referring to content of EF GID2 (file identifier '6F3F') as defined in 3GPP TS 31.102", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "required": [ + "mccMnc" + ] + } + }, + "consentRequired": { + "description": "indicates that the End User consent is required", + "type": "boolean" + }, + "required": [ + "pprUpdateControl", + "ppr1", + "ppr2", + "allowedOperators", + "consentRequired" + ] + } + } + } + }, + { + "configureImmediateEnableResult": { + "description": "configureImmediateEnableResult (automatic profile enabeling) PSMO result, see also SGP32Definitions.asn1", + "type": "string", + "enum": [ + "ok", + "insufficientMemory", + "commandError", + "undefinedError" + ] + } + }, + { + "addEimResult": { + "description": "addEimResult eCO result", + "type": "object", + "properties": { + "addEimResultCode": { + "description": "overall status code to inform about success or failure", + "type": "string", + "enum": [ + "ok", + "insufficientMemory", + "ciPKUnknown", + "invalidAssociationToken", + "counterValueOutOfRange", + "commandError", + "undefinedError", + "malformedResult" + ] + }, + "associationToken": { + "description": "resulting association token, see also GSMA SGP.32, section 2.11.1.1.1", + "type": "integer" + }, + "required": [ + "addEimResultCode" + ] + } + } + }, + { + "deleteEimResult": { + "description": "deleteEimResult eCO result, see also SGP32Definitions.asn1", + "type": "string", + "enum": [ + "ok", + "eimNotFound", + "lastEimDeleted", + "commandError", + "undefinedError" + ] + } + }, + { + "updateEimResult": { + "description": "updateEimResult eCO result, see also SGP32Definitions.asn1", + "type": "string", + "enum": [ + "ok", + "eimNotFound", + "ciPKUnknown", + "counterValueOutOfRange", + "commandError", + "undefinedError" + ] + } + }, + { + "listEimResult": { + "description": "listEimResult eCO result, see also SGP32Definitions.asn1", + "type": "object", + "properties": { + "finalResult": { + "description": "overall status code to inform about success or failure", + "type": "string", + "enum": [ + "successResult", + "errorResult" + ] + }, + "eimIdList": { + "description": "list containing the IDs of all configured eIM servers", + "type": "array", + "items": { + "eimId": { + "description": "eIM ID", + "type": "string" + }, + "eimIdType": { + "description": "specifies the type of the eIM ID", + "type": "string", + "enum": [ + "eimIdTypeOid", + "eimIdTypeFqdn", + "eimIdTypeProprietary" + ] + }, + "required": [ + "eimId" + ] + } + }, + "required": [ + "finalResult" + ] + } + } + }, + { + "rollbackResult": { + "description": "Status code of the execution of a profile rollback maneuver, see also GSMA SGP.32, section 2.11.1.13 and SGP32Definitions.asn1", + "type": "string", + "enum": [ + "ok", + "undefinedError" + ] + } + }, + { + "processingTerminated": { + "description": "Error code in case the eUICC has terminated the overall eUICC package execution, see also SGP32Definitions.asn1", + "type": "string", + "enum": [ + "resultSizeOverflow", + "unknownOrDamagedCommand", + "interruption", + "undefinedError" + ] + } + }, + { + "notificationResult": { + "description": "Status code to indicate that an otherSignedNotification has been received", + "type": "string", + "enum": [ + "otherSignedNotification" + ] + } + }, + { + "cancelSessionResult": { + "description": "Status code to indicate that the session has been canceled", + "type": "string", + "enum": [ + "ok", + "undefinedError" + ] + } + }, + { + "profileInstallationResult": { + "description": "Final result of a profile download, see also SGP32Definitions.asn1", + "type": "object", + "properties": { + "finalResult": { + "description": "overall status code to inform about succes or failure", + "enum": [ + "successResult", + "errorResult" + ] + }, + "iccid": { + "description": "ICCID of the profile. (ICCID in nibble-swapped raw format)", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "required": [ + "finalResult" + ] + } + } + }, + { + "euiccUpdateResult": { + "description": "contains the result of a parameter update in the euicc master data table", + "type": "string", + "enum": [ + "ok", + "badParamFormat", + "badParam" + ] + } + }, + { + "euiccDataResult": { + "description": "contains the result of an ipaEuiccDataRequest request (see also GSMA SGP.32, section 2.11.1.2)", + "type": "object", + "properties": { + "edrResult": { + "description": "status code of the execution of the ipaEuiccDataRequest", + "type": "string", + "enum": [ + "ok", + "incorrectTagList", + "euiccCiPKIdNotFound", + "undefinedError" + ] + }, + "euiccData": { + "description": "contains the resulting eUICC data objects", + "type": "object", + "properties": { + "defaultSmdpAddress": { + "description": "see GSMA SGP.32", + "type": "string" + }, + "euiccInfo1": { + "description": "ASN.1 encoded, see GSMA SGP.22", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "euiccInfo2": { + "description": "ASN.1 encoded, see GSMA SGP.22 and GSMA SGP.32", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "rootSmdsAddress": { + "description": "see GSMA SGP.32", + "type": "string" + }, + "associationToken": { + "description": "see GSMA SGP.32", + "type": "integer" + }, + "eumCertificate": { + "description": "ASN.1 encoded, see GSMA SGP.22", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "euiccCertificate": { + "description": "ASN.1 encoded, see GSMA SGP.22", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "ipaCapabilities": { + "description": "ASN.1 encoded, see GSMA SGP.32", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "deviceInfo": { + "description": "ASN.1 encoded, see GSMA SGP.32", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "notificationsList": { + "description": "ASN.1 encoded, see GSMA SGP.32", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + } + } + }, + "required": [ + "edrResult" + ] + } + } + }, + { + "procedureError": { + "description": "indicates a problem that lead to a termination of a procedure", + "type": "string", + "enum": [ + "initiateAuthenticationError", + "authenticateResponseError", + "authenticateClientError", + "downloadResponseError", + "getBoundProfilePackageError", + "cancelSessionResponseError", + "handleNotificationError", + "euiccSignatureInvalid", + "undefinedError", + "badPsmo", + "badEco", + "badEdr", + "badOrder", + "abortedOrder", + "stuckOrder", + "noshowOrder" + ] + } + } + ] + } + }, + "debuginfo": { + "description": "Erlang ETS encoded debug information string, for debugging/diagnosis only", + "type": "string", + "pattern": "^[0-9,A-F]{2,32}$" + }, + "required": [ + "status" + ] + } } - } }
-
dexter