Endpoints Not In Service #608

Open
fargozhu opened this Issue Mar 23, 2016 · 4 comments

Projects

None yet

4 participants

@fargozhu

How to mark an endpoint out of service kind of thing?

@ePaul
ePaul commented Mar 23, 2016

Could you explain a bit more what you are trying to do?

I can see the need of noting deprecation for parts of an API (which could be a path or an operation, or even parameters), with a "planned end of service" date or similar.

@fargozhu

I have some services that are defined but not implemented that and I would like to have a flag that could inform the consumers of my API about it.

@shilka
shilka commented Apr 2, 2016

Maybe just return 501 http code for that endpoints?

@IvanGoncharov
Contributor

I think a better solution is to not include those endpoints in your OpenAPI spec.
Or you can provide two versions of your OpenAPI spec.

In any case I don't think these should go to core of OpenAPI spec since OpenAPI represent your API and not your workflow.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment