stamd 0.1.0

Webservice for working with stand-off annotations on text (STAM)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

use utoipa::ToSchema;

#[derive(ToSchema)]
/// An object in STAM JSON. See <https://github.com/annotation/stam/blob/master/README.md#stam-json> . The schema is a rough skeleton and not complete!
#[allow(dead_code)]
pub struct StamJson {
    #[schema(rename = "@id")]
    /// The identifier
    id: Option<String>,

    #[schema(rename = "@type")]
    /// The type of this object (any STAM object)
    r#type: String,
}

#[derive(ToSchema)]
/// An API error in JSON
#[allow(dead_code)]
pub struct ApiError {
    #[schema(rename = "@type")]
    /// The type of error, this will be "ApiError"
    r#type: String,

    /// The error name (MissingArgument, InternalError, NotFound, CustomNotFound, NotAcceptable, PermissionDenied)
    name: String,

    /// The error message
    message: String,
}

#[derive(ToSchema)]
/// A STAM error in JSON
#[allow(dead_code)]
pub struct StamError {
    #[schema(rename = "@type")]
    /// The type of error, this will be "StamError"
    r#type: String,

    /// The error message
    message: String,
}

#[derive(ToSchema)]
/// A web annotation in JSON-LD, this schema is a rough skeleton and not complete! See <https://www.w3.org/TR/annotation-model/>
#[allow(dead_code)]
pub struct WebAnnotation {
    #[schema(rename = "@context")]
    /// JSON-LD context
    context: String,

    #[schema(rename = "@type")]
    /// The type of the RDF resource.
    r#type: String,

    #[schema(rename = "@id")]
    /// The identifier
    id: Option<String>,
}