Skip to content

Update README.md #4

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 1 commit into from
Jul 12, 2023
Merged
Changes from all commits
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
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,35 +27,35 @@ Here you will find the information you need about the OpenAPI Specification, sim

## Current Version - 3.0

The current version of the OpenAPI specification is [OpenAPI Specification 3.0](versions/3.0.0.md).
The current version of the OpenAPI specification is [OpenAPI Specification 3.0](https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md).

### Previous Versions

This repository also contains the [OpenAPI Specification 2.0](versions/2.0), which is identical to the Swagger 2.0 specification before it was renamed to “OpenAPI Specification”,
This repository also contains the [OpenAPI Specification 2.0](https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/versions/2.0), which is identical to the Swagger 2.0 specification before it was renamed to “OpenAPI Specification”,
as well as the Swagger 1.2 and Swagger 2.0 specifications.

Each folder in this repository, such as [examples](examples) and [schemas](schemas), should contain folders pertaining to the current and previous versions of the specification.
Each folder in this repository, such as [examples](https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/examples) and [schemas](https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/schemas), should contain folders pertaining to the current and previous versions of the specification.

## See It in Action

If you just want to see it work, check out the [list of current examples](examples/v3.0).
If you just want to see it work, check out the [list of current examples](https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/examples/v3.0).

## Tools and Libraries

Looking to see how you can create your own OpenAPI definition, present it, or otherwise use it? Check out the growing
[list of 3.0 Implementations](IMPLEMENTATIONS.md).
[list of 3.0 Implementations](https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/IMPLEMENTATIONS.md).

## Participation

The current process for development of the OpenAPI Specification is described in
[Development Guidelines](DEVELOPMENT.md).
[Development Guidelines](https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/DEVELOPMENT.md).
Development of the next version of the OpenAPI Specification is guided by the [Technical Developer Community](https://www.openapis.org/participate/how-to-contribute/governance#TDC). This group of committers bring their API expertise, incorporate feedback from the community, and expand the group of committers as appropriate. All development activity on the future specification will be performed as features and merged into this branch. Upon release of the future specification, this branch will be merged to master.

The Open API Initiative encourages participation from individuals and companies alike.
If you want to participate in the evolution of the OpenAPI Specification, consider taking the following actions:

* Review the [current specification](versions/3.0.0.md). The human-readable markdown file _is the source of truth_ for the specification.
* Review the [development](DEVELOPMENT.md) process so you understand how the spec is evolving.
* Review the [current specification](https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md). The human-readable markdown file _is the source of truth_ for the specification.
* Review the [development](https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/DEVELOPMENT.md) process so you understand how the spec is evolving.
* Check the [issues](https://github.com/OAI/OpenAPI-Specification/issues) and [pull requests](https://github.com/OAI/OpenAPI-Specification/pulls) to see if someone has already documented your idea or feedback on the specification. You can follow an existing conversation by adding a comment to the existing issue or PR.
* Create an issue to describe a new concern. If possible, propose a solution.

Expand Down