Struct Spec 

pub struct Spec {
    pub paths: HashMap<String, SpecPathItem>,
    pub components: Option<SpecComponents>,
}

ESI OpenAPI spec type.

Fields

paths: HashMap<String, SpecPathItem>

Map of URL path (e.g. /markets/{region_id}/orders) to its path item.

components: Option<SpecComponents>

Reusable parts of the spec; only the security schemes are read.

Implementations

impl Spec

pub fn oauth_scopes(&self) -> Vec<String>

Every OAuth2 scope the spec defines, sorted.

pub fn scope_string_for(&self, op_ids: &[&str]) -> String

The scopes needed to call every operation in op_ids, sorted and without duplicates, as a space-separated list ready for EsiBuilder::scope.

pub fn operation(&self, op_id: &str) -> Option<&SpecPathMethod>

Find an operation by its operationId.

pub fn required_scopes(&self, op_id: &str) -> Vec<String>

The scopes an operation needs (empty for public operations).

pub fn rate_limit_groups(&self) -> HashMap<String, SpecRateLimit>

The rate limit every operation declares, keyed by route group.

pub fn client_cache_ttl(&self, path: &str) -> Option<i64>

The x-client-cache-ttl of the GET operation whose path template matches path (with or without the leading slash, e.g. characters/95465499).

pub fn tombstone_ttl(&self, path: &str) -> Option<i64>

The x-tombstone-ttl of the GET operation whose path template matches path: how long ESI keeps answering for a deleted resource.

pub fn get_operation_for_path(&self, path: &str) -> Option<&SpecPathMethod>

The GET operation whose path template matches a concrete path such as characters/95465499. When several templates match, the one with the most literal segments wins (characters/affiliation over characters/{character_id}).

pub fn operation_index(&self) -> HashMap<String, String>

Build a map of operationId to URL path, with the path’s leading slash removed so it can be appended to the base API URL.

Trait Implementations

impl Clone for Spec

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Spec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Spec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Spec

impl PartialEq for Spec

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Spec

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Spec