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

roadId ist nicht auf Autobahnen beschränkt #31

Merged
merged 4 commits into from
May 26, 2023

Conversation

mvglasow
Copy link

Siehe #19.

Signed-off-by: mvglasow <michael -at- vonglasow.com>
@t-huyeng
Copy link
Member

t-huyeng commented May 21, 2023

LGTM,
can you maybe add an Example for other RoadId than a Autobahn?

Maybe like this:

    examples:       # Multiple examples
      autobahn:         
        value: A1    
        summary: Autobahnnummer
      bundesstrasse: 
        value: ?
        summary: Bundesstrasse

If bundesstrasse is working.

Thanks!

Update:
This is not allowed for schemas.

Signed-off-by: mvglasow <michael -at- vonglasow.com>
@mvglasow
Copy link
Author

Done, hope I did it correctly

Signed-off-by: mvglasow <michael -at- vonglasow.com>
@mvglasow
Copy link
Author

I also added a sentence for non-standard roadId formats (e.g. S rather than St for Staatsstraßen).

@t-huyeng
Copy link
Member

Sorry, my advice was wrong. I looked at the documentation again:
Note that multiple example values per property or schema are not supported ....

And so the OpenAPI Check also fails:

 354:16 error oas3-schema Property "examples" is not expected to be here. components.schemas.RoadId.examples

Would you be so kind as to change this back to a single simple example. I think the description is enough for now.

This reverts commit fa53159.

# Conflicts:
#	openapi.yaml
@t-huyeng t-huyeng merged commit e3c62d8 into bundesAPI:main May 26, 2023
@t-huyeng
Copy link
Member

Thanks @mvglasow !

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

Successfully merging this pull request may close these issues.

2 participants