Skip to content

Commit b6bf8c2

Browse files
committed
prepare for release
1 parent 6254644 commit b6bf8c2

File tree

6 files changed

+18
-16
lines changed

6 files changed

+18
-16
lines changed

Diff for: README.md

+11-10
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The Swagger Specification has undergone 4 revisions since initial creation in 20
2020

2121
Swagger UI Version | Release Date | Swagger Spec compatibility | Notes | Status
2222
------------------ | ------------ | -------------------------- | ----- | ------
23-
2.1.5-M1 | 2015-02-18 | 1.1, 1.2, 2.0 | [master](https://github.com/swagger-api/swagger-ui) |
23+
2.1.0-M2 | 2015-03-28 | 1.1, 1.2, 2.0 | [master](https://github.com/swagger-api/swagger-ui) |
2424
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) |
2525
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) |
2626
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,14 +53,15 @@ docker run -p 127.0.0.1:8080:8080 swagger-ui-builder
5353
```
5454

5555
This will start Swagger UI at `http://localhost:8080`.
56+
5657
### Use
5758
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.
5859

5960
### Customize
6061
You may choose to customize Swagger UI for your organization. Here is an overview of whats in its various directories:
6162

6263
- dist: Contains a distribution which you can deploy on a server or load from your local machine.
63-
- dist/lang: The swagger localisation
64+
- dist/lang: The swagger localization
6465
- lib: Contains javascript dependencies which swagger-ui depends on
6566
- node_modules: Contains node modules which swagger-ui uses for its development.
6667
- src
@@ -72,12 +73,12 @@ You may choose to customize Swagger UI for your organization. Here is an overvie
7273
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:
7374

7475
```javascript
75-
var swaggerUi = new SwaggerUi({
76-
url:"http://petstore.swagger.io/v2/swagger.json",
77-
dom_id:"swagger-ui-container"
78-
});
76+
var swaggerUi = new SwaggerUi({
77+
url:"http://petstore.swagger.io/v2/swagger.json",
78+
dom_id:"swagger-ui-container"
79+
});
7980

80-
swaggerUi.load();
81+
swaggerUi.load();
8182
```
8283

8384
##### Parameters
@@ -147,8 +148,8 @@ To append new lexemex for translation you shoul do two things:
147148
2. Mark this lexeme in source html with attribute data-sw-translate.
148149
Example of changed source:
149150
```html
150-
<anyHtmlTag data-sw-translate>new sentence</anyHtmlTag>
151-
or <anyHtmlTag data-sw-translate value='new sentence'/>
151+
<anyHtmlTag data-sw-translate>new sentence</anyHtmlTag>
152+
or <anyHtmlTag data-sw-translate value='new sentence'/>
152153
```
153154
.
154155

@@ -219,7 +220,7 @@ Only headers with these names will be allowed to be sent by Swagger-UI.
219220

220221
Create your own fork of [swagger-api/swagger-ui](https://github.com/swagger-api/swagger-ui)
221222

222-
To share your changes, [submit a pull request](https://github.com/swagger-api/swagger-ui/pull/new/master).
223+
To share your changes, [submit a pull request](https://github.com/swagger-api/swagger-ui/pull/new/develop_2.0).
223224

224225
## Change Log
225226
Plsee see [releases](https://github.com/swagger-api/swagger-ui/releases) for change log.

Diff for: dist/swagger-ui.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -20582,7 +20582,7 @@ SwaggerUi.Views.HeaderView = Backbone.View.extend({
2058220582

2058320583
showPetStore: function(){
2058420584
this.trigger('update-swagger-ui', {
20585-
url:'http://petstore.swagger.wordnik.com/api/api-docs'
20585+
url:'http://petstore.swagger.io/v2/swagger.json'
2058620586
});
2058720587
},
2058820588

@@ -20622,6 +20622,7 @@ SwaggerUi.Views.HeaderView = Backbone.View.extend({
2062220622
}
2062320623
}
2062420624
});
20625+
2062520626
'use strict';
2062620627

2062720628
SwaggerUi.Views.MainView = Backbone.View.extend({

Diff for: dist/swagger-ui.min.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: src/main/javascript/view/HeaderView.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ SwaggerUi.Views.HeaderView = Backbone.View.extend({
1313

1414
showPetStore: function(){
1515
this.trigger('update-swagger-ui', {
16-
url:'http://petstore.swagger.wordnik.com/api/api-docs'
16+
url:'http://petstore.swagger.io/v2/swagger.json'
1717
});
1818
},
1919

@@ -52,4 +52,4 @@ SwaggerUi.Views.HeaderView = Backbone.View.extend({
5252
this.trigger('update-swagger-ui', {url:url});
5353
}
5454
}
55-
});
55+
});

Diff for: test/specs/v1.2/petstore/api-docs.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
"title": "Swagger Sample App",
5454
"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",
5555
"termsOfServiceUrl": "http://helloreverb.com/terms/",
56-
"contact": "apiteam@wordnik.com",
56+
"contact": "apiteam@swagger.io",
5757
"license": "Apache 2.0",
5858
"licenseUrl": "http://www.apache.org/licenses/LICENSE-2.0.html"
5959
}

Diff for: test/specs/v2/petstore.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"contact": {
99
"url": "http://swagger.io",
1010
"name": "Your pals at Swagger",
11-
"email": "apiteam@wordnik.com"
11+
"email": "apiteam@swagger.io"
1212
},
1313
"license": {
1414
"name": "Apache 2.0",

0 commit comments

Comments
 (0)