apistos-core 0.6.0

Actix-web OpenAPI v3.0 documentation generator
Documentation 
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

use crate::ApiComponent;
use apistos_models::paths::{Parameter, ParameterDefinition, ParameterIn, RequestBody};
use apistos_models::reference_or::ReferenceOr;
use schemars::schema::{InstanceType, Schema, SchemaObject, SingleOrVec, StringValidation};

impl ApiComponent for actix_session::Session {
  fn required() -> bool {
    true
  }

  fn child_schemas() -> Vec<(String, ReferenceOr<Schema>)> {
    vec![]
  }

  fn raw_schema() -> Option<ReferenceOr<Schema>> {
    Some(ReferenceOr::Object(Schema::Object(SchemaObject {
      instance_type: Some(SingleOrVec::Single(Box::new(InstanceType::String))),
      string: Some(Box::new(StringValidation::default())),
      ..Default::default()
    })))
  }

  fn schema() -> Option<(String, ReferenceOr<Schema>)> {
    None
  }

  fn request_body() -> Option<RequestBody> {
    None
  }

  fn parameters() -> Vec<Parameter> {
    vec![Parameter {
      name: "id".to_string(), // from default actix-session's CookieConfiguration
      _in: ParameterIn::Cookie,
      required: Some(true),
      definition: Self::raw_schema().map(ParameterDefinition::Schema),
      ..Default::default()
    }]
  }
}