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.

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

HTML documentation in the notes param of a Swagger operation #16

Closed
pietervogelaar opened this issue Sep 13, 2012 · 2 comments
Closed
Assignees

Comments

@pietervogelaar
Copy link
Contributor

Swagger UI support HTML in the description since about a month which is great! I would very like to document a POST operation to explain what the posted object must look like. For example like below, but swagger-php can't parse this correctly:

     * @SwaggerOperation(
     *     nickname="postContact",
     *     value="Creates a new contact",
     *     notes="Crates a new contact. Example:
     * <pre>
     * {
     *     "Id": 1,
     *     "Initials": "A.C.F.",
     *     "FirstName": "Anna",
     *     "Insertion": "",
     *     "LastName": "Foo",
     *     "DateOfBirth": "1940-01-19NET00:00:00"
     *     "Gender": "F"
     * }
     * </pre>",
     *     responseClass="Contact",
     *     multiValueResponse=false
     * )
@zircote
Copy link
Owner

zircote commented Nov 5, 2012

SHA: 64a30eee17663fd6077f003ff86f83a7d5e43dc8

@zircote
Copy link
Owner

zircote commented Nov 26, 2012

Current master 0.4.0 now supports this, thank you for your patience and feedback.

@zircote zircote closed this as completed Nov 26, 2012
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants