Feat/custom example label

[davidqqq]

All Submissions:

• Have you followed the guidelines in our Contributing document?
• Have you checked to ensure there aren't other open Pull Requests for the same update/change?
• Have you written unit tests?
• Have you written unit tests that cover the negative cases (i.e.: if bad data is submitted, does the library respond properly)?
• This PR is associated with an existing issue?

Closing issues

Put closes #XXXX (where XXXX is the issue number) in your comment to auto-close the issue that your PR fixes.
closes #970

If this is a new feature submission:

• Has the issue had a maintainer respond to the issue and clarify that the feature is something that aligns with the goals and philosophy of the project?

Potential Problems With The Approach

Current solution has one limitation where space cannot be used because it will disrupt json parsing.
@example error.customError or @example error.custom_error but not @example error.custom error.

We may use "_" for space.

Test plan

Test whether label following dot has correctly been included in example object output
Test whether no or empty label has correctly been included in example object output

[WoH]

Can you please add specs for OpenAPI 2? While that version does not support examples/example, it still should be clear what happens. In other cases, we add this as an x-example, I think it would be nice to add the first example without label and possibly warn about the lack of support.

[davidqqq]

I get what you mean in general but not sure about the "example without label". I used an example with label in test and emit a warning if exampleLabels is not empty which should indicate usage of example labels.

[WoH]

Suggested change

	* @example res. { "errorMessage":"No custom label", "errorCode": 40000 }
	* @example res. { "errorMessage":"No custom label", "errorCode": 40000 }
	* @example res "Unlabeled 1"
	* @example res "Another unlabeled one"

[WoH]

Just add one or two in the middle to make sure they don't throw off the array indices.

[WoH]

LGTM, thank you for your contribution! 🚀