Commit 8e829a99 authored by Ross Little's avatar Ross Little

esmo metadata api

parent efe3c276
ESMO API
========
Summary
-------
The **ESMO API** is used to establish trust between ESMO nodes by using the
existing EWP infrastructure. The API provides an URL to an ESMO Gateway's ESMO
manifest which then in turn provides details about the gateway's functionalities.
Authentication and Encryption
-----------------------------
This version of this API uses [standard EWP Authentication and Security,
Version 2][sec-v2]. Server implementers choose which security methods they
support by declaring them in their Manifest API entry.
Request method
--------------
Requests MUST be made with either HTTP GET or HTTP POST method. Servers MUST
support both these methods.
Request parameters
------------------
None.
Response
--------
Servers MUST respond with a valid JSON document containing the ESMO manifest.
[sec-v2]: https://github.com/erasmus-without-paper/ewp-specs-sec-intro/tree/stable-v2
\ No newline at end of file
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:xml="http://www.w3.org/XML/1998/namespace"
xmlns:ewp="https://github.com/erasmus-without-paper/ewp-specs-architecture/blob/stable-v1/common-types.xsd"
xmlns:sec="https://github.com/erasmus-without-paper/ewp-specs-sec-intro/tree/stable-v2"
elementFormDefault="qualified"
targetNamespace="https://github.com/erasmus-without-paper/ewp-specs-api-echo/blob/stable-v2/manifest-entry.xsd"
xmlns="https://github.com/erasmus-without-paper/ewp-specs-api-echo/blob/stable-v2/manifest-entry.xsd"
>
<xs:import
schemaLocation="https://raw.githubusercontent.com/erasmus-without-paper/ewp-specs-architecture/stable-v1/common-types.xsd"
namespace="https://github.com/erasmus-without-paper/ewp-specs-architecture/blob/stable-v1/common-types.xsd"
/>
<xs:import
schemaLocation="https://raw.githubusercontent.com/erasmus-without-paper/ewp-specs-sec-intro/stable-v2/schema.xsd"
namespace="https://github.com/erasmus-without-paper/ewp-specs-sec-intro/tree/stable-v2"
/>
<xs:annotation>
<xs:documentation>
This schema is a part of the ESMO project, based on examples from the Erasmus Without Paper project.
</xs:documentation>
</xs:annotation>
<xs:element name="esmo">
<xs:annotation>
<xs:documentation>
If this element is present in EWP Host's manifest file, then the host states
that it implements the Echo API described here:
https://gitlab.atosresearch.eu/ari/ESMO_EWP/ewp-specs-api-esmo
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:complexContent>
<xs:extension base="ewp:ManifestApiEntryBase">
<xs:sequence>
<xs:element name="http-security" type="sec:HttpSecurityOptions" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>
Describes which security policies the server supports for this API. If not
given, then the server states that it supports the default set of security
policies (as described in the annotations in sec:HttpSecurityOptions).
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="url" type="ewp:HTTPS" minOccurs="1" maxOccurs="1">
<xs:annotation>
<xs:documentation>
An URL at which the ESMO API is being served, containing the ESMO manifest of the ESMO Gateway.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
</xs:schema>
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment