Struct Discovery 

pub struct Discovery {
    pub enabled: bool,
    pub api_version: String,
    pub end_point: String,
    pub provider: Option<String>,
    pub resource_types: Vec<Resource>,
    pub capabilities: Option<Vec<Capability>>,
    pub criteria: Option<Vec<Criterium>>,
    pub public_key: Option<PublicKey>,
    pub invite_accept_dialog: Option<String>,
}

This is the response payload of the discovery endpoint, representing the properties and capabilities offered by this server.

Fields

enabled: bool

Whether the OCM service is enabled at this endpoint

api_version: String

The OCM API version this endpoint supports

end_point: String

The URI of the OCM API available at this endpoint Example: https://my-cloud-storage.org/ocm

provider: Option<String>

A friendly branding name of this endpoint Example: MyCloudStorage

resource_types: Vec<Resource>

A list of all supported resource types with their access protocols. Each resource type is identified by its name: the list MUST NOT contain more than one resource type object per given name.

capabilities: Option<Vec<Capability>>

The optional capabilities exposed at this endpoint according to the present specifications.

use ocm_types::discovery::Capability;

let capabilities = vec![
    Capability::WebdavUri,
    Capability::ProtocolObject,
];
let json: Vec<Capability> = serde_json::from_str(r#"[
    "webdav-uri",
    "protocol-object"
]"#).unwrap();
assert_eq!(capabilities, json);

criteria: Option<Vec<Criterium>>

The criteria for accepting a Share Creation Notification. As all Receiving Servers should require the use of TLS in API calls, it is not necessary to expose that as a criterium.

example:

• allowlist
• invite

use ocm_types::discovery::Criterium;

let criteria = vec![
    Criterium::Allowlist,
    Criterium::Invite,
];
let json: Vec<Criterium> = serde_json::from_str(r#"[
    "allowlist",
    "invite"
]"#).unwrap();
assert_eq!(criteria, json);

public_key: Option<PublicKey>

The signatory used to sign outgoing request to confirm its origin. The signatory is optional but it MUST contain id and publicKeyPem.

invite_accept_dialog: Option<String>

Optional URL path of a web page where a user can accept an invite, when query parameters “token” and “providerDomain” are provided. Implementations that offer the invites capability SHOULD provide this URL as well in order to enhance the UX of the Invite Flow. If for example “/index.php/apps/sciencemesh/accept” is specified here then a Where-Are-You-From page could redirect the end-user to /index.php/apps/sciencemesh/accept?token=zi5kooKu3ivohr9a&providerDomain=example.com.

Trait Implementations

impl Clone for Discovery

fn clone(&self) -> Discovery

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Discovery

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Discovery

fn default() -> Discovery

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Discovery

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Discovery

fn eq(&self, other: &Discovery) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Discovery

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Discovery

impl StructuralPartialEq for Discovery