@spec operation(action :: atom(), spec :: Keyword.t()) :: any()

Defines an Operation spec for a controller action.

example

Example

operation :update,
  summary: "Update user",
  description: "Updates a user record from the given ID path parameter and request body parameters.",
  parameters: [
    id: [
      in: :path,
      description: "User ID",
      type: :integer,
      example: 1001
    ]
  ],
  request_body: {"User params", "application/json", UserParams},
  responses: [
    ok: {"User response", "application/json", UserResponse}
  ],
  security: [%{}, %{"petstore_auth" => ["write:pets", "read:pets"]}],
  tags: ["users"]

options

Options

These options correlate to the Operation fields specified in the Open API spec. One difference however, is that the fields defined in Open API use camelCase naming, while the fields used in ControllerSpecs use snake_case to match Elixir's convention.

• summary The operation summary

• parameters The endpoint's parameters. The syntax for parameters can take multiple forms:

  • The common form is a keyword list, where each key is the parameter name, and the value is a keyword list of options that correlate to the fields in an Open API Parameter Object. For example:

      parameters: [
        id: [
          in: :path,
          description: "User ID",
          type: :integer,
          example: 1001
        ]
      ]

  • A parameters list can also contain references to parameter schemas. There are two ways to do that:

    parameters: [
      "$ref": "#/components/parameters/user_id"
      # or
      %OpenApiSpex.Reference{"$ref": "#/components/parameters/user_id"}
    ]

• request_body The endpoint's request body. There are multiple ways to specify a request body:

  • A three or four-element tuple:

      request_body: {
        "User update request body",
        "application/json",
        UserUpdateRequest,
        required: true
      }

    The tuple consists of the following:
    1. The description
    2. The content-type
    3. An Open API schema. This can be a schema module that implements the OpenApiSpex.Schema behaviour, or an OpenApiSpex.Schema struct.
    4. A optional keyword list of options. There is only one option available, and that is required: boolean.

• responses The endpoint's responses, for each HTTP status code the endpoint may respond with. Multiple syntaxes are supported:

  • A common syntax is a keyword list, where each key is the textual name of an HTTP status code. For example:

      [
        ok: {"User response", "application/json", User},
        not_found: {"User not found", "application/json", NotFound}
      ]

    The list of names and their code mappings is defined in Plug.Conn.Status.code/1.

  • If a map is used, the keys can either be the same atom keys used in the keyword syntax (%{ok: ...}), or they can be integers representing the HTTP status code directly:

      responses: %{
        200 => {"User response", "application/json", User},
        404 => {"User not found", "application/json", NotFound}
      }

  • Each response can be a three-element tuple:

      responses: [
        ok: {"User response", "application/json", User}
        # Or
        ok: {"User response", "application/json", %OpenApiSpex.Schema{...}}
      ]

    This tuple consists of:

    1. A Description string
    2. A content-type string
    3. An Open API schema. This can be a schema module that implements the OpenApiSpex.Schema behaviour, or an OpenApiSpex.Schema struct.
    4. An optional Keyword list with the following optional key/values: a. example: an example string b. examples: a list of example strings c. headers: a Map with string keys defining the header name and an OpenApiSpex.Header struct as a value.

  • If the response represents an empty response, the definition value can be a single string representing the response description. For example:

      responses: [
        no_content: "Empty response"
      ]

  • A response can also be defined as an OpenApiSpex.RequestBody struct. In fact, all response body syntaxes resolve to this struct.

• Additional fields: There are other Operation fields that can be specified that are not described here. See OpenApiSpex.Operation for all the fields.

Define an Operation for a controller action.

See OpenApiSpex.ControllerSpecs for usage and examples.

@spec security([%{required(String.t()) => [String.t()]}]) :: any()

Defines security requirements shared by all operations defined in a controller.

See Security Requirement Object spec and OpenApiSpex.SecurityRequirement for more information.

@spec tags(tags :: [String.t()]) :: any()

Defines a list of tags that all operations in a controller will share.

example

Example

tags ["users"]

All operations defined in the controller will inherit the tags specified by this call. If an operation defines its own tags, the tags in this call will be appended to the operation's tags.