Skip to content

Commit

Permalink
Merge pull request #79 from lornajane/minor-rewording
Browse files Browse the repository at this point in the history
Minor language fixes and simplification
  • Loading branch information
ralfhandl authored Oct 17, 2024
2 parents 58a3c2a + 961b337 commit 6b2c853
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Overlay Specification

The Overlay Specification defines a document format for information that will augment an existing OpenAPI description without entangling that information in the OpenAPI description's source doccument(s).
The Overlay Specification defines a document format for information that augments an existing OpenAPI description yet remains separate from the OpenAPI description's source document(s).

This specification is a community-driven, open specification within the [OpenAPI Initiative](https://www.openapis.org/), a Linux Foundation Collaborative Project.

Expand Down
4 changes: 2 additions & 2 deletions versions/1.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Abstract

The Overlay Specification defines a document format for information that will augment an existing [[OpenAPI]] description without entangling that information in the OpenAPI description's source doccument(s).
The Overlay Specification defines a document format for information that augments an existing [[OpenAPI]] description yet remains separate from the OpenAPI description's source document(s).

## Version 1.0.0

Expand All @@ -29,7 +29,7 @@ An Overlay is a JSON or YAML structure containing an ordered list of [Action Obj

The Overlay Specification is versioned using a `major`.`minor`.`patch` versioning scheme. The `major`.`minor` portion of the version string (for example 1.0) SHALL designate the Overlay feature set. `patch` versions address errors in, or provide clarifications to, this document, not the feature set. The patch version SHOULD NOT be considered by tooling, making no distinction between 1.0.0 and 1.0.1 for example.

**Note:** Version 1.0.0 of the Overlay Specification was released after spending some time in draft and a few early-adopting tool providers. Check with your tool provider for the details of what is supported in each tool.
**Note:** Version 1.0.0 of the Overlay Specification was released after spending some time in draft and being implemented by a few early-adopting tool providers. Check with your tool provider for the details of what is supported in each tool.

### Format

Expand Down

0 comments on commit 6b2c853

Please sign in to comment.