Skip to content

Commit

Permalink
Wordsmithing pass
Browse files Browse the repository at this point in the history
  • Loading branch information
earth2marsh authored Oct 12, 2024
1 parent ed586d0 commit c3d930a
Showing 1 changed file with 5 additions and 8 deletions.
13 changes: 5 additions & 8 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 way of creating documents that contain information to be merged with an [[OpenAPI]] Description at some later point in time, for the purpose of updating the OpenAPI description with additional information.
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).

## Version 1.0.0

Expand All @@ -12,12 +12,10 @@ This document is licensed under [The Apache License, Version 2.0](https://www.ap

## Introduction

The Overlay Specification is an extension or companion to the [[OpenAPI]] specification.
The Overlay Specification is a companion to the [[OpenAPI]] Specification.
An Overlay describes a set of changes to be applied or "overlaid" onto an existing OpenAPI description.

The main purpose of the Overlay Specification is to provide a way to repeatably apply transformations to one or many OpenAPI descriptions.
Use cases include updating descriptions, adding metadata to be consumed by another tool, or removing certain elements from an API description before sharing it with partners.
An Overlay may be specific to a single OpenAPI description, or be designed to apply the same transform to any OpenAPI description.
The main purpose of the Overlay Specification is to provide a way to repeatably apply transformations to one or many OpenAPI descriptions. Use cases include updating descriptions, adding metadata to be consumed by another tool, or removing certain elements from an API description before sharing it with partners. An Overlay may be specific to a single OpenAPI description or be designed to apply the same transform to any OpenAPI description.

## Definitions

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

### Versions

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.
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 is being released after spending some time in draft, and after being adopted by 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 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 c3d930a

Please sign in to comment.