Openapi fixes/enhancements #2102
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| servers: | ||
| - url: "%domjudge.baseurl%api" | ||
| description: API used at this contest | ||
| - url: https://domjudge.org/demoweb/api |
There was a problem hiding this comment.
This needs www. in front of it
| @@ -1,9 +1,43 @@ | |||
| nelmio_api_doc: | |||
| documentation: | |||
| tags: | |||
| - name: "Access" | |||
There was a problem hiding this comment.
The " are not needed here.
| @@ -1,9 +1,43 @@ | |||
| nelmio_api_doc: | |||
| documentation: | |||
| tags: | |||
There was a problem hiding this comment.
Would be better/cool if we can write some event listener or compiler pass to add this based on the actual tags in all files so we don't repeat ourself.
There was a problem hiding this comment.
Yes, It might be nice if this just comes with NelmioDoc. I've checked and this is actually only optional so I think we can take this out for now.
This endpoint is optional, but it makes sense to link so people can build a tool against the stable version (their instance) and the new API on demoweb.
There is the risk that people will now ask help about an instance in the wild but I suspect API users will be aware how this works.
Even the original commit seemed to not link to this.
It was recommended by Spectral and makes sense to expose this information also to systems interacting via the API.
vmcj
force-pushed
the
openapi_fixes_enhancements
branch
from
36ef202
to
24793be
Compare
nickygerritsen
approved these changes
Aug 1, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Found by spectral, for all the rules see:
https://docs.stoplight.io/docs/spectral/4dec24461f3af-open-api-rules
It also looks like our API is not OpenAPI3 complaint as we output the type
intinstead ofinteger. This should be a bug with how we generate the docs.I think reviewing should be done by checking which commits to cherry-pick.