apidoc - npm Package Compare versions

Comparing version 0.17.5 to 0.17.6

CHANGELOG.md

 # apiDoc Changelog
 
+#### 0.17.6
+
+* Common
+  * Add Docker image.
+
+* CLI
+  * Add kotlin to default file-filters.
+  * Escape content of success examples.
+
+* Template
+  * Update style.css to have horizontal scrolling for long URLs.
+  * Add Vietnamese translation.
+  * Add Turkish translation.
+  * Blank optional parameters omitted from sample request.
+
+
+#### 0.17.5
+
+* CLI
+  * Bugfix for folder problem.
+
+
 #### 0.17.4
@@ -4,0 +26,0 @@

package.json

 {
   "name": "apidoc",
-  "version": "0.17.5",
+  "version": "0.17.6",
   "description": "RESTful web API Documentation Generator",
@@ -37,6 +37,6 @@ "author": "Peter Rottmann <[e-mail]>",
   "dependencies": {
-    "apidoc-core": "~0.8.1",
-    "fs-extra": "~2.0.0",
+    "apidoc-core": "~0.8.2",
+    "fs-extra": "~3.0.1",
     "lodash": "~4.17.4",
-    "markdown-it": "^8.2.2",
+    "markdown-it": "^8.3.1",
     "nomnom": "~1.8.1",
@@ -49,7 +49,7 @@ "winston": "~2.3.1"
     "lodash-cli": "^4.17.4",
-    "mocha": "~3.2.0",
-    "npm-check-updates": "^2.8.9",
+    "mocha": "~3.4.1",
+    "npm-check-updates": "^2.11.1",
     "path-to-regexp": "^1.7.0",
     "semver": "^5.3.0",
-    "should": "~11.1.2",
+    "should": "~11.2.1",
     "webfontloader": "^1.6.27"
@@ -56,0 +56,0 @@ },

README.md

@@ -18,7 +18,38 @@ # apiDoc
 
+## HELP NEEDED! Search for a Developer
+
+Because of my limited time i need one or more devs that could build and maintain a "Send Sample Request Plugin".
+
+The Plugin should be loose coupled to the template, so it should be a separate project.
+This Plugin should send example data to an API-Endpoint and process the response. Supported formats should be JSON, XML, whatever.
+
+Many issues belong to the current (unmaintained) plugin, (Milestone: Send Sample Request Plugin)(https://github.com/apidoc/apidoc/milestone/4)
+If you want ot work on this, please send me a PM.
+
+
 ## Installation
 
-`npm install apidoc -g`
+```console
+$ npm install apidoc -g
+```
 
+### Alternative docker install
 
+```console
+$ docker pull apidoc/apidoc
+```
+
+Then you will need to mount your file storage `-v '<apidoc.json dir>:/apidoc'` to docker container.
+
+Example:
+
+```console
+$ docker run --rm -v '$(PWD):/apidoc' -it apidoc/apidoc \
+    --input ./example \
+    --output ./docker-example \
+    -v
+```
+
+Creates from input files in `example/` a documentation in path `docker-example/`.
+
 ## Changelog
@@ -44,3 +75,5 @@
 
-`apidoc -i example/ -o doc/`
+```console
+$ apidoc -i example/ -o doc/
+```
 
@@ -47,0 +80,0 @@ Creates from input files in `example/` a documentation in path `doc/`.

template/locales/locale.js

@@ -12,2 +12,4 @@ define([
     './locales/ru.js',
+    './locales/tr.js',
+    './locales/vi.js',
     './locales/zh.js',
@@ -14,0 +16,0 @@ './locales/zh_cn.js'

template/utils/send_sample_request.js

@@ -53,3 +53,5 @@ define([
           var group = $(element).data("sample-request-param-group-id");
-          $root.find("[data-sample-request-param-group=\"" + group + "\"]").each(function(i, element) {
+          $root.find("[data-sample-request-param-group=\"" + group + "\"]").not(function(){
+            return $(this).val() == "" && $(this).is("[data-sample-request-param-optional='true']");
+          }).each(function(i, element) {
             var key = $(element).data("sample-request-param-name");
@@ -56,0 +58,0 @@ var value = element.value;

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

986023

increased by0.44%

Number of package files

115

increased by2.68%

Lines of code

5668

increased by0.98%

Number of lines in readme file

196

increased by20.25%

Dependency changes

• - Removedfs-extra@2.0.0(transitive)

• - Removedjsonfile@2.4.0(transitive)

• Updatedapidoc-core@~0.8.2

• Updatedfs-extra@~3.0.1

• Updatedmarkdown-it@^8.3.1