Miroslav Bajtoš
dc815a8421
Refactor conversion of data types
...
Refactor the way how loopback types are converted to swagger data types.
- `modelHelper.LDLPropToSwaggerDataType` is responsible for
producing a valid Swagger Data Type object from LDL object
(be it a property, accepts item or returns item).
- LDLPropToSwaggerDataType picks only fields that are part
of the swagger spec, everything else is excluded from the result.
It's up to the caller to add extra fields like `description`.
- refactor `routeHelper.extendWithType` to accept an additional arg:
the original LDL object. This way it's possible to copy all
type-specific fields to the output object and don't add anything
else.
2014-10-16 08:47:18 +02:00
Miroslav Bajtoš
42dedfcacc
Move `convertText` to `typeConverter`
...
Create a new module `lib/type-converter.js`.
Move `routeHelper.convertText` to this new module.
2014-10-16 08:46:37 +02:00
Krishna Raman
856d34b9d4
Add support for `context` and `res` param types
2014-10-15 09:37:03 -07:00
Miroslav Bajtoš
705776517b
Support multi-line array `description` and `notes`
...
When a string value is expected and the user supplied an array,
convert the value to a single string by joining all array items.
2014-10-13 19:32:09 +02:00
Miroslav Bajtoš
be36f11629
Use `1.0.0` as the default app version.
...
Change the default version number returned when the version number
cannot be read from `package.json` in CWD.
2014-10-13 17:30:19 +02:00
Miroslav Bajtoš
622f6176f3
Extend `consumes` and `produces` metadata
...
- Include XML content-types for both input and output
- Include JSONP (javascript) content-types for output
2014-10-13 17:29:37 +02:00
Miroslav Bajtoš
4d0e711087
route-helper: include `notes` and `deprecated`
2014-10-13 16:32:12 +02:00
Shelby Sanders
37179f3e61
Pull model description from ctor.settings first
2014-10-13 15:27:15 +02:00
Miroslav Bajtoš
f645c6db0d
swagger: allow cross-origin requests
...
Add CORS middleware to the swagger app.
Add a configuration option allowing developers to disable CORS.
2014-10-08 07:57:50 +02:00
Raymond Feng
282b70e1e4
Fix how the array of models is iterated
...
https://github.com/strongloop/loopback-explorer/issues/49
2014-09-19 09:35:11 -07:00
Clark Wang
acf00f3254
Make sure nested/referenced models in array are mapped to swagger
...
Signed-off-by: Clark Wang <clark.wangs@gmail.com>
2014-08-29 16:06:05 +08:00
Raymond Feng
d083feab36
Make sure nested/referenced models are mapped to swagger
2014-08-28 15:20:03 -07:00
Raymond Feng
0d182939a0
Merge pull request #38 from STRML/form-encoding
...
Newest Swagger UI requires application/x-www-form-urlencoded.
2014-08-15 23:36:34 -07:00
Samuel Reed
d98a7877d4
Newest Swagger UI requires application/x-www-form-urlencoded.
...
UI will fail to POST if this consumes type is not specified.
2014-08-12 12:45:38 -04:00
Navid Nikpour
bda9e5f627
Fixed undefined modelClass when using polymorphic relations
2014-08-10 08:46:24 +02:00
Raymond Feng
bf3a2c9764
Fix the type name for a property if model class is used
...
See https://github.com/strongloop/loopback-explorer/issues/32
2014-08-04 23:22:41 -07:00
Raymond Feng
689a2f6a86
Merge pull request #29 from strongloop/feature/workaround-lb-issue-432
...
Set up default consumes/produces media types
2014-08-04 08:37:45 -07:00
Ritchie Martori
e30df1de93
Merge pull request #27 from strongloop/fix/array-items-any
...
Add required swagger 1.2 items property for property type array
2014-08-04 08:34:59 -07:00
Raymond Feng
0aa476a682
Set up default consumes/produces media types
...
See:
https://github.com/strongloop/loopback/issues/432
https://github.com/wordnik/swagger-js/issues/107
2014-08-03 21:48:16 -07:00
Raymond Feng
df459ffc8b
Fix the default opts
2014-07-31 16:47:47 -07:00
Raymond Feng
3c8f3b1dd0
Merge branch 'protocol' of github.com:STRML/loopback-explorer into STRML-protocol
2014-07-31 16:45:32 -07:00
Ritchie Martori
f7734fe5b3
Add required swagger 1.2 items property for property type array
2014-07-31 16:33:02 -07:00
Geoffroy
f6970db749
res.send deprecated - updated to res.status
...
Used to get warning: 'express deprecated res.send(status, body): Use
res.status(status).send(body) instead
node_modules/loopback-explorer/lib/swagger.js:105:9'
2014-07-28 17:40:08 -05:00
Samuel Reed
32f0f5e37d
Allow passing a custom protocol.
...
This allows swagger definitions to work properly when the API is behind
an SSL terminator.
2014-07-27 21:44:14 -05:00
Samuel Reed
a9ecfecde5
Remove hidden properties from definition.
2014-07-26 12:15:47 -05:00
Raymond Feng
078649f990
Ensure models from relations are included
2014-07-24 13:35:02 -07:00
Miroslav Bajtoš
536fa4c577
model-helper: handle arrays with undefined items
2014-07-22 21:52:25 +02:00
Miroslav Bajtoš
a92450eaf0
model-helper: handle array types with no item type
2014-07-22 21:34:42 +02:00
Samuel Reed
84e9486062
Properly convert complex return types.
...
Attached tests.
2014-07-20 20:04:10 -05:00
Samuel Reed
6319572a55
Fix up loopback.rest() model definition hack.
...
In its previous form, array return types were being returned simply
as {type: 'array'}, with their `items` definition forgotten.
2014-07-18 17:31:43 -05:00
Samuel Reed
5c130a4b3d
Fix debug namespace, express version.
2014-07-11 14:22:18 -04:00
Samuel Reed
4b3785c0b2
Simplify `accepts` and `returns` hacks.
2014-07-11 10:03:58 -04:00
Samuel Reed
75713f16f2
Add url-join so path.join() doesn't break windows
2014-07-10 14:09:57 -05:00
Samuel Reed
781ac2bd12
Rename translateKeys to translateDataTypeKeys.
2014-07-10 14:09:57 -05:00
Samuel Reed
3ce35e1431
Refactor route-helper & add tests.
...
- Uses model-helper to parse types for swagger.
- Separated returns & accepts hacks.
- Documentation fixes
- TODO add param regex
2014-07-10 14:09:57 -05:00
Samuel Reed
77f01670de
LDL to Swagger fixes & extensions.
...
- Supports all three LDL array type specifications.
- Added model-helper tests.
- translate-keys no longer modifies the incoming object.
- Non-primitive types are now correctly converted into a primitive
with a `format` attribute.
- `id` properties are not assumed to be required if they are generated.
2014-07-10 12:07:19 -05:00
Samuel Reed
70dddef296
Use express routes instead of modifying remoting.
...
This completes the migration of swagger processing from strong-remoting
into loopback-explorer.
Added additional usage instructions to README and additional testing.
This commit introduces a change into where resource descriptors
are hosted. They are no longer hosted under /swagger, but instead
under the same path as the Explorer, wherever that may be.
Generally, the resource listing will be available at
/explorer/resources, and api listings under
/explorer/resources/{modelName}.
2014-07-09 18:13:47 -05:00
Samuel Reed
a4a36f5602
Refactor key translations between LDL & Swagger.
...
Route.accepts & route.returns can now share these translations.
2014-07-06 09:50:24 -05:00
Samuel Reed
4c0ce42001
Refactoring swagger 1.2 rework.
...
Added comments, api version, and better Swagger 1.2 compat.
2014-07-05 14:32:00 -05:00
Raymond Feng
d34304afc3
Make sure body parameter is shown.
2014-07-05 10:21:06 -07:00
Samuel Reed
67bb10b6a4
Some swagger 1.2 migration cleanup.
...
- Added array items definition.
- Ignored body when specified via arg.http.source.
2014-07-05 10:54:19 -05:00
Raymond Feng
2f8506c81b
Fix api resource path and type ref to models.
2014-07-05 00:30:26 -07:00
Samuel Reed
eb31787fbc
Swagger 1.2 compatability. Moved strong-remoting/ext/swagger to this module.
...
Will now correctly return model schemas.
Moved swagger.js tests to this module.
2014-07-04 17:09:03 -05:00