Nelmioapidocbundle: Documentation of Areas

[andydandy80]

How to describe areas, whats the correct way?
You wrote it was fixed in #1307 and #1404, but in current version its not working, why removed code?

Thats not working for me (v3.4.0):

nelmio_api_doc:
    areas:
        default:
            path_patterns: [ ^/api/route1 ]
            documentation:
                description: "This is the documentation for route1"
            with_annotation: true
        test:
            path_patterns: [ ^/api/route2 ]
            documentation:
                description: "This is the documentation for route2"
            with_annotation: true

[GuilhemN]

What do you mean by "not working"?
Is it not what you expected? Or are you getting an error?

If you want to update the description of a route, this is not the correct configuration, you should use annotations in your controller.

[andydandy80]

I have to areas: default and test. I expect that the description "This is the..." will be displayed on top of page, but it isnt. I want to describe the areas with two different descriptions.

[GuilhemN]

In fact, the syntax mentionned in #1307 is not correct, you should use:

nelmio_api_doc:
    areas:
        default:
            path_patterns: [ ^/api/route1 ]
            documentation:
                info:
                    description: "This is the documentation for route1"

I updated the description of #1307 to avoid any future confusion, thanks :)

[andydandy80]

Thats it, now working, thanks a lot for your help!