Storage

info

Please note that this content is under development and is not ready for implementation. This status message will be updated as content development progresses.

Description

The Storage object is responsible for managing the configuration of the Storage service which is used to store and manage Verifiable Credentials within the Mock App system.

Example

{
  "storage": {
    "url": "http://localhost:3334/v1/documents",
    "params": {
      "resultPath": "/uri",
      "bucket": "verifiable-credentials"
    },
    "options": {
      "method": "POST",
      "headers": {
        "Content-Type": "application/json"
      }
    }
  }
}

Definitions

Property	Required	Description	Type
url	Yes	URL for the storage service	String
params	Yes	Parameters for the storage service	Params
options	Yes	Options for the storage service request	Options

params

The params object contains specific parameters for the storage service.

Property	Required	Description	Type
bucket	Yes	The name of the storage bucket	String
resultPath	Yes	The path where the result (e.g., URI) will be stored in the response	String

options

The options object defines the HTTP request options for interacting with the storage service.

Property	Required	Description	Type
method	Yes	The HTTP method for the request (e.g., POST)	String
headers	Yes	The headers to be sent with the request	Headers

headers

Property	Required	Description	Type
Content-Type	Yes	The MIME type of the request body	String