swagger-client 2.1.29 → 2.2.21

package/README.md

@@ -36,7 +36,7 @@ var client = new Swagger({
 });
 ```
 
-NOTE: we're explicitly setting the responseContentType, because we don't want you getting stuck when
+NOTE: we're explicitly setting the responseContentType, because we don't want you getting stuck when 
 there is more than one content type available.
 
 That's it!  You'll get a JSON response with the default callback handler:
@@ -106,50 +106,17 @@ new Swagger({
     });
 });
 ```
-### Authorization
 
-Need to pass an API key? Ok, lets do it for this sample `swagger.yml`:
-
-```yaml
-# ...
-
-securityDefinitions:
-
-  api_scheme_name:           # swagger scheme name
-    type: apiKey            # swagger type (one of "basic", "apiKey" or "oauth2")
-    name: queryParamName    # The name of the header or query parameter to be used
-    in: query               # location of the API key
-
-  api_scheme_name_2:
-    type: apiKey
-    name: X-KEY-PARAM
-    in: header
-
-# ...
-```
-
-Configure auth for that definition in your client instance as a *query string*:
+Need to pass an API key?  Configure one in your client instance as a query string:
 
 ```js
-client.clientAuthorizations.add("api_scheme_name",
-  new Swagger.ApiKeyAuthorization(
-    "queryParamName",
-    "<YOUR-SECRET-KEY>",
-    "query"
-  )
-);
+client.clientAuthorizations.add("apiKey", new Swagger.ApiKeyAuthorization("api_key","special-key","query"));
 ```
 
-...or with a *header*:
+...or with a header:
 
 ```js
-client.clientAuthorizations.add("api_scheme_name_2",
-  new Swagger.ApiKeyAuthorization(
-    "X-KEY-PARAM",
-    "<YOUR-SECRET-KEY>",
-    "header"
-  )
-);
+client.clientAuthorizations.add("apiKey", new Swagger.ApiKeyAuthorization("api_key","special-key","header"));
 ```
 
 ...or with the swagger-client constructor:
@@ -332,45 +299,6 @@ var client = new SwaggerClient({
 });
 ```
 
-You can also pass in your own version superagent (if, for example, you have other superagent plugins etc that you want to use)
-
-var agent = require('some-other-special-superagent');
-
-var client = new SwaggerClient({
-  spec: petstoreRaw,
-  requestAgent: agent,
-  success: function () {
-    client.pet.getPetById({petId: 3}, function(data){
-      expect(data).toBe('ok');
-      done();
-    });
-  }
-});
-```
-
-### Using custom http(s) agent
-In case if you need to sign all requests to petstore with custom certificate
-
-```js
-var connectionAgent = {
-    rejectUnauthorized: false,
-    key: "/certs/example.key",
-    cert: "/certs/example.pem",
-    ca: ["/certs/example.ca.pem"]
-}
-
-var client = new SwaggerClient({
-  url: "http://petstore.swagger.io/v2/swagger.json",
-  connectionAgent: connectionAgent,
-  success: function() {
-    // upon connect, fetch a pet and set contents to element "mydata"
-    client.pet.getPetById({petId:1},{responseContentType: 'application/json'}, function(data) {
-      document.getElementById("mydata").innerHTML = JSON.stringify(data.obj);
-    });
-  }
-});
-```
-
 ### How does it work?
 The swagger javascript client reads the swagger api definition directly from the server.  As it does, it constructs a client based on the api definition, which means it is completely dynamic.  It even reads the api text descriptions (which are intended for humans!) and provides help if you need it: