Skip to content

Commit

Permalink
Merge pull request #35 from OAI/draft-version-minor-enrichment
Browse files Browse the repository at this point in the history
Fix ReadMe typos
  • Loading branch information
frankkilcommins authored Apr 4, 2023
2 parents fb47f39 + e7dde6c commit 11ebb26
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ Our aim is to propose an enhancement to the current OpenAPI, or accompanying spe

The creation of the SIG-Workflows group is inspired by the need to store sequences of calls in the context of specific tests, and in order to communicate the particulars of a complex set of security related calls such as when using OAuth2 and the Financial-grade API security profile of OpenID Connect.

However, such a definition will be useful for understanding how to implement any dependent sequence of functional calls for any user of Open API such as authorization calls, redirects and web hooks in order to achieve a certain technical or functional outcome.
However, such a definition will be useful for understanding how to implement any dependent sequence of functional calls for any user of an API such as authorization calls, redirects and web hooks in order to achieve a certain technical or functional outcome.

Optimally, it should be possible to articulate these workflows in a human and machine readable manner, thus improving the capability of API specifications to tell the story of the API in a manner that can improved the consuming developer experience and understanding of an API specified using OpenAPI.
Optimally, it should be possible to articulate these workflows in a human and machine readable manner, thus improving the capability of API specifications to tell the story of the API in a manner that can improve the consuming developer experience and understanding of an API specified using OpenAPI (or other supported specifications).

**Key focus areas**
- **Context** - How to define quickly and easily what goal and key functions of an API are, and how to represent that in a specification
Expand Down
6 changes: 3 additions & 3 deletions versions/1.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This document is licensed under [The Apache License, Version 2.0](https://www.ap

Being able to express specific sequences of calls and articulate the dependencies between them to achieve a particular goal is desirable in the context of an API definition(s). The aim of the Workflows Specification, is to provide a mechanism that can define sequences of calls and their dependencies to be expressed in the context of delivering a particular outcome or set of outcomes when dealing with API definitions (such as OpenAPI documents).

The Workflows Specification can articulate these workflows in a human and machine readable manner, thus improving the capability of API specifications to tell the story of the API in a manner that can improved the consuming developer experience.
The Workflows Specification can articulate these workflows in a human and machine-readable manner, thus improving the capability of API specifications to tell the story of the API in a manner that can improved the consuming developer experience.

## Table of Contents

Expand Down Expand Up @@ -217,7 +217,7 @@ version: 1.0.1

#### Source Object

Described a source document (such as an OpenAPI document) that will be referenced by one or more workflows described within a Workflows Document.
Describes a source document (such as an OpenAPI document) that will be referenced by one or more workflows described within a Workflows document.

An object storing a map between named document keys and location URLs to the source documents (such as an OpenAPI document) this workflow SHALL apply to. Each source location `string` MUST be in the form of a [URL](https://url.spec.whatwg.org/). MAY be defined using relative references as defined by [RFC3986](https://spec.openapis.org/oas/latest.html#bib-RFC3986).

Expand All @@ -241,7 +241,7 @@ type: openapi

#### Workflow Object

Describes the steps to be taken across one or more APIs to achieve an objective. The workflow object MAY define variables needed in order to execute workflow steps, where the defined steps represent a call to an API operation or another workflow, and a set of outputs.
Describes the steps to be taken across one or more APIs to achieve an objective. The workflow object MAY define inputs needed in order to execute workflow steps, where the defined steps represent a call to an API operation or another workflow, and a set of outputs.

##### Fixed Fields

Expand Down

0 comments on commit 11ebb26

Please sign in to comment.