Merge pull request #4 from janslow/feature/x-apis

Rename `apis` property to `x-apis`
prestonvanloon · May 17, 2016 · 5bc533a · 5bc533a
2 parents de5ffa9 + 9f16b1c
commit 5bc533a
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -20,13 +20,13 @@ info:
 
 basePath: /v2
 
-apis:
+x-apis:
     pet: https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v2.0/yaml/petstore.yaml
     uber: https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v2.0/json/uber.json
     trains: local/file/trains.yaml
 ```
 
-The `apis` property is the list of external or local schemas to aggregate.
+The `x-apis` property is the list of external or local schemas to aggregate.
 
 To use `swagger-aggregator`, simply require it and pass the file name to aggregate. `swagger-aggregator` returns a promise with the JSON object result.
 

diff --git a/index.js b/index.js
@@ -9,10 +9,10 @@ const stripFields = require('./lib/stripFields');
 
 function swaggerAggregator(file) {
   const doc = yaml.safeLoad(fs.readFileSync(file, 'utf8'));
-  const keys = Object.keys(doc.apis);
+  const keys = Object.keys(doc['x-apis']);
 
   const pending = keys.map(key => {
-    return getSwagger(doc.apis[key]);
+    return getSwagger(doc['x-apis'][key]);
   });
 
   return Promise.all(pending)

diff --git a/lib/stripFields.js b/lib/stripFields.js
@@ -2,7 +2,7 @@
 
 const _ = require('ramda');
 
-const fields = ['exclude_paths', 'exclude_fields', 'apis'];
+const fields = ['x-exclude_paths', 'x-exclude_fields', 'x-apis'];
 
 function stripFields(doc) {
   return _.omit(fields, doc);

diff --git a/test/stripFields.spec.js b/test/stripFields.spec.js
@@ -2,11 +2,11 @@
 
 const expect = require('chai').expect;
 
-const fields = ['exclude_paths', 'exclude_fields', 'apis'];
+const fields = ['x-exclude_paths', 'x-exclude_fields', 'x-apis'];
 const obj = {
-  exclude_paths: 'asdf',
-  exclude_fields: 'asdf',
-  apis: 'apis'
+  'x-exclude_paths': 'asdf',
+  'x-exclude_fields': 'asdf',
+  'x-apis': 'apis'
 };
 
 const stripFields = require('../lib/stripFields');

diff --git a/test/swagger.yaml b/test/swagger.yaml
@@ -5,15 +5,15 @@ info:
 
 basePath: /v2
 
-apis:
+x-apis:
     pet: https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v2.0/yaml/petstore.yaml
     uber: https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v2.0/json/uber.json
 
 # TODO
-exclude_paths:
+x-exclude_paths:
   - DELETE /pets/{petId}
 
 # TODO
-exclude_fields:
+x-exclude_fields:
   petPet:
     - id