The api_doc from ianluites

api_doc's People

Contributors

Stargazers

Watchers

api_doc's Issues

Same route with different verb is not shown

If you are using this library with phoenix and you have the same route with a different verb is not shown on the resultant html. For example:

get("/api/v1/projects", ProjectsController, :index)
post("/api/v1/projects", ProjectsController, :create)

After executing Documentation.format() i get:

paths:
 /api/v1/projects:
    get:
      operationId: GET projects
      summary: Returns the projects
      description: |
        Returns the list of projects

      tags:
        - Projects
      parameters:
      responses:
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        '200':
          description: List of projects
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ProjectsResponse"
      security:
 /api/v1/projects:
    post:
      operationId: Create project
      summary: Creates a project
      description: |
        Creates a project

      tags:
        - Projects
      parameters:
        - name: project_name
          in: body
          description: Project name
          required: true
          schema:
            type: string
      responses:
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        '200':
          description: Project created
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ProjectResponse"
      security:

I guess maybe is because the route appears twice and is taking the latest one and it should only appear once with two methods underneath?

This is also reproducible using the resources helper on the router.

Recommend Projects