Packages

oaspec

0.4.0
0.68.0 0.67.0 0.66.0 0.65.0 0.64.0 0.63.0 0.62.0 0.61.0 0.60.0 0.59.0 0.58.1 0.58.0 0.57.0 0.56.0 0.55.0 0.54.0 0.53.0 0.52.0 0.51.0 0.50.0 0.49.0 0.48.0 0.47.0 0.46.0 0.45.0 0.44.0 0.43.0 0.42.0 0.41.0 0.40.0 0.39.0 0.38.0 0.37.0 0.36.0 0.35.0 0.34.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.0 0.25.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.6.3 0.6.1 0.6.0 0.5.0 0.4.0 0.3.0 0.1.3

Generate Gleam code from OpenAPI 3.x specifications

HexDocs

Current section

Files

Jump to
Readme
70 Versions
7 Dependencies
2 Dependants
Files
Activity
oaspec src oaspec@openapi@schema.erl
Raw

src/oaspec@openapi@schema.erl 

-module(oaspec@openapi@schema).

-compile([no_auto_import, nowarn_unused_vars, nowarn_unused_function, nowarn_nomatch, inline]).

-define(FILEPATH, "src/oaspec/openapi/schema.gleam").

-export([get_description/1, is_nullable/1]).

-export_type([schema_object/0, schema_ref/0, discriminator/0]).



-if(?OTP_RELEASE >= 27).

-define(MODULEDOC(Str), -moduledoc(Str)).

-define(DOC(Str), -doc(Str)).

-else.

-define(MODULEDOC(Str), -compile([])).

-define(DOC(Str), -compile([])).

-endif.



-type schema_object() :: {string_schema,

        gleam@option:option(binary()),

        gleam@option:option(binary()),

        list(binary()),

        gleam@option:option(integer()),

        gleam@option:option(integer()),

        gleam@option:option(binary()),

        boolean()} |

    {integer_schema,

        gleam@option:option(binary()),

        gleam@option:option(binary()),

        gleam@option:option(integer()),

        gleam@option:option(integer()),

        boolean()} |

    {number_schema,

        gleam@option:option(binary()),

        gleam@option:option(binary()),

        gleam@option:option(float()),

        gleam@option:option(float()),

        boolean()} |

    {boolean_schema, gleam@option:option(binary()), boolean()} |

    {array_schema,

        gleam@option:option(binary()),

        schema_ref(),

        gleam@option:option(integer()),

        gleam@option:option(integer()),

        boolean()} |

    {object_schema,

        gleam@option:option(binary()),

        gleam@dict:dict(binary(), schema_ref()),

        list(binary()),

        gleam@option:option(schema_ref()),

        boolean(),

        boolean()} |

    {all_of_schema, gleam@option:option(binary()), list(schema_ref())} |

    {one_of_schema,

        gleam@option:option(binary()),

        list(schema_ref()),

        gleam@option:option(discriminator())} |

    {any_of_schema, gleam@option:option(binary()), list(schema_ref())}.



-type schema_ref() :: {inline, schema_object()} | {reference, binary()}.



-type discriminator() :: {discriminator,

        binary(),

        gleam@dict:dict(binary(), binary())}.



-file("src/oaspec/openapi/schema.gleam", 67).

?DOC(" Get the description from any schema object.\n").

-spec get_description(schema_object()) -> gleam@option:option(binary()).

get_description(Schema) ->

    case Schema of

        {string_schema, Description, _, _, _, _, _, _} ->

            Description;



        {integer_schema, Description@1, _, _, _, _} ->

            Description@1;



        {number_schema, Description@2, _, _, _, _} ->

            Description@2;



        {boolean_schema, Description@3, _} ->

            Description@3;



        {array_schema, Description@4, _, _, _, _} ->

            Description@4;



        {object_schema, Description@5, _, _, _, _, _} ->

            Description@5;



        {all_of_schema, Description@6, _} ->

            Description@6;



        {one_of_schema, Description@7, _, _} ->

            Description@7;



        {any_of_schema, Description@8, _} ->

            Description@8

    end.



-file("src/oaspec/openapi/schema.gleam", 82).

?DOC(" Check if a schema is nullable.\n").

-spec is_nullable(schema_object()) -> boolean().

is_nullable(Schema) ->

    case Schema of

        {string_schema, _, _, _, _, _, _, Nullable} ->

            Nullable;



        {integer_schema, _, _, _, _, Nullable@1} ->

            Nullable@1;



        {number_schema, _, _, _, _, Nullable@2} ->

            Nullable@2;



        {boolean_schema, _, Nullable@3} ->

            Nullable@3;



        {array_schema, _, _, _, _, Nullable@4} ->

            Nullable@4;



        {object_schema, _, _, _, _, _, Nullable@5} ->

            Nullable@5;



        {all_of_schema, _, _} ->

            false;



        {one_of_schema, _, _, _} ->

            false;



        {any_of_schema, _, _} ->

            false

    end.