XCribe v0.3.0 Xcribe.Swagger.Formatter View Source

Format a given Xcribe.Request according to OpenAPI Specification.

To know more about the specifications OpenAPI 3.0.3

Link to this section Summary

Functions

Return an Info Object builded from the api_info suplied by the Xcribe.Information.

Merge two lists of parameter object keep uniq names

Return a list of Parameter Objects from a given request.

Return a Path Item Object from the given request.

Return an empty struct of an OpenAPI Object.

Return a Request Body Object from given request

Return a Response Object from given request

Return an schema object for given attribute/parameter.

Return the security requirement for given request.

Return the Security Scheme Object for given request.

Return a Server Object builded from the api_info suplied by the Xcribe.Information.

Link to this section Functions

Return an Info Object builded from the api_info suplied by the Xcribe.Information.

Link to this function

merge_parameter_object_lists(base_list, new_list)

View Source

Merge two lists of parameter object keep uniq names

Link to this function

merge_path_item_objects(item_one, item_two, verb)

View Source

Merge two path item objects

Link to this function

parameter_objects_from_request(request)

View Source

Return a list of Parameter Objects from a given request.

Link to this function

path_item_object_from_request(request)

View Source

Return a Path Item Object from the given request.

Return an empty struct of an OpenAPI Object.

Link to this function

request_body_object_from_request(request)

View Source

Return a Request Body Object from given request

Link to this function

response_object_from_request(request)

View Source

Return a Response Object from given request

Link to this function

schema_object_for(param, opts \\ [])

View Source

Return an schema object for given attribute/parameter.

Options:

  • :title - Include the schema title, default is true.
  • :example - Include the schema example, default is false.
Link to this function

security_requirement_object_by_request(request)

View Source

Return the security requirement for given request.

Link to this function

security_scheme_object_from_request(request)

View Source

Return the Security Scheme Object for given request.

Return a Server Object builded from the api_info suplied by the Xcribe.Information.