Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge branch 'devel' of https://github.com/arangodb/arangodb into devel

This commit is contained in:
jsteemann 2017-03-01 12:53:16 +01:00
parent 0ac29eb177 6495e12aa1
commit ec60cf817b
3 changed files with 32 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG
View File

@ -71,6 +71,8 @@ v3.2.alpha1 (2017-02-05)
* more detailed stacktraces in Foxx apps * more detailed stacktraces in Foxx apps
* add support for Swagger tags in Foxx
v3.1.12 (XXXX-XX-XX) v3.1.12 (XXXX-XX-XX)
-------------------- --------------------

27
Documentation/Books/Manual/Foxx/Router/Endpoints.mdpp
View File

@ -372,3 +372,30 @@ Returns the endpoint.
router.get(/* ... */) router.get(/* ... */)
.deprecated(); .deprecated();
``` ```
tag
---
`endpoint.tag(...tags): this`
Marks the endpoint with the given tags that will be used to group related routes in the generated API documentation.
If the endpoint is a child router, all routes of that router will also be marked with the tags. If the endpoint is a middleware, this method has no effect.
This method only affects the generated API documentation and has not other effect within the service itself.
**Arguments**
* **tags**: `string`
One or more strings that will be used to group the endpoint's routes.
Returns the endpoint.
**Examples**
```js
router.get(/* ... */)
.tag('auth', 'restricted');
```

4
Documentation/Books/Manual/ReleaseNotes/NewFeatures32.mdpp
View File

@ -59,4 +59,6 @@ Foxx
The [cookie session transport](../Foxx/Sessions/Transports/Cookie.md) now supports all options supported by the [cookie method of the response object](../Foxx/Router/Response.md#cookie). The [cookie session transport](../Foxx/Sessions/Transports/Cookie.md) now supports all options supported by the [cookie method of the response object](../Foxx/Router/Response.md#cookie).
It's now possible to provide your own version of the `graphql-sync` module when using the [GraphQL extensions for Foxx](../Foxx/GraphQL.md) by passing a copy of the module using the new _graphql_ option. It's now possible to provide your own version of the `graphql-sync` module when using the [GraphQL extensions for Foxx](../Foxx/GraphQL.md) by passing a copy of the module using the new _graphql_ option.
Endpoints can now be tagged using the [tag method](../Foxx/Router/Endpoints.md#tag) to generate a cleaner Swagger documentation.