Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename Swagger processor to OpenAPI #58

Merged
merged 1 commit into from
Jun 3, 2019
Merged

Rename Swagger processor to OpenAPI #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/rolodex.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ defmodule Rolodex do
annotations on your API route action functions for the Rolodex parser to handle
- **Generic serialization** - The `Rolodex.Processor` behaviour encapsulates
the basic steps needed to serialize API metadata into documentation. Rolodex
ships with a valid Swagger JSON processor (see: `Rolodex.Processors.Swagger`)
ships with a valid OpenAPI (Swagger) JSON processor (see: `Rolodex.Processors.OpenAPI`)
- **Generic writing** - The `Rolodex.Writer` behaviour encapsulates the basic
steps needed to write out formatted docs. Rolodex ships with a file writer (
see: `Rolodex.Writers.FileWriter`)
Expand Down
4 changes: 2 additions & 2 deletions lib/rolodex/config.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ defmodule Rolodex.RenderGroupConfig do
out routes from your documentation. Filters are invoked in
`Rolodex.Route.matches_filter?/2`. If the match returns true, the route will be
filtered out of the docs result for this render group.
- `processor` (default: `Rolodex.Processors.Swagger`) - Module implementing
- `processor` (default: `Rolodex.Processors.OpenAPI`) - Module implementing
the `Rolodex.Processor` behaviour
- `writer` (default: `Rolodex.Writers.FileWriter`) - Module implementing the
`Rolodex.Writer` behaviour to be used to write out the docs
Expand All @@ -224,7 +224,7 @@ defmodule Rolodex.RenderGroupConfig do
"""

defstruct filters: :none,
processor: Rolodex.Processors.Swagger,
processor: Rolodex.Processors.OpenAPI,
writer: Rolodex.Writers.FileWriter,
writer_opts: [file_name: "api.json"]

Expand Down
2 changes: 1 addition & 1 deletion lib/rolodex/processors/swagger.ex → lib/rolodex/processors/open_api.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
defmodule Rolodex.Processors.Swagger do
defmodule Rolodex.Processors.OpenAPI do
@behaviour Rolodex.Processor
@open_api_version "3.0.0"

Expand Down
14 changes: 7 additions & 7 deletions test/rolodex/processors/swagger_test.exs → test/rolodex/processors/open_api_test.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
defmodule Rolodex.Processors.SwaggerTest do
defmodule Rolodex.Processors.OpenAPITest do
use ExUnit.Case

alias Rolodex.{
Expand All @@ -10,7 +10,7 @@ defmodule Rolodex.Processors.SwaggerTest do
Headers
}

alias Rolodex.Processors.Swagger
alias Rolodex.Processors.OpenAPI

alias Rolodex.Mocks.{
ErrorResponse,
Expand Down Expand Up @@ -94,7 +94,7 @@ defmodule Rolodex.Processors.SwaggerTest do
}
]

result = Swagger.process(config, routes, refs) |> Jason.decode!()
result = OpenAPI.process(config, routes, refs) |> Jason.decode!()

assert result == %{
"openapi" => "3.0.0",
Expand Down Expand Up @@ -253,7 +253,7 @@ defmodule Rolodex.Processors.SwaggerTest do
test "It returns a map of top-level metadata" do
config = Config.new(FullConfig)

headers = Swagger.process_headers(config)
headers = OpenAPI.process_headers(config)

assert headers == %{
openapi: "3.0.0",
Expand Down Expand Up @@ -301,7 +301,7 @@ defmodule Rolodex.Processors.SwaggerTest do
}
]

processed = Swagger.process_routes(routes, Config.new(BasicConfig))
processed = OpenAPI.process_routes(routes, Config.new(BasicConfig))

assert processed == %{
"/foo" => %{
Expand Down Expand Up @@ -390,7 +390,7 @@ defmodule Rolodex.Processors.SwaggerTest do
}
]

assert Swagger.process_routes(routes, Config.new(BasicConfig)) == %{
assert OpenAPI.process_routes(routes, Config.new(BasicConfig)) == %{
"/foo" => %{
get: %{
operationId: "foo",
Expand Down Expand Up @@ -452,7 +452,7 @@ defmodule Rolodex.Processors.SwaggerTest do
}
}

assert Swagger.process_refs(refs, Config.new(FullConfig)) == %{
assert OpenAPI.process_refs(refs, Config.new(FullConfig)) == %{
requestBodies: %{
"UserRequestBody" => %{
content: %{
Expand Down