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

Jump to bottom

Fix missing import statement in docs #46

Merged
merged 2 commits into from
May 1, 2024
Merged

Fix missing import statement in docs #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e09252f
Fix missing import statement in docs
kianmeng Apr 30, 2024
ae6a61f
Fix casing of import in configuration guide
aj-foster May 1, 2024
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
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![Hex.pm](https://img.shields.io/hexpm/v/oapi_generator)](https://hex.pm/packages/oapi_generator)
[![Documentation](https://img.shields.io/badge/hex-docs-blue)](https://hexdocs.pm/oapi_generator)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)

_A highly-configurable code generator that combines ergonomics with maintainability._

Expand Down Expand Up @@ -50,9 +50,13 @@ The real power of this library is in the available configuration.
Although the options are conceptually simple, they add up to a better user experience.

This project uses configuration profiles to allow multiple configurations with the same package.
To get started, create a profile called `default` in your configuration:
To get started, create a profile called `default` in your configuration file:

```elixir
# config/config.exs

import Config

config :oapi_generator, default: [
output: [
base_module: Example,
Expand Down
4 changes: 3 additions & 1 deletion guides/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ For example:
```elixir
# config/config.exs

import Config

config :oapi_generator,
my_profile: [
output: [
Expand Down Expand Up @@ -287,7 +289,7 @@ Remember that all configuration values must be contained within a profile.
This is an optional way to colocate generated operation modules in a single directory away from other parts of the client library.
Defaults to the same location as `output.location`.
See `OpenAPI.Renderer.Module.filename/2` for more information.

* `output.operation_use`: Module to include as a `use` statement at the top of every module containing operations.
Defaults to no used module.
See `OpenAPI.Renderer.Module.render_using/2` for more information.
Expand Down
Loading