prepare for release

This commit is contained in:
Tony Tam
2015-03-28 19:42:11 -07:00
parent 62546445d9
commit b6bf8c2b47
6 changed files with 18 additions and 16 deletions

View File

@@ -20,7 +20,7 @@ The Swagger Specification has undergone 4 revisions since initial creation in 20
Swagger UI Version | Release Date | Swagger Spec compatibility | Notes | Status
------------------ | ------------ | -------------------------- | ----- | ------
2.1.5-M1 | 2015-02-18 | 1.1, 1.2, 2.0 | [master](https://github.com/swagger-api/swagger-ui) |
2.1.0-M2 | 2015-03-28 | 1.1, 1.2, 2.0 | [master](https://github.com/swagger-api/swagger-ui) |
2.0.24 | 2014-09-12 | 1.1, 1.2 | [tag v2.0.24](https://github.com/swagger-api/swagger-ui/tree/v2.0.24) |
1.0.13 | 2013-03-08 | 1.1, 1.2 | [tag v1.0.13](https://github.com/swagger-api/swagger-ui/tree/v1.0.13) |
1.0.1 | 2011-10-11 | 1.0, 1.1 | [tag v1.0.1](https://github.com/swagger-api/swagger-ui/tree/v1.0.1) |
@@ -53,6 +53,7 @@ docker run -p 127.0.0.1:8080:8080 swagger-ui-builder
```
This will start Swagger UI at `http://localhost:8080`.
### Use
Once you open the Swagger UI, it will load the [Swagger Petstore](http://petstore.swagger.io/v2/swagger.json) service and show its APIs. You can enter your own server url and click explore to view the API.
@@ -60,7 +61,7 @@ Once you open the Swagger UI, it will load the [Swagger Petstore](http://petstor
You may choose to customize Swagger UI for your organization. Here is an overview of whats in its various directories:
- dist: Contains a distribution which you can deploy on a server or load from your local machine.
- dist/lang: The swagger localisation
- dist/lang: The swagger localization
- lib: Contains javascript dependencies which swagger-ui depends on
- node_modules: Contains node modules which swagger-ui uses for its development.
- src
@@ -72,12 +73,12 @@ You may choose to customize Swagger UI for your organization. Here is an overvie
To use swagger-ui you should take a look at the [source of swagger-ui html page](https://github.com/swagger-api/swagger-ui/blob/master/dist/index.html) and customize it. This basically requires you to instantiate a SwaggerUi object and call load() on it as below:
```javascript
var swaggerUi = new SwaggerUi({
var swaggerUi = new SwaggerUi({
url:"http://petstore.swagger.io/v2/swagger.json",
dom_id:"swagger-ui-container"
});
});
swaggerUi.load();
swaggerUi.load();
```
##### Parameters
@@ -147,8 +148,8 @@ To append new lexemex for translation you shoul do two things:
2. Mark this lexeme in source html with attribute data-sw-translate.
Example of changed source:
```html
<anyHtmlTag data-sw-translate>new sentence</anyHtmlTag>
or <anyHtmlTag data-sw-translate value='new sentence'/>
<anyHtmlTag data-sw-translate>new sentence</anyHtmlTag>
or <anyHtmlTag data-sw-translate value='new sentence'/>
```
.
@@ -219,7 +220,7 @@ Only headers with these names will be allowed to be sent by Swagger-UI.
Create your own fork of [swagger-api/swagger-ui](https://github.com/swagger-api/swagger-ui)
To share your changes, [submit a pull request](https://github.com/swagger-api/swagger-ui/pull/new/master).
To share your changes, [submit a pull request](https://github.com/swagger-api/swagger-ui/pull/new/develop_2.0).
## Change Log
Plsee see [releases](https://github.com/swagger-api/swagger-ui/releases) for change log.

3
dist/swagger-ui.js vendored
View File

@@ -20582,7 +20582,7 @@ SwaggerUi.Views.HeaderView = Backbone.View.extend({
showPetStore: function(){
this.trigger('update-swagger-ui', {
url:'http://petstore.swagger.wordnik.com/api/api-docs'
url:'http://petstore.swagger.io/v2/swagger.json'
});
},
@@ -20622,6 +20622,7 @@ SwaggerUi.Views.HeaderView = Backbone.View.extend({
}
}
});
'use strict';
SwaggerUi.Views.MainView = Backbone.View.extend({

File diff suppressed because one or more lines are too long

View File

@@ -13,7 +13,7 @@ SwaggerUi.Views.HeaderView = Backbone.View.extend({
showPetStore: function(){
this.trigger('update-swagger-ui', {
url:'http://petstore.swagger.wordnik.com/api/api-docs'
url:'http://petstore.swagger.io/v2/swagger.json'
});
},

View File

@@ -53,7 +53,7 @@
"title": "Swagger Sample App",
"description": "This is a sample server Petstore server. You can find out more about Swagger \n at <a href=\"http://swagger.io\">http://swagger.io</a> or on irc.freenode.net, #swagger. For this sample,\n you can use the api key \"special-key\" to test the authorization filters",
"termsOfServiceUrl": "http://helloreverb.com/terms/",
"contact": "apiteam@wordnik.com",
"contact": "apiteam@swagger.io",
"license": "Apache 2.0",
"licenseUrl": "http://www.apache.org/licenses/LICENSE-2.0.html"
}

View File

@@ -8,7 +8,7 @@
"contact": {
"url": "http://swagger.io",
"name": "Your pals at Swagger",
"email": "apiteam@wordnik.com"
"email": "apiteam@swagger.io"
},
"license": {
"name": "Apache 2.0",