Skip to content

Draft proposal for experimental field #2386

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

Merged
merged 18 commits into from
Apr 28, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
add proposal file from template
  • Loading branch information
davidjgoss committed Oct 28, 2020
commit 1072487a57d12c0629316bf69697916cc52926a5
44 changes: 44 additions & 0 deletions proposals/005_Beta.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Beta/Experimental marker


## Metadata

|Tag |Value |
|---- | ---------------- |
|Proposal |[NNNN](https://github.com/OAI/OpenAPI-Specification/tree/master/proposals/{directory_or_file_name})|
|Authors|[Author 1](https://github.com/{author1}), [Author 2](https://github.com/{author2})|
|Review Manager |TBD |
|Status |Proposal, Draft, Promoted, or Abandoned|
|Implementations |[Click Here](https://github.com/OAI/OpenAPI-Specification/tree/master/proposals/{NNNN}/implementations.md)|
|Issues |[{issueid}](https://github.com/OAI/OpenAPI-Specification/issues/{Issueid})|
|Previous Revisions |[{revid}](https://github.com/OAI/OpenAPI-Specification/pull/{revid}) |

## Change Log

|Date |Responsible Party |Description |
|---- | ---------------- | ---------- |

## Introduction

A short description of what the feature is. Try to keep it to a single-paragraph "elevator pitch" so the reader understands what problem this proposal is addressing.

## Motivation

Describe the problems that this proposal seeks to address. If the problem is that some common pattern is currently hard to express, show how one can currently get a similar effect and describe its drawbacks. If it's completely new functionality that cannot be emulated, motivate why this new functionality would help OpenAPI developers create better code.

## Proposed solution

Describe your solution to the problem. Provide examples and describe how they work. Show how your solution is better than current workarounds: is it cleaner, safer, or more efficient?

## Detailed design

Describe the design of the solution in detail. This should include an exact description of the changes to the contents of the OpenAPI specification. That description should include a extract of each section of the OpenAPI specification which is impacted by the proposal with all proposed modifications applied. These extracts may be provided through additional files which are identified and described in this section.

## Backwards compatibility

Proposals should be structure so that they can be handled by existing OAS compliant software. Any potential issues should be identified and discussed.

## Alternatives considered

Describe alternative approaches to addressing the same problem, and why you chose this approach instead.