Skip to content

Commit 43039d0

Browse files
ralfhandlralfhandl
committed
Security
1 parent b4926b4 commit 43039d0

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

‎versions/3.0.4.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -277,8 +277,8 @@ This object MAY be extended with [Specification Extensions](#specification-exten
277277

278278
```json
279279
{
280-
"title": "Sample Pet Store App",
281-
"description": "This is a sample server for a pet store.",
280+
"title": "Example Pet Store App",
281+
"description": "This is an example server for a pet store.",
282282
"termsOfService": "https://example.com/terms/",
283283
"contact": {
284284
"name": "API Support",
@@ -294,8 +294,8 @@ This object MAY be extended with [Specification Extensions](#specification-exten
294294
```
295295

296296
```yaml
297-
title: Sample Pet Store App
298-
description: This is a sample server for a pet store.
297+
title: Example Pet Store App
298+
description: This is an example server for a pet store.
299299
termsOfService: https://example.com/terms/
300300
contact:
301301
name: API Support
@@ -2716,7 +2716,7 @@ The [XML Object](#xml-object) contains additional information about the availabl
27162716

27172717
##### Schema Object Examples
27182718

2719-
###### Primitive Sample
2719+
###### Primitive Example
27202720

27212721
```json
27222722
{
@@ -3545,7 +3545,7 @@ animals:
35453545

35463546
Defines a security scheme that can be used by the operations.
35473547

3548-
Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in [RFC6749](https://tools.ietf.org/html/rfc6749), and [[OpenID-Connect-Core]].
3548+
Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter, or as a query parameter), OAuth2's common flows (implicit, password, client credentials, and authorization code) as defined in [RFC6749](https://tools.ietf.org/html/rfc6749), and [[OpenID-Connect-Core]].
35493549
Please note that as of 2020, the implicit flow is about to be deprecated by [OAuth 2.0 Security Best Current Practice](https://tools.ietf.org/html/draft-ietf-oauth-security-topics). Recommended for most use cases is Authorization Code Grant flow with PKCE.
35503550

35513551
##### Fixed Fields
@@ -3555,17 +3555,17 @@ Please note that as of 2020, the implicit flow is about to be deprecated by [OAu
35553555
| <a name="security-scheme-type"></a>type | `string` | Any | **REQUIRED**. The type of the security scheme. Valid values are `"apiKey"`, `"http"`, `"oauth2"`, `"openIdConnect"`. |
35563556
| <a name="security-scheme-description"></a>description | `string` | Any | A description for security scheme. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. |
35573557
| <a name="security-scheme-name"></a>name | `string` | `apiKey` | **REQUIRED**. The name of the header, query or cookie parameter to be used. |
3558-
| <a name="security-scheme-in"></a>in | `string` | `apiKey` | **REQUIRED**. The location of the API key. Valid values are `"query"`, `"header"` or `"cookie"`. |
3558+
| <a name="security-scheme-in"></a>in | `string` | `apiKey` | **REQUIRED**. The location of the API key. Valid values are `"query"`, `"header"`, or `"cookie"`. |
35593559
| <a name="security-scheme-scheme"></a>scheme | `string` | `http` | **REQUIRED**. The name of the HTTP Authentication scheme to be used in the [Authorization header as defined in RFC7235](https://tools.ietf.org/html/rfc7235#section-5.1). The values used SHOULD be registered in the [IANA Authentication Scheme registry](https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml). The value is case-insensitive, as defined in [RFC7235](https://datatracker.ietf.org/doc/html/rfc7235#section-2.1). |
35603560
| <a name="security-scheme-bearer-format"></a>bearerFormat | `string` | `http` (`"bearer"`) | A hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes. |
35613561
| <a name="security-scheme-flows"></a>flows | [OAuth Flows Object](#oauth-flows-object) | `oauth2` | **REQUIRED**. An object containing configuration information for the flow types supported. |
35623562
| <a name="security-scheme-open-id-connect-url"></a>openIdConnectUrl | `string` | `openIdConnect` | **REQUIRED**. [Well-known URL](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig) to discover the [[OpenID-Connect-Discovery]] [provider metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). |
35633563

35643564
This object MAY be extended with [Specification Extensions](#specification-extensions).
35653565

3566-
##### Security Scheme Object Example
3566+
##### Security Scheme Object Examples
35673567

3568-
###### Basic Authentication Sample
3568+
###### Basic Authentication Example
35693569

35703570
```json
35713571
{
@@ -3579,7 +3579,7 @@ type: http
35793579
scheme: basic
35803580
```
35813581

3582-
###### API Key Sample
3582+
###### API Key Example
35833583

35843584
```json
35853585
{
@@ -3595,7 +3595,7 @@ name: api-key
35953595
in: header
35963596
```
35973597

3598-
###### JWT Bearer Sample
3598+
###### JWT Bearer Example
35993599

36003600
```json
36013601
{
@@ -3611,7 +3611,7 @@ scheme: bearer
36113611
bearerFormat: JWT
36123612
```
36133613

3614-
###### Implicit OAuth2 Sample
3614+
###### Implicit OAuth2 Example
36153615

36163616
```json
36173617
{
@@ -3668,7 +3668,7 @@ Configuration details for a supported OAuth Flow
36683668

36693669
This object MAY be extended with [Specification Extensions](#specification-extensions).
36703670

3671-
##### OAuth Flow Object Examples
3671+
##### OAuth Flow Object Example
36723672

36733673
```JSON
36743674
{
@@ -3780,7 +3780,7 @@ security:
37803780

37813781
See [Resolving Implicit Connections](#resolving-implicit-connections) for more information.
37823782

3783-
First, our entry document is where parsing begins. It defines the `MySecurity` security scheme to be JWT-based, and it defines a Path Item as a reference to a component in another document:
3783+
First, our [entry document](#openapi-description-structure) is where parsing begins. It defines the `MySecurity` security scheme to be JWT-based, and it defines a Path Item as a reference to a component in another document:
37843784

37853785
```HTTP
37863786
GET /api/description/openapi HTTP/1.1
@@ -3876,11 +3876,11 @@ In the `other` document, the referenced path item has a Security Requirement for
38763876

38773877
While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.
38783878

3879-
The extensions properties are implemented as patterned fields that are always prefixed by `"x-"`.
3879+
The extensions properties are implemented as patterned fields that are always prefixed by `x-`.
38803880

38813881
| Field Pattern | Type | Description |
38823882
| -------------------------------- | :--: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
3883-
| <a name="info-extensions"></a>^x- | Any | Allows extensions to the OpenAPI Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be any valid JSON value (`null`, a primitive, an array or an object.) |
3883+
| <a name="info-extensions"></a>^x- | Any | Allows extensions to the OpenAPI Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be any valid JSON value (`null`, a primitive, an array, or an object.) |
38843884

38853885
The OpenAPI Initiative maintains several [[OpenAPI-Registry|extension registries]], including registries for [individual extension keywords](https://spec.openapis.org/registry/extension/) and [extension keyword namespaces](https://spec.openapis.org/registry/namespace/).
38863886

0 commit comments

Comments
 (0)