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

Alternative Schema Proposal #1868

merged 5 commits into from Apr 25, 2019


3 participants
Copy link

commented Mar 15, 2019

This pull request proposes a directory structure for documenting enhancements to the OpenAPI specification. It is also populated with the markdown and supporting information for the Alternative Schema proposal.

cmheazel added some commits Mar 15, 2019

Merge pull request #1 from OAI/master
Re-sync with OpenAPI master
Alternative Schema Proposal
This commit contains the markup for the Alternative Schema Proposal and some supporting documention.  A directory structure is proposed so that the supporting data for a proposal is all in the same place.

This comment has been minimized.

Copy link

commented Mar 30, 2019

@cmheazel and TSC (@darrelmiller, @earth2marsh, @MikeRalphson, @webron, @whitlockjc ...anyone else?)

I've been asked to move the discussion about inline alternative schemas from #1532 to a new issue. I can do that. But we're still somewhere in the process of implementing the new scheme to organize draft proposals and related issues, and I would much prefer to create this new issue within that framework, alongside other issues extracted from that same discussion thread.

I think we really need this new process so we can:

  • Raise issues large and small, popular and unpopular, without taking up precious space in a single comment thread on a single GitHub issue for a draft proposal.
  • Let people vote with their feet by weighing in on those issues or ignoring them.
  • Let people open pull requests against a baseline draft proposal.
  • Let the TSC do its job of triaging and prioritizing these issues and PRs, so other community members needn't worry that a suggested change is going to derail an important new feature.

I think we are all on board with these goals. Thanks @cmheazel for taking this up. I'd like to help build on this.

TSC folks, have you had a chance to review this PR? It would be great to have it soon, especially as we're getting into a higher-intensity review phase on these 3.1 draft proposals.

One more thing that would be really helpful: Create a designated GitHub label for each draft proposal. Apply that label to relevant issues and PRs. Specify that label towards the top of the draft proposal, followed by two links:

  1. Open issues related to the draft proposal (filtered by label)
  2. Open pull requests related to the draft proposal (filtered by label)

cmheazel added some commits Apr 17, 2019

Swift patterned update
Updated the Alternative Schema proposal to follow the Apple SWIFT pattern.
Alternative Schema Cleanup
Additional Cleanup to the Alternative Schema Proposal

This comment has been minimized.

Copy link
Contributor Author

commented Apr 17, 2019

Updated to use the extension method for the Apple SWIFT-Evolution repository as discussed in the TSC meeting of 4/11/19

@darrelmiller darrelmiller added this to Review in progress in OpenAPI Spec Work Apr 18, 2019

April 18 update
Moved proposal document up one level.
Added numeric pre-fixes to proposal files.
Per TSC meeting of April 18, 2019

OpenAPI Spec Work automation moved this from Review in progress to Reviewer approved Apr 25, 2019

@darrelmiller darrelmiller merged commit 4375616 into OAI:master Apr 25, 2019

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed

OpenAPI Spec Work automation moved this from Reviewer approved to Done Apr 25, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.