Skip to content

Commit ba5d0bf

Browse files
Update 3.0.0.md
renamed to smartAPI specificiation. added introduction section to also point to smartAPI specific elements and to the website.
1 parent 00e1a05 commit ba5d0bf

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

versions/3.0.0.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
1-
# OpenAPI Specification
1+
# smartAPI Specification
22

3-
#### Version 3.0.0 [adapted for smartAPI]
3+
#### Version 3.0.0
44

55
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [BCP 14](https://tools.ietf.org/html/bcp14) [RFC2119](https://tools.ietf.org/html/rfc2119) [RFC8174](https://tools.ietf.org/html/rfc8174) when, and only when, they appear in all capitals, as shown here.
66

77
This document is licensed under [The Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html).
88

99
## Introduction
1010

11+
The smartAPI Specification (smartAPI) is a community-based extension of the OpenAPI specification. It features new metadata elements and value sets to promote the interoperability of web-based APIs. This document seamlessly integrates smartAPI specific extensions with the OpenAPI specification. However, a list of the smartAPI specific elements has been [automatically generated](smartapi-list.md). More information about the smartAPI initiative can be found on its [website](http://smart-api.info).
12+
1113
The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful 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.
1214

1315
An OpenAPI definition 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.

0 commit comments

Comments
 (0)