Skip to content

Caliper 1.2: Clarification on the Structure of the Endpoint URL #568

@ColinSmythe

Description

@ColinSmythe

In the Caliper 1.2 spec there is no definition of the structure of the endpoint URL. This makes it impossible to create an OpenAPI file that supports interoperability. The Caliper certification suite requires data sent to an endpoint with '/message' as the leaf value.

In OpenAPI there are three parts to the endpoint URL:

  • Host-name - supplied by the endpoint provider
  • Base-path - undefined in Caliper (other 1EdTech specs have this defined and for caliber should be "/ims/caliper/1p2")
  • Path - undefined in Caliper

For Caliper the OpenAPI structure should be:

"servers" : [
   {
            "url" : "https://{hostName}{basePath}",
            "description" : "The pattern for the Server URL should be configured for the actual server location.",
            "variables" : {
                "hostName" : {
                    "description" : "Hostname for the server and MUST be set to the service provider (the 1EdTech URL is given as a default value).",
                    "default" : "www.1edtech.org"
                },
                "basePath" : {
                    "description" : "This is the base-path for the full URL and MUST be a part of the service endpoints.",
                    "enum" : ["/ims/caliper/v1p2"],
                    "default" : "/ims/caliper/v1p2"
                }
            }
  }
],

I suggest the Path value be set as "/message" for consistency with the cert suite.

Metadata

Metadata

Labels

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions