X Tutup
The Wayback Machine - https://web.archive.org/web/20200929154150/https://github.com/OAI/OpenAPI-Specification/pull/2329
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

Removed required constraint on responses object #2329

Open
wants to merge 1 commit into
base: v3.1.0-dev
from

Conversation

@darrelmiller
Copy link
Member

darrelmiller commented Aug 28, 2020

This change would allow the following to be a valid OpenAPI description

openapi: 3.1.0
info:
   title: An api with currently undefined responses
   version: 1.0.0
paths:
   /: 
     get: {}

This is useful for doing initial design work on an API without having to define what request and response payloads should contain. Currently to be a valid document it is required to include a responses object, which must contain at least one response code which then must contain a description.

@darrelmiller darrelmiller requested review from MikeRalphson and webron Aug 28, 2020
@darrelmiller darrelmiller added this to the v3.1.0-final milestone Aug 28, 2020
@darrelmiller
Copy link
Member Author

darrelmiller commented Sep 3, 2020

No objections yet. Leaving this open for folks to stew on it for a few days.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants
You can’t perform that action at this time.
X Tutup