Tidy up openapi schema (#3498)

* Tidy up OpenAPI schema

* Remove `items` from object schema
pull/3464/head r2023.11.08-236
hq1 3 years ago committed by GitHub
parent 058d8cc6c9
commit 38b1834b3f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -11,6 +11,6 @@ defmodule PlausibleWeb.Plugins.API.Schemas.Error do
""",
type: :object,
required: [:detail],
properties: %{detail: %OpenApiSpex.Schema{type: :string}}
properties: %{detail: %Schema{type: :string}}
})
end

@ -14,15 +14,12 @@ defmodule PlausibleWeb.Plugins.API.Schemas.Goal.ListResponse do
items: Schemas.Goal,
type: :array
},
meta: %OpenApiSpex.Schema{
meta: %Schema{
required: [:pagination],
properties: %{
pagination: %OpenApiSpex.Reference{
"$ref": "#/components/schemas/PaginationMetadata"
}
},
type: :object,
items: Schemas.PaginationMetadata
properties: %{
pagination: Schemas.PaginationMetadata
}
}
}
})

@ -8,6 +8,6 @@ defmodule PlausibleWeb.Plugins.API.Schemas.Link do
title: "Link",
type: :object,
required: [:url],
properties: %{url: %OpenApiSpex.Schema{type: :string}}
properties: %{url: %Schema{type: :string}}
})
end

@ -13,7 +13,7 @@ defmodule PlausibleWeb.Plugins.API.Schemas.NotFound do
title: "NotFoundError",
required: [:errors],
properties: %{
errors: %OpenApiSpex.Schema{
errors: %Schema{
items: Schemas.Error,
type: :array
}

@ -10,13 +10,12 @@ defmodule PlausibleWeb.Plugins.API.Schemas.PaginationMetadata do
type: :object,
required: [:has_next_page, :has_prev_page],
properties: %{
has_next_page: %OpenApiSpex.Schema{type: :boolean},
has_prev_page: %OpenApiSpex.Schema{type: :boolean},
links: %OpenApiSpex.Schema{
items: Schemas.Link,
has_next_page: %Schema{type: :boolean},
has_prev_page: %Schema{type: :boolean},
links: %Schema{
properties: %{
next: %OpenApiSpex.Reference{"$ref": "#/components/schemas/Link"},
prev: %OpenApiSpex.Reference{"$ref": "#/components/schemas/Link"}
next: Schemas.Link,
prev: Schemas.Link
},
type: :object
}

@ -14,7 +14,7 @@ defmodule PlausibleWeb.Plugins.API.Schemas.PaymentRequired do
title: "PaymentRequiredError",
required: [:errors],
properties: %{
errors: %OpenApiSpex.Schema{
errors: %Schema{
items: Schemas.Error,
type: :array
}

@ -14,15 +14,12 @@ defmodule PlausibleWeb.Plugins.API.Schemas.SharedLink.ListResponse do
items: Schemas.SharedLink,
type: :array
},
meta: %OpenApiSpex.Schema{
meta: %Schema{
required: [:pagination],
properties: %{
pagination: %OpenApiSpex.Reference{
"$ref": "#/components/schemas/PaginationMetadata"
}
},
type: :object,
items: Schemas.PaginationMetadata
properties: %{
pagination: Schemas.PaginationMetadata
}
}
}
})

@ -13,7 +13,7 @@ defmodule PlausibleWeb.Plugins.API.Schemas.Unauthorized do
title: "UnauthorizedError",
required: [:errors],
properties: %{
errors: %OpenApiSpex.Schema{
errors: %Schema{
items: Schemas.Error,
type: :array
}

@ -14,7 +14,7 @@ defmodule PlausibleWeb.Plugins.API.Schemas.UnprocessableEntity do
title: "UnprocessableEntityError",
required: [:errors],
properties: %{
errors: %OpenApiSpex.Schema{
errors: %Schema{
items: Schemas.Error,
type: :array
}

Loading…
Cancel
Save