Oaskit.Spec.Server (oaskit v0.16.1)

Copy Markdown View Source

Representation of the Server Object in OpenAPI Specification.

Summary

Functions

from_config(otp_app, endpoint_module)

Returns an URL based on the :url configuration of the endpoint.

json_schema()

Returns the JSON schema for this specification entity.

Functions

from_config(otp_app, endpoint_module)

Returns an URL based on the :url configuration of the endpoint.

If not all the parts of the URL are configured the following defaults are used:

  • :port defaults to 443.
  • :scheme defaults to "https".
  • :path defaults to "/".

json_schema()

Returns the JSON schema for this specification entity.