Add Support for multiple examples in application/json

[guiluko]

Add support for examples Object in OpenAPI.

#248

[yedpodtrzitko]

Hi,
thanks for the PR. Can you please add a test to see how does this manifest? Thanks.

[guiluko]

Hi, thanks for the PR. Can you please add a test to see how does this manifest? Thanks.

Hi thanks for the recommandation, I added some.

For the context, I did this PR to close this issue #248

[yedpodtrzitko]

this suggestion might be rendered useless by another comment below, but:

Suggested change

	def has_examples(schema_exta: dict) -> bool:
	for _, v in schema_exta.items():
	def has_examples(schema_extra: dict) -> bool:
	for v in schema_extra.values():

[yedpodtrzitko]

nitpick: .keys() is superfluous since it's the default place where in is checking

Suggested change

	if isinstance(v, dict) and "value" in v.keys():
	if isinstance(v, dict) and "value" in v:

[yedpodtrzitko]

This code checks if there's ANY dictionary with a key named value in schema_extra, and based on that it assumes that ALL items in schema_extra are examples. Which might not be necessarily the case:

class Data(BaseModel):
    value: bool

    class Config:
        schema_extra = {
            "examples": {
                "example1": {"value": {"key1": "value1", "key2": "value2"}},
                "example2": {"value": {"key1": "value1", "key2": "value2"}},
            },
            "properties": {"value": {"this is not an example": True}},
        }

I think it could be better to nest all examples into schema_extra.examples, check presence of examples, and then then take just that as examples:

if schema_extra and "examples" in schema_extra:
    content_items["application/json"]["examples"] = schema_extra["examples"]

What do you think?

[yedpodtrzitko]

if possible, can you use the fixture snapshot_json and compare the whole payload instead of cherrypicked parts? See example here:

spectree/tests/test_plugin.py

Lines 25 to 34 in 0508b70

	def test_plugin_spec(api, snapshot_json):
	models = {
	get_model_key(model=m): get_model_schema(model=m)
	for m in (Query, JSON, Resp, Cookies, Headers)
	}
	for name, schema in models.items():
	schema.pop("definitions", None)
	assert api.spec["components"]["schemas"][name] == schema
	assert api.spec == snapshot_json(name="full_spec")

to generate the snapshot, add the following parameter: pytest --snapshot-update