Skip to content

Update guidelines for v3 and Swagger --> OAS#1280

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
webron merged 4 commits into from
Jul 25, 2017
Merged

Update guidelines for v3 and Swagger --> OAS #1280

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c401ae6
Update guidelines for v3 and Swagger --> OAS
usarid Jul 20, 2017
6d40370
Update the references in EXTENSIONS.md to refer to whatever is the cu…
usarid Jul 25, 2017
84f9991
definition -> document
usarid Jul 25, 2017
2070f3c
Add EXTENSIONS.md file at the root of the guidelines folder to avoid …
usarid Jul 25, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 1 addition & 92 deletions guidelines/EXTENSIONS.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,92 +1 @@
# Swagger Extensions

The Swagger 2.0 specification allows for custom properties to be added at several places within a Swagger definition, allowing
API providers to extend the meta-data provided for their REST APIs as needed. Extension properties are always
prefixed by "x-" and can have any valid JSON format value.

Currently extension properties are supported in the following definition objects:

* within the [info object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#info-object)
* within the [paths object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#paths-object)
* within the [path-item object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#path-item-object)
* within the [operation object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#operationObject)
* within the [parameter object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#parameterObject)
* within the [responses object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#responses-object)
* within the [tag object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#tag-object)
* within the [security-scheme object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#security-scheme-object)

For example, a vendor extension that adds apis.json specific metadata a Swagger definition might look as follows:

```json
{
"swagger": "2.0",
"info": {
"version": "1.0",
"title": "Analysis",
"description" : "Provides access to blog posts and analysis across the API Evangelist network.",
"x-apis-json" : {
"image": "https://s3.amazonaws.com/kinlane-productions/api-evangelist/t-shirts/KL_InApiWeTrust-1000.png",
"humanURL": "http://developer.apievangelist.com",
"baseURL": "http://api.apievangelist.com/definitions/Analysis",
"tags": [
"blog",
"industry",
"analysis",
"new",
"API",
"Application Programming Interface"
],
"properties": [
{
"type": "X-signup",
"url": "https://apievangelist.3scale.net/"
},
{
"type": "X-blog",
"url": "http://developer.apievangelist.com/blog/"
},
{
"type": "X-apicommonsmanifest",
"url": "https://raw.githubusercontent.com/kinlane/analysis-api/master/api-commons-manifest.json"
}
],
}
},
"basePath": "/",
"paths": {
...
}
}
```

This could be used by corresponding tooling that builds apis.json files for swagger definitions, the advantage being that all metadata
for a Swagger API is within one definition instead of spread out amongst multiple files.

Another (simplified) example could be how to specify a [JWE encryption](http://hdknr.github.io/docs/identity/jwe.html) policy to parameters,
for example as follows:

```json
{
...
"socialSecurityNumber": {
"name": "socialSecurityNumber",
"in": "query",
"description": "a social security number",
"required": false,
"type": "string",
"x-jwe-encryption" : {
"algorithm" : "RSA-OAEP",
"encryption" : "A256GCM"
}
}
}
...
}

```
An API consumer reading these parameter definitions could interpret this as having to encrypt the skip parameter in line
with the JWE standard.

## Annotations

The Swagger-specific annotations currently available for jax-rs APIs do not support the addition of extension data.
For OpenAPI Specification version 2.0, please see [v2.0/EXTENSIONS.md](v2.0/EXTENSIONS.md)
4 changes: 0 additions & 4 deletions guidelines/README.md
View file
Open in desktop

This file was deleted.

92 changes: 92 additions & 0 deletions guidelines/v2.0/EXTENSIONS.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
# OpenAPI Extensions

The OpenAPI Specification version 2.0 allows for custom properties to be added at several places within an OpenAPI document., allowing
API providers to extend the meta-data provided for their REST APIs as needed. Extension properties are always
prefixed by "x-" and can have any valid JSON format value.

Currently extension properties are supported in the following definition objects:

* within the [info object](/versions/2.0.md#info-object)
* within the [paths object](/versions/2.0.md#paths-object)
* within the [path-item object](/versions/2.0.md#path-item-object)
* within the [operation object](/versions/2.0.md#operationObject)
* within the [parameter object](/versions/2.0.md#parameterObject)
* within the [responses object](/versions/2.0.md#responses-object)
* within the [tag object](/versions/2.0.md#tag-object)
* within the [security-scheme object](/versions/2.0.md#security-scheme-object)

For example, a vendor extension that adds apis.json specific metadata to an OpenAPI definition might look as follows:

```json
{
"swagger": "2.0",
"info": {
"version": "1.0",
"title": "Analysis",
"description" : "Provides access to blog posts and analysis across the API Evangelist network.",
"x-apis-json" : {
"image": "https://s3.amazonaws.com/kinlane-productions/api-evangelist/t-shirts/KL_InApiWeTrust-1000.png",
"humanURL": "http://developer.apievangelist.com",
"baseURL": "http://api.apievangelist.com/definitions/Analysis",
"tags": [
"blog",
"industry",
"analysis",
"new",
"API",
"Application Programming Interface"
],
"properties": [
{
"type": "X-signup",
"url": "https://apievangelist.3scale.net/"
},
{
"type": "X-blog",
"url": "http://developer.apievangelist.com/blog/"
},
{
"type": "X-apicommonsmanifest",
"url": "https://raw.githubusercontent.com/kinlane/analysis-api/master/api-commons-manifest.json"
}
],
}
},
"basePath": "/",
"paths": {
...
}
}
```

This could be used by corresponding tooling that builds apis.json files for OpenAPI definitions, the advantage being that all metadata
for the API is within one definition instead of spread out amongst multiple files.

Another (simplified) example could be how to specify a [JWE encryption](http://hdknr.github.io/docs/identity/jwe.html) policy to parameters,
for example as follows:

```json
{
...
"socialSecurityNumber": {
"name": "socialSecurityNumber",
"in": "query",
"description": "a social security number",
"required": false,
"type": "string",
"x-jwe-encryption" : {
"algorithm" : "RSA-OAEP",
"encryption" : "A256GCM"
}
}
}
...
}

```
An API consumer reading these parameter definitions could interpret this as having to encrypt the skip parameter in line
with the JWE standard.

## Annotations

The OpenAPI-specific annotations currently available for jax-rs APIs do not support the addition of extension data.
4 changes: 4 additions & 0 deletions guidelines/v2.0/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
## Guidelines for OpenAPI Definitions

* [Reuse](REUSE.md) of OpenAPI definitions
* [Extending](EXTENSIONS.md) OpenAPI definitions with custom metadata
0 guidelines/REUSE.md → guidelines/v2.0/REUSE.md
View file
Open in desktop
File renamed without changes.
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Update guidelines for v3 and Swagger --> OAS by usarid · Pull Request #1280 · OAI/OpenAPI-Specification · GitHub
Skip to content
Update guidelines for v3 and Swagger --> OAS#1280

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

webron
merged 4 commits into

from

Jul 25, 2017
 Merged


Update guidelines for v3 and Swagger --> OAS
#1280
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
c401ae6

Update guidelines for v3 and Swagger --> OAS


usarid Jul 20, 2017
6d40370

Update the references in EXTENSIONS.md to refer to whatever is the cu…


usarid Jul 25, 2017
84f9991

definition -> document


usarid Jul 25, 2017
2070f3c

Add EXTENSIONS.md file at the root of the guidelines folder to avoid …


usarid Jul 25, 2017

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


93 changes: 1 addition & 92 deletions
guidelines/EXTENSIONS.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,92 +1 @@
# Swagger Extensions

The Swagger 2.0 specification allows for custom properties to be added at several places within a Swagger definition, allowing
API providers to extend the meta-data provided for their REST APIs as needed. Extension properties are always 
prefixed by "x-" and can have any valid JSON format value. 

Currently extension properties are supported in the following definition objects:

* within the [info object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#info-object)
* within the [paths object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#paths-object)
* within the [path-item object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#path-item-object)
* within the [operation object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#operationObject) 
* within the [parameter object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#parameterObject)
* within the [responses object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#responses-object)
* within the [tag object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#tag-object)
* within the [security-scheme object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#security-scheme-object)

For example, a vendor extension that adds apis.json specific metadata a Swagger definition might look as follows:

```json
{
 "swagger": "2.0",
 "info": {
 "version": "1.0",
 "title": "Analysis",
 "description" : "Provides access to blog posts and analysis across the API Evangelist network.",
 "x-apis-json" : {
 "image": "https://s3.amazonaws.com/kinlane-productions/api-evangelist/t-shirts/KL_InApiWeTrust-1000.png",
 "humanURL": "http://developer.apievangelist.com",
 "baseURL": "http://api.apievangelist.com/definitions/Analysis",
 "tags": [
 "blog",
 "industry",
 "analysis",
 "new",
 "API",
 "Application Programming Interface"
 ],
 "properties": [
 {
 "type": "X-signup",
 "url": "https://apievangelist.3scale.net/"
 },
 {
 "type": "X-blog",
 "url": "http://developer.apievangelist.com/blog/"
 },
 {
 "type": "X-apicommonsmanifest",
 "url": "https://raw.githubusercontent.com/kinlane/analysis-api/master/api-commons-manifest.json"
 }
 ],
 }
 },
 "basePath": "/",
 "paths": {
 ...
 }
}
```

This could be used by corresponding tooling that builds apis.json files for swagger definitions, the advantage being that all metadata
for a Swagger API is within one definition instead of spread out amongst multiple files.

Another (simplified) example could be how to specify a [JWE encryption](http://hdknr.github.io/docs/identity/jwe.html) policy to parameters,
 for example as follows:

```json
{
 ...
 "socialSecurityNumber": {
 "name": "socialSecurityNumber",
 "in": "query",
 "description": "a social security number",
 "required": false,
 "type": "string",
 "x-jwe-encryption" : {
 "algorithm" : "RSA-OAEP",
 "encryption" : "A256GCM"
 }
 }
 }
 ...
}

```
An API consumer reading these parameter definitions could interpret this as having to encrypt the skip parameter in line
 with the JWE standard.

## Annotations

The Swagger-specific annotations currently available for jax-rs APIs do not support the addition of extension data.
For OpenAPI Specification version 2.0, please see [v2.0/EXTENSIONS.md](v2.0/EXTENSIONS.md)

4 changes: 0 additions & 4 deletions
guidelines/README.md

View file


Open in desktop


This file was deleted.


92 changes: 92 additions & 0 deletions
guidelines/v2.0/EXTENSIONS.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
# OpenAPI Extensions

The OpenAPI Specification version 2.0 allows for custom properties to be added at several places within an OpenAPI document., allowing
API providers to extend the meta-data provided for their REST APIs as needed. Extension properties are always 
prefixed by "x-" and can have any valid JSON format value. 

Currently extension properties are supported in the following definition objects:

* within the [info object](/versions/2.0.md#info-object)
* within the [paths object](/versions/2.0.md#paths-object)
* within the [path-item object](/versions/2.0.md#path-item-object)
* within the [operation object](/versions/2.0.md#operationObject) 
* within the [parameter object](/versions/2.0.md#parameterObject)
* within the [responses object](/versions/2.0.md#responses-object)
* within the [tag object](/versions/2.0.md#tag-object)
* within the [security-scheme object](/versions/2.0.md#security-scheme-object)

For example, a vendor extension that adds apis.json specific metadata to an OpenAPI definition might look as follows:

```json
{
 "swagger": "2.0",
 "info": {
 "version": "1.0",
 "title": "Analysis",
 "description" : "Provides access to blog posts and analysis across the API Evangelist network.",
 "x-apis-json" : {
 "image": "https://s3.amazonaws.com/kinlane-productions/api-evangelist/t-shirts/KL_InApiWeTrust-1000.png",
 "humanURL": "http://developer.apievangelist.com",
 "baseURL": "http://api.apievangelist.com/definitions/Analysis",
 "tags": [
 "blog",
 "industry",
 "analysis",
 "new",
 "API",
 "Application Programming Interface"
 ],
 "properties": [
 {
 "type": "X-signup",
 "url": "https://apievangelist.3scale.net/"
 },
 {
 "type": "X-blog",
 "url": "http://developer.apievangelist.com/blog/"
 },
 {
 "type": "X-apicommonsmanifest",
 "url": "https://raw.githubusercontent.com/kinlane/analysis-api/master/api-commons-manifest.json"
 }
 ],
 }
 },
 "basePath": "/",
 "paths": {
 ...
 }
}
```

This could be used by corresponding tooling that builds apis.json files for OpenAPI definitions, the advantage being that all metadata
for the API is within one definition instead of spread out amongst multiple files.

Another (simplified) example could be how to specify a [JWE encryption](http://hdknr.github.io/docs/identity/jwe.html) policy to parameters,
 for example as follows:

```json
{
 ...
 "socialSecurityNumber": {
 "name": "socialSecurityNumber",
 "in": "query",
 "description": "a social security number",
 "required": false,
 "type": "string",
 "x-jwe-encryption" : {
 "algorithm" : "RSA-OAEP",
 "encryption" : "A256GCM"
 }
 }
 }
 ...
}

```
An API consumer reading these parameter definitions could interpret this as having to encrypt the skip parameter in line
 with the JWE standard.

## Annotations

The OpenAPI-specific annotations currently available for jax-rs APIs do not support the addition of extension data.

4 changes: 4 additions & 0 deletions
guidelines/v2.0/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
## Guidelines for OpenAPI Definitions

* [Reuse](REUSE.md) of OpenAPI definitions
* [Extending](EXTENSIONS.md) OpenAPI definitions with custom metadata

0
guidelines/REUSE.md → guidelines/v2.0/REUSE.md

View file


Open in desktop


File renamed without changes.


, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Update guidelines for v3 and Swagger --> OAS by usarid · Pull Request #1280 · OAI/OpenAPI-Specification · GitHub
Skip to content
Update guidelines for v3 and Swagger --> OAS#1280

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

webron
merged 4 commits into

from

Jul 25, 2017
 Merged


Update guidelines for v3 and Swagger --> OAS
#1280
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
c401ae6

Update guidelines for v3 and Swagger --> OAS


usarid Jul 20, 2017
6d40370

Update the references in EXTENSIONS.md to refer to whatever is the cu…


usarid Jul 25, 2017
84f9991

definition -> document


usarid Jul 25, 2017
2070f3c

Add EXTENSIONS.md file at the root of the guidelines folder to avoid …


usarid Jul 25, 2017

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


93 changes: 1 addition & 92 deletions
guidelines/EXTENSIONS.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,92 +1 @@
# Swagger Extensions

The Swagger 2.0 specification allows for custom properties to be added at several places within a Swagger definition, allowing
API providers to extend the meta-data provided for their REST APIs as needed. Extension properties are always 
prefixed by "x-" and can have any valid JSON format value. 

Currently extension properties are supported in the following definition objects:

* within the [info object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#info-object)
* within the [paths object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#paths-object)
* within the [path-item object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#path-item-object)
* within the [operation object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#operationObject) 
* within the [parameter object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#parameterObject)
* within the [responses object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#responses-object)
* within the [tag object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#tag-object)
* within the [security-scheme object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#security-scheme-object)

For example, a vendor extension that adds apis.json specific metadata a Swagger definition might look as follows:

```json
{
 "swagger": "2.0",
 "info": {
 "version": "1.0",
 "title": "Analysis",
 "description" : "Provides access to blog posts and analysis across the API Evangelist network.",
 "x-apis-json" : {
 "image": "https://s3.amazonaws.com/kinlane-productions/api-evangelist/t-shirts/KL_InApiWeTrust-1000.png",
 "humanURL": "http://developer.apievangelist.com",
 "baseURL": "http://api.apievangelist.com/definitions/Analysis",
 "tags": [
 "blog",
 "industry",
 "analysis",
 "new",
 "API",
 "Application Programming Interface"
 ],
 "properties": [
 {
 "type": "X-signup",
 "url": "https://apievangelist.3scale.net/"
 },
 {
 "type": "X-blog",
 "url": "http://developer.apievangelist.com/blog/"
 },
 {
 "type": "X-apicommonsmanifest",
 "url": "https://raw.githubusercontent.com/kinlane/analysis-api/master/api-commons-manifest.json"
 }
 ],
 }
 },
 "basePath": "/",
 "paths": {
 ...
 }
}
```

This could be used by corresponding tooling that builds apis.json files for swagger definitions, the advantage being that all metadata
for a Swagger API is within one definition instead of spread out amongst multiple files.

Another (simplified) example could be how to specify a [JWE encryption](http://hdknr.github.io/docs/identity/jwe.html) policy to parameters,
 for example as follows:

```json
{
 ...
 "socialSecurityNumber": {
 "name": "socialSecurityNumber",
 "in": "query",
 "description": "a social security number",
 "required": false,
 "type": "string",
 "x-jwe-encryption" : {
 "algorithm" : "RSA-OAEP",
 "encryption" : "A256GCM"
 }
 }
 }
 ...
}

```
An API consumer reading these parameter definitions could interpret this as having to encrypt the skip parameter in line
 with the JWE standard.

## Annotations

The Swagger-specific annotations currently available for jax-rs APIs do not support the addition of extension data.
For OpenAPI Specification version 2.0, please see [v2.0/EXTENSIONS.md](v2.0/EXTENSIONS.md)

4 changes: 0 additions & 4 deletions
guidelines/README.md

View file


Open in desktop


This file was deleted.


92 changes: 92 additions & 0 deletions
guidelines/v2.0/EXTENSIONS.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
# OpenAPI Extensions

The OpenAPI Specification version 2.0 allows for custom properties to be added at several places within an OpenAPI document., allowing
API providers to extend the meta-data provided for their REST APIs as needed. Extension properties are always 
prefixed by "x-" and can have any valid JSON format value. 

Currently extension properties are supported in the following definition objects:

* within the [info object](/versions/2.0.md#info-object)
* within the [paths object](/versions/2.0.md#paths-object)
* within the [path-item object](/versions/2.0.md#path-item-object)
* within the [operation object](/versions/2.0.md#operationObject) 
* within the [parameter object](/versions/2.0.md#parameterObject)
* within the [responses object](/versions/2.0.md#responses-object)
* within the [tag object](/versions/2.0.md#tag-object)
* within the [security-scheme object](/versions/2.0.md#security-scheme-object)

For example, a vendor extension that adds apis.json specific metadata to an OpenAPI definition might look as follows:

```json
{
 "swagger": "2.0",
 "info": {
 "version": "1.0",
 "title": "Analysis",
 "description" : "Provides access to blog posts and analysis across the API Evangelist network.",
 "x-apis-json" : {
 "image": "https://s3.amazonaws.com/kinlane-productions/api-evangelist/t-shirts/KL_InApiWeTrust-1000.png",
 "humanURL": "http://developer.apievangelist.com",
 "baseURL": "http://api.apievangelist.com/definitions/Analysis",
 "tags": [
 "blog",
 "industry",
 "analysis",
 "new",
 "API",
 "Application Programming Interface"
 ],
 "properties": [
 {
 "type": "X-signup",
 "url": "https://apievangelist.3scale.net/"
 },
 {
 "type": "X-blog",
 "url": "http://developer.apievangelist.com/blog/"
 },
 {
 "type": "X-apicommonsmanifest",
 "url": "https://raw.githubusercontent.com/kinlane/analysis-api/master/api-commons-manifest.json"
 }
 ],
 }
 },
 "basePath": "/",
 "paths": {
 ...
 }
}
```

This could be used by corresponding tooling that builds apis.json files for OpenAPI definitions, the advantage being that all metadata
for the API is within one definition instead of spread out amongst multiple files.

Another (simplified) example could be how to specify a [JWE encryption](http://hdknr.github.io/docs/identity/jwe.html) policy to parameters,
 for example as follows:

```json
{
 ...
 "socialSecurityNumber": {
 "name": "socialSecurityNumber",
 "in": "query",
 "description": "a social security number",
 "required": false,
 "type": "string",
 "x-jwe-encryption" : {
 "algorithm" : "RSA-OAEP",
 "encryption" : "A256GCM"
 }
 }
 }
 ...
}

```
An API consumer reading these parameter definitions could interpret this as having to encrypt the skip parameter in line
 with the JWE standard.

## Annotations

The OpenAPI-specific annotations currently available for jax-rs APIs do not support the addition of extension data.

4 changes: 4 additions & 0 deletions
guidelines/v2.0/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
## Guidelines for OpenAPI Definitions

* [Reuse](REUSE.md) of OpenAPI definitions
* [Extending](EXTENSIONS.md) OpenAPI definitions with custom metadata

0
guidelines/REUSE.md → guidelines/v2.0/REUSE.md

View file


Open in desktop


File renamed without changes.


, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Update guidelines for v3 and Swagger --> OAS by usarid · Pull Request #1280 · OAI/OpenAPI-Specification · GitHub
Skip to content
Update guidelines for v3 and Swagger --> OAS#1280

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

webron
merged 4 commits into

from

Jul 25, 2017
 Merged


Update guidelines for v3 and Swagger --> OAS
#1280
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
c401ae6

Update guidelines for v3 and Swagger --> OAS


usarid Jul 20, 2017
6d40370

Update the references in EXTENSIONS.md to refer to whatever is the cu…


usarid Jul 25, 2017
84f9991

definition -> document


usarid Jul 25, 2017
2070f3c

Add EXTENSIONS.md file at the root of the guidelines folder to avoid …


usarid Jul 25, 2017

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


93 changes: 1 addition & 92 deletions
guidelines/EXTENSIONS.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,92 +1 @@
# Swagger Extensions

The Swagger 2.0 specification allows for custom properties to be added at several places within a Swagger definition, allowing
API providers to extend the meta-data provided for their REST APIs as needed. Extension properties are always 
prefixed by "x-" and can have any valid JSON format value. 

Currently extension properties are supported in the following definition objects:

* within the [info object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#info-object)
* within the [paths object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#paths-object)
* within the [path-item object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#path-item-object)
* within the [operation object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#operationObject) 
* within the [parameter object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#parameterObject)
* within the [responses object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#responses-object)
* within the [tag object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#tag-object)
* within the [security-scheme object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#security-scheme-object)

For example, a vendor extension that adds apis.json specific metadata a Swagger definition might look as follows:

```json
{
 "swagger": "2.0",
 "info": {
 "version": "1.0",
 "title": "Analysis",
 "description" : "Provides access to blog posts and analysis across the API Evangelist network.",
 "x-apis-json" : {
 "image": "https://s3.amazonaws.com/kinlane-productions/api-evangelist/t-shirts/KL_InApiWeTrust-1000.png",
 "humanURL": "http://developer.apievangelist.com",
 "baseURL": "http://api.apievangelist.com/definitions/Analysis",
 "tags": [
 "blog",
 "industry",
 "analysis",
 "new",
 "API",
 "Application Programming Interface"
 ],
 "properties": [
 {
 "type": "X-signup",
 "url": "https://apievangelist.3scale.net/"
 },
 {
 "type": "X-blog",
 "url": "http://developer.apievangelist.com/blog/"
 },
 {
 "type": "X-apicommonsmanifest",
 "url": "https://raw.githubusercontent.com/kinlane/analysis-api/master/api-commons-manifest.json"
 }
 ],
 }
 },
 "basePath": "/",
 "paths": {
 ...
 }
}
```

This could be used by corresponding tooling that builds apis.json files for swagger definitions, the advantage being that all metadata
for a Swagger API is within one definition instead of spread out amongst multiple files.

Another (simplified) example could be how to specify a [JWE encryption](http://hdknr.github.io/docs/identity/jwe.html) policy to parameters,
 for example as follows:

```json
{
 ...
 "socialSecurityNumber": {
 "name": "socialSecurityNumber",
 "in": "query",
 "description": "a social security number",
 "required": false,
 "type": "string",
 "x-jwe-encryption" : {
 "algorithm" : "RSA-OAEP",
 "encryption" : "A256GCM"
 }
 }
 }
 ...
}

```
An API consumer reading these parameter definitions could interpret this as having to encrypt the skip parameter in line
 with the JWE standard.

## Annotations

The Swagger-specific annotations currently available for jax-rs APIs do not support the addition of extension data.
For OpenAPI Specification version 2.0, please see [v2.0/EXTENSIONS.md](v2.0/EXTENSIONS.md)

4 changes: 0 additions & 4 deletions
guidelines/README.md

View file


Open in desktop


This file was deleted.


92 changes: 92 additions & 0 deletions
guidelines/v2.0/EXTENSIONS.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
# OpenAPI Extensions

The OpenAPI Specification version 2.0 allows for custom properties to be added at several places within an OpenAPI document., allowing
API providers to extend the meta-data provided for their REST APIs as needed. Extension properties are always 
prefixed by "x-" and can have any valid JSON format value. 

Currently extension properties are supported in the following definition objects:

* within the [info object](/versions/2.0.md#info-object)
* within the [paths object](/versions/2.0.md#paths-object)
* within the [path-item object](/versions/2.0.md#path-item-object)
* within the [operation object](/versions/2.0.md#operationObject) 
* within the [parameter object](/versions/2.0.md#parameterObject)
* within the [responses object](/versions/2.0.md#responses-object)
* within the [tag object](/versions/2.0.md#tag-object)
* within the [security-scheme object](/versions/2.0.md#security-scheme-object)

For example, a vendor extension that adds apis.json specific metadata to an OpenAPI definition might look as follows:

```json
{
 "swagger": "2.0",
 "info": {
 "version": "1.0",
 "title": "Analysis",
 "description" : "Provides access to blog posts and analysis across the API Evangelist network.",
 "x-apis-json" : {
 "image": "https://s3.amazonaws.com/kinlane-productions/api-evangelist/t-shirts/KL_InApiWeTrust-1000.png",
 "humanURL": "http://developer.apievangelist.com",
 "baseURL": "http://api.apievangelist.com/definitions/Analysis",
 "tags": [
 "blog",
 "industry",
 "analysis",
 "new",
 "API",
 "Application Programming Interface"
 ],
 "properties": [
 {
 "type": "X-signup",
 "url": "https://apievangelist.3scale.net/"
 },
 {
 "type": "X-blog",
 "url": "http://developer.apievangelist.com/blog/"
 },
 {
 "type": "X-apicommonsmanifest",
 "url": "https://raw.githubusercontent.com/kinlane/analysis-api/master/api-commons-manifest.json"
 }
 ],
 }
 },
 "basePath": "/",
 "paths": {
 ...
 }
}
```

This could be used by corresponding tooling that builds apis.json files for OpenAPI definitions, the advantage being that all metadata
for the API is within one definition instead of spread out amongst multiple files.

Another (simplified) example could be how to specify a [JWE encryption](http://hdknr.github.io/docs/identity/jwe.html) policy to parameters,
 for example as follows:

```json
{
 ...
 "socialSecurityNumber": {
 "name": "socialSecurityNumber",
 "in": "query",
 "description": "a social security number",
 "required": false,
 "type": "string",
 "x-jwe-encryption" : {
 "algorithm" : "RSA-OAEP",
 "encryption" : "A256GCM"
 }
 }
 }
 ...
}

```
An API consumer reading these parameter definitions could interpret this as having to encrypt the skip parameter in line
 with the JWE standard.

## Annotations

The OpenAPI-specific annotations currently available for jax-rs APIs do not support the addition of extension data.

4 changes: 4 additions & 0 deletions
guidelines/v2.0/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
## Guidelines for OpenAPI Definitions

* [Reuse](REUSE.md) of OpenAPI definitions
* [Extending](EXTENSIONS.md) OpenAPI definitions with custom metadata

0
guidelines/REUSE.md → guidelines/v2.0/REUSE.md

View file


Open in desktop


File renamed without changes.


, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Update guidelines for v3 and Swagger --> OAS by usarid · Pull Request #1280 · OAI/OpenAPI-Specification · GitHub
Skip to content
Update guidelines for v3 and Swagger --> OAS#1280

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

webron
merged 4 commits into

from

Jul 25, 2017
 Merged


Update guidelines for v3 and Swagger --> OAS
#1280
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
c401ae6

Update guidelines for v3 and Swagger --> OAS


usarid Jul 20, 2017
6d40370

Update the references in EXTENSIONS.md to refer to whatever is the cu…


usarid Jul 25, 2017
84f9991

definition -> document


usarid Jul 25, 2017
2070f3c

Add EXTENSIONS.md file at the root of the guidelines folder to avoid …


usarid Jul 25, 2017

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


93 changes: 1 addition & 92 deletions
guidelines/EXTENSIONS.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,92 +1 @@
# Swagger Extensions

The Swagger 2.0 specification allows for custom properties to be added at several places within a Swagger definition, allowing
API providers to extend the meta-data provided for their REST APIs as needed. Extension properties are always 
prefixed by "x-" and can have any valid JSON format value. 

Currently extension properties are supported in the following definition objects:

* within the [info object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#info-object)
* within the [paths object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#paths-object)
* within the [path-item object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#path-item-object)
* within the [operation object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#operationObject) 
* within the [parameter object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#parameterObject)
* within the [responses object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#responses-object)
* within the [tag object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#tag-object)
* within the [security-scheme object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#security-scheme-object)

For example, a vendor extension that adds apis.json specific metadata a Swagger definition might look as follows:

```json
{
 "swagger": "2.0",
 "info": {
 "version": "1.0",
 "title": "Analysis",
 "description" : "Provides access to blog posts and analysis across the API Evangelist network.",
 "x-apis-json" : {
 "image": "https://s3.amazonaws.com/kinlane-productions/api-evangelist/t-shirts/KL_InApiWeTrust-1000.png",
 "humanURL": "http://developer.apievangelist.com",
 "baseURL": "http://api.apievangelist.com/definitions/Analysis",
 "tags": [
 "blog",
 "industry",
 "analysis",
 "new",
 "API",
 "Application Programming Interface"
 ],
 "properties": [
 {
 "type": "X-signup",
 "url": "https://apievangelist.3scale.net/"
 },
 {
 "type": "X-blog",
 "url": "http://developer.apievangelist.com/blog/"
 },
 {
 "type": "X-apicommonsmanifest",
 "url": "https://raw.githubusercontent.com/kinlane/analysis-api/master/api-commons-manifest.json"
 }
 ],
 }
 },
 "basePath": "/",
 "paths": {
 ...
 }
}
```

This could be used by corresponding tooling that builds apis.json files for swagger definitions, the advantage being that all metadata
for a Swagger API is within one definition instead of spread out amongst multiple files.

Another (simplified) example could be how to specify a [JWE encryption](http://hdknr.github.io/docs/identity/jwe.html) policy to parameters,
 for example as follows:

```json
{
 ...
 "socialSecurityNumber": {
 "name": "socialSecurityNumber",
 "in": "query",
 "description": "a social security number",
 "required": false,
 "type": "string",
 "x-jwe-encryption" : {
 "algorithm" : "RSA-OAEP",
 "encryption" : "A256GCM"
 }
 }
 }
 ...
}

```
An API consumer reading these parameter definitions could interpret this as having to encrypt the skip parameter in line
 with the JWE standard.

## Annotations

The Swagger-specific annotations currently available for jax-rs APIs do not support the addition of extension data.
For OpenAPI Specification version 2.0, please see [v2.0/EXTENSIONS.md](v2.0/EXTENSIONS.md)

4 changes: 0 additions & 4 deletions
guidelines/README.md

View file


Open in desktop


This file was deleted.


92 changes: 92 additions & 0 deletions
guidelines/v2.0/EXTENSIONS.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
# OpenAPI Extensions

The OpenAPI Specification version 2.0 allows for custom properties to be added at several places within an OpenAPI document., allowing
API providers to extend the meta-data provided for their REST APIs as needed. Extension properties are always 
prefixed by "x-" and can have any valid JSON format value. 

Currently extension properties are supported in the following definition objects:

* within the [info object](/versions/2.0.md#info-object)
* within the [paths object](/versions/2.0.md#paths-object)
* within the [path-item object](/versions/2.0.md#path-item-object)
* within the [operation object](/versions/2.0.md#operationObject) 
* within the [parameter object](/versions/2.0.md#parameterObject)
* within the [responses object](/versions/2.0.md#responses-object)
* within the [tag object](/versions/2.0.md#tag-object)
* within the [security-scheme object](/versions/2.0.md#security-scheme-object)

For example, a vendor extension that adds apis.json specific metadata to an OpenAPI definition might look as follows:

```json
{
 "swagger": "2.0",
 "info": {
 "version": "1.0",
 "title": "Analysis",
 "description" : "Provides access to blog posts and analysis across the API Evangelist network.",
 "x-apis-json" : {
 "image": "https://s3.amazonaws.com/kinlane-productions/api-evangelist/t-shirts/KL_InApiWeTrust-1000.png",
 "humanURL": "http://developer.apievangelist.com",
 "baseURL": "http://api.apievangelist.com/definitions/Analysis",
 "tags": [
 "blog",
 "industry",
 "analysis",
 "new",
 "API",
 "Application Programming Interface"
 ],
 "properties": [
 {
 "type": "X-signup",
 "url": "https://apievangelist.3scale.net/"
 },
 {
 "type": "X-blog",
 "url": "http://developer.apievangelist.com/blog/"
 },
 {
 "type": "X-apicommonsmanifest",
 "url": "https://raw.githubusercontent.com/kinlane/analysis-api/master/api-commons-manifest.json"
 }
 ],
 }
 },
 "basePath": "/",
 "paths": {
 ...
 }
}
```

This could be used by corresponding tooling that builds apis.json files for OpenAPI definitions, the advantage being that all metadata
for the API is within one definition instead of spread out amongst multiple files.

Another (simplified) example could be how to specify a [JWE encryption](http://hdknr.github.io/docs/identity/jwe.html) policy to parameters,
 for example as follows:

```json
{
 ...
 "socialSecurityNumber": {
 "name": "socialSecurityNumber",
 "in": "query",
 "description": "a social security number",
 "required": false,
 "type": "string",
 "x-jwe-encryption" : {
 "algorithm" : "RSA-OAEP",
 "encryption" : "A256GCM"
 }
 }
 }
 ...
}

```
An API consumer reading these parameter definitions could interpret this as having to encrypt the skip parameter in line
 with the JWE standard.

## Annotations

The OpenAPI-specific annotations currently available for jax-rs APIs do not support the addition of extension data.

4 changes: 4 additions & 0 deletions
guidelines/v2.0/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
## Guidelines for OpenAPI Definitions

* [Reuse](REUSE.md) of OpenAPI definitions
* [Extending](EXTENSIONS.md) OpenAPI definitions with custom metadata

0
guidelines/REUSE.md → guidelines/v2.0/REUSE.md

View file


Open in desktop


File renamed without changes.


, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Update guidelines for v3 and Swagger --> OAS by usarid · Pull Request #1280 · OAI/OpenAPI-Specification · GitHub
Skip to content
Update guidelines for v3 and Swagger --> OAS#1280

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

webron
merged 4 commits into

from

Jul 25, 2017
 Merged


Update guidelines for v3 and Swagger --> OAS
#1280
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
c401ae6

Update guidelines for v3 and Swagger --> OAS


usarid Jul 20, 2017
6d40370

Update the references in EXTENSIONS.md to refer to whatever is the cu…


usarid Jul 25, 2017
84f9991

definition -> document


usarid Jul 25, 2017
2070f3c

Add EXTENSIONS.md file at the root of the guidelines folder to avoid …


usarid Jul 25, 2017

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


93 changes: 1 addition & 92 deletions
guidelines/EXTENSIONS.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,92 +1 @@
# Swagger Extensions

The Swagger 2.0 specification allows for custom properties to be added at several places within a Swagger definition, allowing
API providers to extend the meta-data provided for their REST APIs as needed. Extension properties are always 
prefixed by "x-" and can have any valid JSON format value. 

Currently extension properties are supported in the following definition objects:

* within the [info object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#info-object)
* within the [paths object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#paths-object)
* within the [path-item object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#path-item-object)
* within the [operation object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#operationObject) 
* within the [parameter object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#parameterObject)
* within the [responses object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#responses-object)
* within the [tag object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#tag-object)
* within the [security-scheme object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#security-scheme-object)

For example, a vendor extension that adds apis.json specific metadata a Swagger definition might look as follows:

```json
{
 "swagger": "2.0",
 "info": {
 "version": "1.0",
 "title": "Analysis",
 "description" : "Provides access to blog posts and analysis across the API Evangelist network.",
 "x-apis-json" : {
 "image": "https://s3.amazonaws.com/kinlane-productions/api-evangelist/t-shirts/KL_InApiWeTrust-1000.png",
 "humanURL": "http://developer.apievangelist.com",
 "baseURL": "http://api.apievangelist.com/definitions/Analysis",
 "tags": [
 "blog",
 "industry",
 "analysis",
 "new",
 "API",
 "Application Programming Interface"
 ],
 "properties": [
 {
 "type": "X-signup",
 "url": "https://apievangelist.3scale.net/"
 },
 {
 "type": "X-blog",
 "url": "http://developer.apievangelist.com/blog/"
 },
 {
 "type": "X-apicommonsmanifest",
 "url": "https://raw.githubusercontent.com/kinlane/analysis-api/master/api-commons-manifest.json"
 }
 ],
 }
 },
 "basePath": "/",
 "paths": {
 ...
 }
}
```

This could be used by corresponding tooling that builds apis.json files for swagger definitions, the advantage being that all metadata
for a Swagger API is within one definition instead of spread out amongst multiple files.

Another (simplified) example could be how to specify a [JWE encryption](http://hdknr.github.io/docs/identity/jwe.html) policy to parameters,
 for example as follows:

```json
{
 ...
 "socialSecurityNumber": {
 "name": "socialSecurityNumber",
 "in": "query",
 "description": "a social security number",
 "required": false,
 "type": "string",
 "x-jwe-encryption" : {
 "algorithm" : "RSA-OAEP",
 "encryption" : "A256GCM"
 }
 }
 }
 ...
}

```
An API consumer reading these parameter definitions could interpret this as having to encrypt the skip parameter in line
 with the JWE standard.

## Annotations

The Swagger-specific annotations currently available for jax-rs APIs do not support the addition of extension data.
For OpenAPI Specification version 2.0, please see [v2.0/EXTENSIONS.md](v2.0/EXTENSIONS.md)

4 changes: 0 additions & 4 deletions
guidelines/README.md

View file


Open in desktop


This file was deleted.


92 changes: 92 additions & 0 deletions
guidelines/v2.0/EXTENSIONS.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
# OpenAPI Extensions

The OpenAPI Specification version 2.0 allows for custom properties to be added at several places within an OpenAPI document., allowing
API providers to extend the meta-data provided for their REST APIs as needed. Extension properties are always 
prefixed by "x-" and can have any valid JSON format value. 

Currently extension properties are supported in the following definition objects:

* within the [info object](/versions/2.0.md#info-object)
* within the [paths object](/versions/2.0.md#paths-object)
* within the [path-item object](/versions/2.0.md#path-item-object)
* within the [operation object](/versions/2.0.md#operationObject) 
* within the [parameter object](/versions/2.0.md#parameterObject)
* within the [responses object](/versions/2.0.md#responses-object)
* within the [tag object](/versions/2.0.md#tag-object)
* within the [security-scheme object](/versions/2.0.md#security-scheme-object)

For example, a vendor extension that adds apis.json specific metadata to an OpenAPI definition might look as follows:

```json
{
 "swagger": "2.0",
 "info": {
 "version": "1.0",
 "title": "Analysis",
 "description" : "Provides access to blog posts and analysis across the API Evangelist network.",
 "x-apis-json" : {
 "image": "https://s3.amazonaws.com/kinlane-productions/api-evangelist/t-shirts/KL_InApiWeTrust-1000.png",
 "humanURL": "http://developer.apievangelist.com",
 "baseURL": "http://api.apievangelist.com/definitions/Analysis",
 "tags": [
 "blog",
 "industry",
 "analysis",
 "new",
 "API",
 "Application Programming Interface"
 ],
 "properties": [
 {
 "type": "X-signup",
 "url": "https://apievangelist.3scale.net/"
 },
 {
 "type": "X-blog",
 "url": "http://developer.apievangelist.com/blog/"
 },
 {
 "type": "X-apicommonsmanifest",
 "url": "https://raw.githubusercontent.com/kinlane/analysis-api/master/api-commons-manifest.json"
 }
 ],
 }
 },
 "basePath": "/",
 "paths": {
 ...
 }
}
```

This could be used by corresponding tooling that builds apis.json files for OpenAPI definitions, the advantage being that all metadata
for the API is within one definition instead of spread out amongst multiple files.

Another (simplified) example could be how to specify a [JWE encryption](http://hdknr.github.io/docs/identity/jwe.html) policy to parameters,
 for example as follows:

```json
{
 ...
 "socialSecurityNumber": {
 "name": "socialSecurityNumber",
 "in": "query",
 "description": "a social security number",
 "required": false,
 "type": "string",
 "x-jwe-encryption" : {
 "algorithm" : "RSA-OAEP",
 "encryption" : "A256GCM"
 }
 }
 }
 ...
}

```
An API consumer reading these parameter definitions could interpret this as having to encrypt the skip parameter in line
 with the JWE standard.

## Annotations

The OpenAPI-specific annotations currently available for jax-rs APIs do not support the addition of extension data.

4 changes: 4 additions & 0 deletions
guidelines/v2.0/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
## Guidelines for OpenAPI Definitions

* [Reuse](REUSE.md) of OpenAPI definitions
* [Extending](EXTENSIONS.md) OpenAPI definitions with custom metadata

0
guidelines/REUSE.md → guidelines/v2.0/REUSE.md

View file


Open in desktop


File renamed without changes.


, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Update guidelines for v3 and Swagger --> OAS by usarid · Pull Request #1280 · OAI/OpenAPI-Specification · GitHub
Skip to content
Update guidelines for v3 and Swagger --> OAS#1280

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

webron
merged 4 commits into

from

Jul 25, 2017
 Merged


Update guidelines for v3 and Swagger --> OAS
#1280
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
c401ae6

Update guidelines for v3 and Swagger --> OAS


usarid Jul 20, 2017
6d40370

Update the references in EXTENSIONS.md to refer to whatever is the cu…


usarid Jul 25, 2017
84f9991

definition -> document


usarid Jul 25, 2017
2070f3c

Add EXTENSIONS.md file at the root of the guidelines folder to avoid …


usarid Jul 25, 2017

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


93 changes: 1 addition & 92 deletions
guidelines/EXTENSIONS.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,92 +1 @@
# Swagger Extensions

The Swagger 2.0 specification allows for custom properties to be added at several places within a Swagger definition, allowing
API providers to extend the meta-data provided for their REST APIs as needed. Extension properties are always 
prefixed by "x-" and can have any valid JSON format value. 

Currently extension properties are supported in the following definition objects:

* within the [info object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#info-object)
* within the [paths object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#paths-object)
* within the [path-item object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#path-item-object)
* within the [operation object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#operationObject) 
* within the [parameter object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#parameterObject)
* within the [responses object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#responses-object)
* within the [tag object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#tag-object)
* within the [security-scheme object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#security-scheme-object)

For example, a vendor extension that adds apis.json specific metadata a Swagger definition might look as follows:

```json
{
 "swagger": "2.0",
 "info": {
 "version": "1.0",
 "title": "Analysis",
 "description" : "Provides access to blog posts and analysis across the API Evangelist network.",
 "x-apis-json" : {
 "image": "https://s3.amazonaws.com/kinlane-productions/api-evangelist/t-shirts/KL_InApiWeTrust-1000.png",
 "humanURL": "http://developer.apievangelist.com",
 "baseURL": "http://api.apievangelist.com/definitions/Analysis",
 "tags": [
 "blog",
 "industry",
 "analysis",
 "new",
 "API",
 "Application Programming Interface"
 ],
 "properties": [
 {
 "type": "X-signup",
 "url": "https://apievangelist.3scale.net/"
 },
 {
 "type": "X-blog",
 "url": "http://developer.apievangelist.com/blog/"
 },
 {
 "type": "X-apicommonsmanifest",
 "url": "https://raw.githubusercontent.com/kinlane/analysis-api/master/api-commons-manifest.json"
 }
 ],
 }
 },
 "basePath": "/",
 "paths": {
 ...
 }
}
```

This could be used by corresponding tooling that builds apis.json files for swagger definitions, the advantage being that all metadata
for a Swagger API is within one definition instead of spread out amongst multiple files.

Another (simplified) example could be how to specify a [JWE encryption](http://hdknr.github.io/docs/identity/jwe.html) policy to parameters,
 for example as follows:

```json
{
 ...
 "socialSecurityNumber": {
 "name": "socialSecurityNumber",
 "in": "query",
 "description": "a social security number",
 "required": false,
 "type": "string",
 "x-jwe-encryption" : {
 "algorithm" : "RSA-OAEP",
 "encryption" : "A256GCM"
 }
 }
 }
 ...
}

```
An API consumer reading these parameter definitions could interpret this as having to encrypt the skip parameter in line
 with the JWE standard.

## Annotations

The Swagger-specific annotations currently available for jax-rs APIs do not support the addition of extension data.
For OpenAPI Specification version 2.0, please see [v2.0/EXTENSIONS.md](v2.0/EXTENSIONS.md)

4 changes: 0 additions & 4 deletions
guidelines/README.md

View file


Open in desktop


This file was deleted.


92 changes: 92 additions & 0 deletions
guidelines/v2.0/EXTENSIONS.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
# OpenAPI Extensions

The OpenAPI Specification version 2.0 allows for custom properties to be added at several places within an OpenAPI document., allowing
API providers to extend the meta-data provided for their REST APIs as needed. Extension properties are always 
prefixed by "x-" and can have any valid JSON format value. 

Currently extension properties are supported in the following definition objects:

* within the [info object](/versions/2.0.md#info-object)
* within the [paths object](/versions/2.0.md#paths-object)
* within the [path-item object](/versions/2.0.md#path-item-object)
* within the [operation object](/versions/2.0.md#operationObject) 
* within the [parameter object](/versions/2.0.md#parameterObject)
* within the [responses object](/versions/2.0.md#responses-object)
* within the [tag object](/versions/2.0.md#tag-object)
* within the [security-scheme object](/versions/2.0.md#security-scheme-object)

For example, a vendor extension that adds apis.json specific metadata to an OpenAPI definition might look as follows:

```json
{
 "swagger": "2.0",
 "info": {
 "version": "1.0",
 "title": "Analysis",
 "description" : "Provides access to blog posts and analysis across the API Evangelist network.",
 "x-apis-json" : {
 "image": "https://s3.amazonaws.com/kinlane-productions/api-evangelist/t-shirts/KL_InApiWeTrust-1000.png",
 "humanURL": "http://developer.apievangelist.com",
 "baseURL": "http://api.apievangelist.com/definitions/Analysis",
 "tags": [
 "blog",
 "industry",
 "analysis",
 "new",
 "API",
 "Application Programming Interface"
 ],
 "properties": [
 {
 "type": "X-signup",
 "url": "https://apievangelist.3scale.net/"
 },
 {
 "type": "X-blog",
 "url": "http://developer.apievangelist.com/blog/"
 },
 {
 "type": "X-apicommonsmanifest",
 "url": "https://raw.githubusercontent.com/kinlane/analysis-api/master/api-commons-manifest.json"
 }
 ],
 }
 },
 "basePath": "/",
 "paths": {
 ...
 }
}
```

This could be used by corresponding tooling that builds apis.json files for OpenAPI definitions, the advantage being that all metadata
for the API is within one definition instead of spread out amongst multiple files.

Another (simplified) example could be how to specify a [JWE encryption](http://hdknr.github.io/docs/identity/jwe.html) policy to parameters,
 for example as follows:

```json
{
 ...
 "socialSecurityNumber": {
 "name": "socialSecurityNumber",
 "in": "query",
 "description": "a social security number",
 "required": false,
 "type": "string",
 "x-jwe-encryption" : {
 "algorithm" : "RSA-OAEP",
 "encryption" : "A256GCM"
 }
 }
 }
 ...
}

```
An API consumer reading these parameter definitions could interpret this as having to encrypt the skip parameter in line
 with the JWE standard.

## Annotations

The OpenAPI-specific annotations currently available for jax-rs APIs do not support the addition of extension data.

4 changes: 4 additions & 0 deletions
guidelines/v2.0/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
## Guidelines for OpenAPI Definitions

* [Reuse](REUSE.md) of OpenAPI definitions
* [Extending](EXTENSIONS.md) OpenAPI definitions with custom metadata

0
guidelines/REUSE.md → guidelines/v2.0/REUSE.md

View file


Open in desktop


File renamed without changes.


, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Update guidelines for v3 and Swagger --> OAS by usarid · Pull Request #1280 · OAI/OpenAPI-Specification · GitHub
Skip to content
Update guidelines for v3 and Swagger --> OAS#1280

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

webron
merged 4 commits into

from

Jul 25, 2017
 Merged


Update guidelines for v3 and Swagger --> OAS
#1280
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
c401ae6

Update guidelines for v3 and Swagger --> OAS


usarid Jul 20, 2017
6d40370

Update the references in EXTENSIONS.md to refer to whatever is the cu…


usarid Jul 25, 2017
84f9991

definition -> document


usarid Jul 25, 2017
2070f3c

Add EXTENSIONS.md file at the root of the guidelines folder to avoid …


usarid Jul 25, 2017

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


93 changes: 1 addition & 92 deletions
guidelines/EXTENSIONS.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,92 +1 @@
# Swagger Extensions

The Swagger 2.0 specification allows for custom properties to be added at several places within a Swagger definition, allowing
API providers to extend the meta-data provided for their REST APIs as needed. Extension properties are always 
prefixed by "x-" and can have any valid JSON format value. 

Currently extension properties are supported in the following definition objects:

* within the [info object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#info-object)
* within the [paths object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#paths-object)
* within the [path-item object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#path-item-object)
* within the [operation object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#operationObject) 
* within the [parameter object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#parameterObject)
* within the [responses object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#responses-object)
* within the [tag object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#tag-object)
* within the [security-scheme object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#security-scheme-object)

For example, a vendor extension that adds apis.json specific metadata a Swagger definition might look as follows:

```json
{
 "swagger": "2.0",
 "info": {
 "version": "1.0",
 "title": "Analysis",
 "description" : "Provides access to blog posts and analysis across the API Evangelist network.",
 "x-apis-json" : {
 "image": "https://s3.amazonaws.com/kinlane-productions/api-evangelist/t-shirts/KL_InApiWeTrust-1000.png",
 "humanURL": "http://developer.apievangelist.com",
 "baseURL": "http://api.apievangelist.com/definitions/Analysis",
 "tags": [
 "blog",
 "industry",
 "analysis",
 "new",
 "API",
 "Application Programming Interface"
 ],
 "properties": [
 {
 "type": "X-signup",
 "url": "https://apievangelist.3scale.net/"
 },
 {
 "type": "X-blog",
 "url": "http://developer.apievangelist.com/blog/"
 },
 {
 "type": "X-apicommonsmanifest",
 "url": "https://raw.githubusercontent.com/kinlane/analysis-api/master/api-commons-manifest.json"
 }
 ],
 }
 },
 "basePath": "/",
 "paths": {
 ...
 }
}
```

This could be used by corresponding tooling that builds apis.json files for swagger definitions, the advantage being that all metadata
for a Swagger API is within one definition instead of spread out amongst multiple files.

Another (simplified) example could be how to specify a [JWE encryption](http://hdknr.github.io/docs/identity/jwe.html) policy to parameters,
 for example as follows:

```json
{
 ...
 "socialSecurityNumber": {
 "name": "socialSecurityNumber",
 "in": "query",
 "description": "a social security number",
 "required": false,
 "type": "string",
 "x-jwe-encryption" : {
 "algorithm" : "RSA-OAEP",
 "encryption" : "A256GCM"
 }
 }
 }
 ...
}

```
An API consumer reading these parameter definitions could interpret this as having to encrypt the skip parameter in line
 with the JWE standard.

## Annotations

The Swagger-specific annotations currently available for jax-rs APIs do not support the addition of extension data.
For OpenAPI Specification version 2.0, please see [v2.0/EXTENSIONS.md](v2.0/EXTENSIONS.md)

4 changes: 0 additions & 4 deletions
guidelines/README.md

View file


Open in desktop


This file was deleted.


92 changes: 92 additions & 0 deletions
guidelines/v2.0/EXTENSIONS.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
# OpenAPI Extensions

The OpenAPI Specification version 2.0 allows for custom properties to be added at several places within an OpenAPI document., allowing
API providers to extend the meta-data provided for their REST APIs as needed. Extension properties are always 
prefixed by "x-" and can have any valid JSON format value. 

Currently extension properties are supported in the following definition objects:

* within the [info object](/versions/2.0.md#info-object)
* within the [paths object](/versions/2.0.md#paths-object)
* within the [path-item object](/versions/2.0.md#path-item-object)
* within the [operation object](/versions/2.0.md#operationObject) 
* within the [parameter object](/versions/2.0.md#parameterObject)
* within the [responses object](/versions/2.0.md#responses-object)
* within the [tag object](/versions/2.0.md#tag-object)
* within the [security-scheme object](/versions/2.0.md#security-scheme-object)

For example, a vendor extension that adds apis.json specific metadata to an OpenAPI definition might look as follows:

```json
{
 "swagger": "2.0",
 "info": {
 "version": "1.0",
 "title": "Analysis",
 "description" : "Provides access to blog posts and analysis across the API Evangelist network.",
 "x-apis-json" : {
 "image": "https://s3.amazonaws.com/kinlane-productions/api-evangelist/t-shirts/KL_InApiWeTrust-1000.png",
 "humanURL": "http://developer.apievangelist.com",
 "baseURL": "http://api.apievangelist.com/definitions/Analysis",
 "tags": [
 "blog",
 "industry",
 "analysis",
 "new",
 "API",
 "Application Programming Interface"
 ],
 "properties": [
 {
 "type": "X-signup",
 "url": "https://apievangelist.3scale.net/"
 },
 {
 "type": "X-blog",
 "url": "http://developer.apievangelist.com/blog/"
 },
 {
 "type": "X-apicommonsmanifest",
 "url": "https://raw.githubusercontent.com/kinlane/analysis-api/master/api-commons-manifest.json"
 }
 ],
 }
 },
 "basePath": "/",
 "paths": {
 ...
 }
}
```

This could be used by corresponding tooling that builds apis.json files for OpenAPI definitions, the advantage being that all metadata
for the API is within one definition instead of spread out amongst multiple files.

Another (simplified) example could be how to specify a [JWE encryption](http://hdknr.github.io/docs/identity/jwe.html) policy to parameters,
 for example as follows:

```json
{
 ...
 "socialSecurityNumber": {
 "name": "socialSecurityNumber",
 "in": "query",
 "description": "a social security number",
 "required": false,
 "type": "string",
 "x-jwe-encryption" : {
 "algorithm" : "RSA-OAEP",
 "encryption" : "A256GCM"
 }
 }
 }
 ...
}

```
An API consumer reading these parameter definitions could interpret this as having to encrypt the skip parameter in line
 with the JWE standard.

## Annotations

The OpenAPI-specific annotations currently available for jax-rs APIs do not support the addition of extension data.

4 changes: 4 additions & 0 deletions
guidelines/v2.0/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
## Guidelines for OpenAPI Definitions

* [Reuse](REUSE.md) of OpenAPI definitions
* [Extending](EXTENSIONS.md) OpenAPI definitions with custom metadata

0
guidelines/REUSE.md → guidelines/v2.0/REUSE.md

View file


Open in desktop


File renamed without changes.