Services.Local.Media.SMB.json

{
  "paths": {
    "Services.Local.Media.SMB.Get": {
      "operationId": "Services.Local.Media.SMB.Get",
      "summary": "Retrieves the status and configuration parameters in regards to the SMB Server.",
      "tags": [
        "Services.Local.Media.SMB"
      ],
      "responses": {
        "ARGUMENT_DATA_TYPE_MISMATCH": {
          "description": "A call attempt to a valid object and procedure was performed, however an argument value was provided with an unexpected data type, therefore it was not possible to process the request.",
          "raised_by": "Micro-Service",
          "content": {
            "application/json": {
              "example": "{\"Header\": {\"Name\": \"ARGUMENT_DATA_TYPE_MISMATCH\", \"Description\": \"Unable to process the request because the value provided on the \\u2018Enabled\\u2019 field is not a valid Boolean.\"}}",
              "schema": {
                "$ref": "#/components/schemas/Response"
              }
            }
          }
        },
        "ARGUMENT_NOT_FOUND": {
          "description": "A call to a valid object and procedure was performed, however an unrecognized argument was provided, therefore it was not possible to process the request.",
          "raised_by": "Micro-Service",
          "content": {
            "application/json": {
              "example": "{\"Header\": {\"Name\": \"ARGUMENT_NOT_FOUND\", \"Description\": \"Unable to process the request because 'Enabled' is not a valid argument.\"}}",
              "schema": {
                "$ref": "#/components/schemas/Response"
              }
            }
          }
        },
        "ARGUMENT_REQUIRED_MISSING": {
          "description": "A call to a valid object and procedure was performed, however a required argument was not provided, therefore it was not possible to process the request.",
          "raised_by": "Micro-Service",
          "content": {
            "application/json": {
              "example": "{\"Header\": {\"Name\": \"ARGUMENT_REQUIRED_MISSING\", \"Description\": \"Unable to process the request because the 'Enabled' field was not provided.\"}}",
              "schema": {
                "$ref": "#/components/schemas/Response"
              }
            }
          }
        },
        "ARGUMENT_VALUE_NOT_SUPPORTED": {
          "description": "A call attempt to a valid object and procedure was performed, however a non-supported argument value was provided, therefore it was not possible to process the request.",
          "raised_by": "Micro-Service",
          "content": {
            "application/json": {
              "example": "{\"Header\": {\"Name\": \"ARGUMENT_VALUE_NOT_SUPPORTED\", \"Description\": \"Unable to process the request because \\u2018Red\\u2019 is not a value supported by the \\u2018Colour\\u2019 field.\"}}",
              "schema": {
                "$ref": "#/components/schemas/Response"
              }
            }
          }
        },
        "METHOD_NOT_FOUND": {
          "description": "A call to a valid object but non-existing procedure was performed, therefore it was not possible to process the request.",
          "raised_by": "IPC Bus",
          "content": {
            "application/json": {
              "example": "{\"Header\": {\"Name\": \"METHOD_NOT_FOUND\", \"Description\": \"Unable to process the request because 'Set' is not a valid method\"}}",
              "schema": {
                "$ref": "#/components/schemas/Response"
              }
            }
          }
        },
        "OBJECT_NOT_FOUND": {
          "description": "A call to a non-existing object was performed, therefore it was not possible to process the request.",
          "raised_by": "IPC Bus",
          "content": {
            "application/json": {
              "example": "{\"Header\": {\"Name\": \"OBJECT_NOT_FOUND\", \"Description\": \"Unable to process the request because 'prpl.Dummy' is not a valid object.\"}}",
              "schema": {
                "$ref": "#/components/schemas/Response"
              }
            }
          }
        },
        "OK": {
          "description": "A well-formed request to an authorized resource was performed, and the receiver was able to compute the response within the allowed time-window.",
          "raised_by": "Micro-Service",
          "content": {
            "application/json": {
              "example": "{\"Header\": {\"Name\": \"OK\"}, \"Body\": {\"Enabled\": true, \"Status\": \"Active\", \"Version\": \"3.1.1\", \"Hostname\": \"prplFoundation HGW\"}}",
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Response"
                  },
                  {
                    "properties": {
                      "Body": {
                        "properties": {
                          "Enabled": {
                            "type": "Boolean",
                            "description": "SMB Server administrative status.",
                            "format": "-",
                            "default_value": "-",
                            "possible_values": "\"true\" or \"false\"",
                            "enum": [
                              "true",
                              "false"
                            ],
                            "readOnly": true
                          },
                          "Hostname": {
                            "type": "String",
                            "description": "SMB Server hostname.",
                            "format": "-",
                            "default_value": "-",
                            "possible_values": "any string with length from 1 up to 64 chars",
                            "readOnly": true
                          },
                          "Status": {
                            "type": "String",
                            "description": "SMB Server operational status.",
                            "format": "-",
                            "default_value": "-",
                            "possible_values": "\"Active\", \"Disabled\", \"Error\"",
                            "readOnly": true
                          },
                          "Version": {
                            "type": "String",
                            "description": "SMB Server version or release number.",
                            "format": "-",
                            "default_value": "-",
                            "possible_values": "\"1.0\", \"2.0\", \"3.0\", \"3.0.2\", \"3.1.1\"",
                            "readOnly": true
                          }
                        },
                        "required": []
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "OPERATION_ALREADY_IN_PROGRESS": {
          "description": "A well-formed request to an authorized resource was performed, however the operation could not be completed, as the required resource was temporarily locked by a different request in progress.",
          "raised_by": "Micro-Service",
          "content": {
            "application/json": {
              "example": "{\"Header\": {\"Name\": \"OPERATION_ALREADY_IN_PROGRESS\", \"Description\": \"Unable to process the request because there is a duplicate operation currently in progress.\"}}",
              "schema": {
                "$ref": "#/components/schemas/Response"
              }
            }
          }
        },
        "OPERATION_ERROR": {
          "description": "A well-formed request was performed however, it was not possible to process the request due to an unknown internal error.",
          "raised_by": "Micro-Service",
          "content": {
            "application/json": {
              "example": "{\"Header\": {\"Name\": \"OPERATION_ERROR\", \"Description\": \"Unable to process the request because there is a configuration error.\"}}",
              "schema": {
                "$ref": "#/components/schemas/Response"
              }
            }
          }
        },
        "OPERATION_ILLEGAL": {
          "description": "A well-formed request to an authorized resource was performed, however the operation could not be completed, as it was invoked in the incorrect system state or order.",
          "raised_by": "Micro-Service",
          "content": {
            "application/json": {
              "example": "{\"Header\": {\"Name\": \"OPERATION_ILLEGAL\", \"Description\": \"Unable to process the request because the 'Stop' procedure can only be invoked after the 'Start' method has been called.\"}}",
              "schema": {
                "$ref": "#/components/schemas/Response"
              }
            }
          }
        },
        "OPERATION_PERMISSION_DENIED": {
          "description": "A well-formed request was performed however, the client did not meet the security conditions required to access the protected resource, therefore it is not possible to process the request.",
          "raised_by": "IPC Bus / Remote Protocol Adapter",
          "content": {
            "application/json": {
              "example": "{\"Header\": {\"Name\": \"OPERATION_PERMISSION_DENIED\", \"Description\": \"Unable to process the request because user \\u2018Admin\\u2019 does not have access privileges to invoke the \\u2018Set\\u2019 procedure on object \\u2018prpl.Dummy\\u2019.\"}}",
              "schema": {
                "$ref": "#/components/schemas/Response"
              }
            }
          }
        },
        "OPERATION_TIMEOUT": {
          "description": "A well-formed request was performed however, it was not possible to process the response within the allowed time-frame.",
          "raised_by": "Micro-Service",
          "content": {
            "application/json": {
              "example": "{\"Header\": {\"Name\": \"OPERATION_TIMEOUT\", \"Description\": \"The operation has been aborted because the service did not respond within the expected 5 seconds time-frame.\"}}",
              "schema": {
                "$ref": "#/components/schemas/Response"
              }
            }
          }
        }
      }
    },
    "Services.Local.Media.SMB.Set": {
      "operationId": "Services.Local.Media.SMB.Set",
      "summary": "Modifies the status and configuration parameters of the SMB Server.",
      "tags": [
        "Services.Local.Media.SMB"
      ],
      "responses": {
        "ARGUMENT_DATA_TYPE_MISMATCH": {
          "description": "A call attempt to a valid object and procedure was performed, however an argument value was provided with an unexpected data type, therefore it was not possible to process the request.",
          "raised_by": "Micro-Service",
          "content": {
            "application/json": {
              "example": "{\"Header\": {\"Name\": \"ARGUMENT_DATA_TYPE_MISMATCH\", \"Description\": \"Unable to process the request because the value provided on the \\u2018Enabled\\u2019 field is not a valid Boolean.\"}}",
              "schema": {
                "$ref": "#/components/schemas/Response"
              }
            }
          }
        },
        "ARGUMENT_NOT_FOUND": {
          "description": "A call to a valid object and procedure was performed, however an unrecognized argument was provided, therefore it was not possible to process the request.",
          "raised_by": "Micro-Service",
          "content": {
            "application/json": {
              "example": "{\"Header\": {\"Name\": \"ARGUMENT_NOT_FOUND\", \"Description\": \"Unable to process the request because 'Enabled' is not a valid argument.\"}}",
              "schema": {
                "$ref": "#/components/schemas/Response"
              }
            }
          }
        },
        "ARGUMENT_REQUIRED_MISSING": {
          "description": "A call to a valid object and procedure was performed, however a required argument was not provided, therefore it was not possible to process the request.",
          "raised_by": "Micro-Service",
          "content": {
            "application/json": {
              "example": "{\"Header\": {\"Name\": \"ARGUMENT_REQUIRED_MISSING\", \"Description\": \"Unable to process the request because the 'Enabled' field was not provided.\"}}",
              "schema": {
                "$ref": "#/components/schemas/Response"
              }
            }
          }
        },
        "ARGUMENT_VALUE_NOT_SUPPORTED": {
          "description": "A call attempt to a valid object and procedure was performed, however a non-supported argument value was provided, therefore it was not possible to process the request.",
          "raised_by": "Micro-Service",
          "content": {
            "application/json": {
              "example": "{\"Header\": {\"Name\": \"ARGUMENT_VALUE_NOT_SUPPORTED\", \"Description\": \"Unable to process the request because \\u2018Red\\u2019 is not a value supported by the \\u2018Colour\\u2019 field.\"}}",
              "schema": {
                "$ref": "#/components/schemas/Response"
              }
            }
          }
        },
        "METHOD_NOT_FOUND": {
          "description": "A call to a valid object but non-existing procedure was performed, therefore it was not possible to process the request.",
          "raised_by": "IPC Bus",
          "content": {
            "application/json": {
              "example": "{\"Header\": {\"Name\": \"METHOD_NOT_FOUND\", \"Description\": \"Unable to process the request because 'Set' is not a valid method\"}}",
              "schema": {
                "$ref": "#/components/schemas/Response"
              }
            }
          }
        },
        "OBJECT_NOT_FOUND": {
          "description": "A call to a non-existing object was performed, therefore it was not possible to process the request.",
          "raised_by": "IPC Bus",
          "content": {
            "application/json": {
              "example": "{\"Header\": {\"Name\": \"OBJECT_NOT_FOUND\", \"Description\": \"Unable to process the request because 'prpl.Dummy' is not a valid object.\"}}",
              "schema": {
                "$ref": "#/components/schemas/Response"
              }
            }
          }
        },
        "OK": {
          "description": "A well-formed request to an authorized resource was performed, and the receiver was able to compute the response within the allowed time-window.",
          "raised_by": "Micro-Service",
          "content": {
            "application/json": {
              "example": "{\"Header\": {\"Name\": \"OK\"}}",
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Response"
                  },
                  {
                    "properties": {
                      "Body": {
                        "properties": {},
                        "required": []
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "OPERATION_ALREADY_IN_PROGRESS": {
          "description": "A well-formed request to an authorized resource was performed, however the operation could not be completed, as the required resource was temporarily locked by a different request in progress.",
          "raised_by": "Micro-Service",
          "content": {
            "application/json": {
              "example": "{\"Header\": {\"Name\": \"OPERATION_ALREADY_IN_PROGRESS\", \"Description\": \"Unable to process the request because there is a duplicate operation currently in progress.\"}}",
              "schema": {
                "$ref": "#/components/schemas/Response"
              }
            }
          }
        },
        "OPERATION_ERROR": {
          "description": "A well-formed request was performed however, it was not possible to process the request due to an unknown internal error.",
          "raised_by": "Micro-Service",
          "content": {
            "application/json": {
              "example": "{\"Header\": {\"Name\": \"OPERATION_ERROR\", \"Description\": \"Unable to process the request because there is a configuration error.\"}}",
              "schema": {
                "$ref": "#/components/schemas/Response"
              }
            }
          }
        },
        "OPERATION_ILLEGAL": {
          "description": "A well-formed request to an authorized resource was performed, however the operation could not be completed, as it was invoked in the incorrect system state or order.",
          "raised_by": "Micro-Service",
          "content": {
            "application/json": {
              "example": "{\"Header\": {\"Name\": \"OPERATION_ILLEGAL\", \"Description\": \"Unable to process the request because the 'Stop' procedure can only be invoked after the 'Start' method has been called.\"}}",
              "schema": {
                "$ref": "#/components/schemas/Response"
              }
            }
          }
        },
        "OPERATION_PERMISSION_DENIED": {
          "description": "A well-formed request was performed however, the client did not meet the security conditions required to access the protected resource, therefore it is not possible to process the request.",
          "raised_by": "IPC Bus / Remote Protocol Adapter",
          "content": {
            "application/json": {
              "example": "{\"Header\": {\"Name\": \"OPERATION_PERMISSION_DENIED\", \"Description\": \"Unable to process the request because user \\u2018Admin\\u2019 does not have access privileges to invoke the \\u2018Set\\u2019 procedure on object \\u2018prpl.Dummy\\u2019.\"}}",
              "schema": {
                "$ref": "#/components/schemas/Response"
              }
            }
          }
        },
        "OPERATION_TIMEOUT": {
          "description": "A well-formed request was performed however, it was not possible to process the response within the allowed time-frame.",
          "raised_by": "Micro-Service",
          "content": {
            "application/json": {
              "example": "{\"Header\": {\"Name\": \"OPERATION_TIMEOUT\", \"Description\": \"The operation has been aborted because the service did not respond within the expected 5 seconds time-frame.\"}}",
              "schema": {
                "$ref": "#/components/schemas/Response"
              }
            }
          }
        }
      },
      "requestBody": {
        "content": {
          "application/json": {
            "schema": {
              "properties": {
                "Enabled": {
                  "type": "Boolean",
                  "description": "SMB Server administrative status.",
                  "format": "-",
                  "default_value": "the existing configuration",
                  "possible_values": "\"true\" or \"false\"",
                  "enum": [
                    "true",
                    "false"
                  ],
                  "writeOnly": true
                },
                "Hostname": {
                  "type": "String",
                  "description": "SMB Server hostname.",
                  "format": "-",
                  "default_value": "the existing configuration",
                  "possible_values": "any string with length from 1 up to 64 chars",
                  "writeOnly": true
                },
                "Version": {
                  "type": "String",
                  "description": "SMB Server version or release number.",
                  "format": "-",
                  "default_value": "the existing configuration",
                  "possible_values": "\"1.0\", \"2.0\", \"3.0\", \"3.0.2\", \"3.1.1\"",
                  "writeOnly": true
                }
              },
              "required": []
            },
            "example": "{\"Enabled\": true, \"Version\": \"3.1.1\", \"Hostname\": \"prplFoundation HGW\"}"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ListRequest": {
        "properties": {
          "Limit": {
            "description": "How many items to return at one time (max 200)",
            "required": false,
            "type": "integer",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 20,
              "example": {
                "Limit": 10
              }
            }
          },
          "Offset": {
            "description": "Which object index to start with",
            "required": false,
            "type": "integer",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 0,
              "example": {
                "Offset": 45
              }
            }
          }
        }
      },
      "Response": {
        "type": "object",
        "description": "schema for a responses to object methods",
        "oneOf": [
          {
            "properties": {
              "Header": {
                "type": "object",
                "description": "Header object specifying the name of the response type and providing a detailed description in case of an error",
                "properties": {
                  "Name": {
                    "type": "string",
                    "description": "name of the response type",
                    "enum": [
                      "OK"
                    ]
                  }
                },
                "required": [
                  "Name"
                ],
                "additionalProperties": false
              },
              "Body": {
                "type": "object"
              }
            },
            "additionalProperties": false
          },
          {
            "properties": {
              "Header": {
                "type": "object",
                "description": "Header object specifying the name of the response type and providing a detailed description in case of an error",
                "properties": {
                  "Name": {
                    "type": "string",
                    "description": "name of the response type",
                    "enum": [
                      "OK",
                      "OPERATION_ALREADY_IN_PROGRESS",
                      "ARGUMENT_NOT_FOUND",
                      "ARGUMENT_DATA_TYPE_MISMATCH",
                      "OPERATION_TIMEOUT",
                      "METHOD_NOT_FOUND",
                      "OPERATION_ILLEGAL",
                      "OBJECT_NOT_FOUND",
                      "ARGUMENT_REQUIRED_MISSING",
                      "OPERATION_ERROR",
                      "ARGUMENT_VALUE_NOT_SUPPORTED",
                      "OPERATION_PERMISSION_DENIED"
                    ]
                  },
                  "Description": {
                    "type": "string",
                    "description": "A more detailed error message. NOTE: only filled in when the operation returns an error."
                  }
                },
                "required": [
                  "Name",
                  "Description"
                ],
                "additionalProperties": false
              }
            },
            "additionalProperties": false
          }
        ]
      },
      "Services.Local.Media.SMB": {
        "description": "Services.Local.Media.SMB Object",
        "id": "Services.Local.Media.SMB",
        "type": "object",
        "required": [],
        "properties": {
          "Enabled": {
            "type": "Boolean",
            "description": "SMB Server administrative status.",
            "format": "-",
            "default_value": "-",
            "possible_values": "\"true\" or \"false\"",
            "enum": [
              "true",
              "false"
            ]
          },
          "Hostname": {
            "type": "String",
            "description": "SMB Server hostname.",
            "format": "-",
            "default_value": "-",
            "possible_values": "any string with length from 1 up to 64 chars"
          },
          "Status": {
            "type": "String",
            "description": "SMB Server operational status.",
            "format": "-",
            "default_value": "-",
            "possible_values": "\"Active\", \"Disabled\", \"Error\"",
            "readOnly": true
          },
          "Version": {
            "type": "String",
            "description": "SMB Server version or release number.",
            "format": "-",
            "default_value": "-",
            "possible_values": "\"1.0\", \"2.0\", \"3.0\", \"3.0.2\", \"3.1.1\""
          }
        },
        "events": {
          "SERVICES_LOCAL_MEDIA_SMB_DISABLED": {
            "content": {
              "application/json": {
                "example": ""
              }
            },
            "description": "Raised when an existing SMB Server is disabled. This does not necessarily result from a configuration change of the administrative state field, but rather when it becomes operationally inactive or fails to start.",
            "code": 1
          },
          "SERVICES_LOCAL_MEDIA_SMB_ENABLED": {
            "content": {
              "application/json": {
                "example": ""
              }
            },
            "description": "Raised when an existing SMB Server is enabled. This does not necessarily result from a configuration change of the administrative state field, but rather when it becomes operationally active.",
            "code": 2
          },
          "SERVICES_LOCAL_MEDIA_SMB_MODIFIED": {
            "content": {
              "application/json": {
                "example": ""
              }
            },
            "description": "Raised when an existing SMB Server is modified. Updating the administrative state should also result in the event being triggered.",
            "code": 3
          },
          "SERVICES_LOCAL_MEDIA_SMB_SHARE_ADDED": {
            "content": {
              "application/json": {
                "example": "{\"ShareId\": \"Services.Local.Media.SMB.Shares.0\"}"
              }
            },
            "description": "Raised when a new SMB Server Network Share is added.",
            "code": 4
          },
          "SERVICES_LOCAL_MEDIA_SMB_SHARE_DELETED": {
            "content": {
              "application/json": {
                "example": "{\"ShareId\": \"Services.Local.Media.SMB.Shares.0\"}"
              }
            },
            "description": "Raised when an existing SMB Server Network Share is deleted.",
            "code": 5
          },
          "SERVICES_LOCAL_MEDIA_SMB_SHARE_MODIFIED": {
            "content": {
              "application/json": {
                "example": "{\"ShareId\": \"Services.Local.Media.SMB.Shares.0\"}"
              }
            },
            "description": "Raised when an existing SMB Server Network Share configuration is modified. Updating the administrative state should also result in the event being triggered.",
            "code": 6
          }
        },
        "example": {},
        "layer": 2
      }
    }
  }
}