You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@directory.apache.org by "torbaAnton (via GitHub)" <gi...@apache.org> on 2024/01/24 13:49:35 UTC
[I] Swagger doc [directory-scimple]
torbaAnton opened a new issue, #506:
URL: https://github.com/apache/directory-scimple/issues/506
Hi guys, this is more like a question, how do you generate swagger documentation?
I see endpoints are covered by swagger, but whenever I try to request any known swagger API I get:
{
"detail": "HTTP 404 Not Found",
"status": "404",
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error"
]
}
Is there any URL that I can call by default to get swagger?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@directory.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@directory.apache.org
For additional commands, e-mail: dev-help@directory.apache.org
Re: [I] Swagger doc [directory-scimple]
Posted by "bdemers (via GitHub)" <gi...@apache.org>.
bdemers commented on issue #506:
URL: https://github.com/apache/directory-scimple/issues/506#issuecomment-1908369751
The SCIM endpoints are annotated, but you would need to configure your endpoint to serve the Swagger/OpenAPI metadata.
Honestly, I'm not sure there is a lot of value in SCIMple providing this functionality at all (e.g. the annotations) the Swagger/OpenAPI response for the server are essentially fixed, all of the annotations could be replaced with a static OpenAPI file based on the SCIM rfcs.
I'd love feedback on this topic (it's not something I'd want to just remove if folks find it useful)
If it is useful, it may be possible to improve the support (possibly generate the spec from the SCIM metadata and remove the need for the Swagger annotations)
Another reason for NOT supporting the Swagger endpoint out of the box, is that it would require a dependency on the Servlet Runtime (currently only Jakarta EE Core is required).
All that said, adding the swagger endpoint to your SCIMple application should only require a couple extra steps:
https://github.com/swagger-api/swagger-core/wiki/Swagger-Core-Jersey-2.X-Project-Setup-1.5
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@directory.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@directory.apache.org
For additional commands, e-mail: dev-help@directory.apache.org
Re: [I] Swagger doc [directory-scimple]
Posted by "bdemers (via GitHub)" <gi...@apache.org>.
bdemers closed issue #506: Swagger doc
URL: https://github.com/apache/directory-scimple/issues/506
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@directory.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@directory.apache.org
For additional commands, e-mail: dev-help@directory.apache.org