Skip to content

Commit f80a4cd

Browse files
committed
Add links to Introduction.
This adds some links to key sections that introduce major concepts that used to be in the introductory sections of the OAS. It insures that concepts like the difference between serialized and in-memory data, as well as the multi-document structure of OADs, are quickly noticed in a top-to-bottom reading (rare as those may be).
1 parent 445d76f commit f80a4cd

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/oas.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ This document is licensed under [The Apache License, Version 2.0](https://www.ap
88

99
## Introduction
1010

11-
The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to HTTP APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined, a consumer can understand and interact with the remote service with a minimal amount of implementation logic.
11+
The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to HTTP APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined, a consumer can understand and interact with the remote service by [parsing and serializing](#parsing-and-serializing) HTTP messages to and from a [data model](#data-types) with a minimal amount of implementation logic.
1212

13-
An OpenAPI Description can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases.
13+
An [OpenAPI Description](#openapi-description-structure) (OAD) can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases.
1414

1515
For examples of OpenAPI usage and additional documentation, please visit [[?OpenAPI-Learn]].
1616

0 commit comments

Comments
 (0)