Feature/documentation tab

[55]

Closes #929
Closes #1006
Closes #871
Closes #663
Closes #948
Closes #887
Closes #938
Closes #367
Closes #465
Closes #1042

[55]

Current look of the documentation view:

• added panels

[frenchbread]

Please add permissions check here.

[brylie]

We should at least check for a Meteor.userId in the allow rule.

[brylie]

We still need an s-alert for the AutoForm onSuccess. E.g. when changing the documentation URL. Cing @Nazarah

[brylie]

When no documentation link is available, display the following text:

No documentation link is available. You can add one using Manage API feature.

[frenchbread]

Since there is no build-in check for file type/extension, we can at least provide minimal check for expected file types eg. ['yaml', 'yml', 'json'].

file.file.name - contains filename with extension (e.g. swagger.json)

file.file.type - provides filetype (e.g. application/json)

[frenchbread]

There is similar method written for "import api backend" feature:

Method:

// function attached to template instance checks file extension
instance.endsWith = function (filename, suffixList) {

  // variable that keeps state of is this filename contains provided extensions - false by default
  var state = false;

  // iterating through extensions passed into suffixList array
  for (var i=0; i <suffixList.length; i++){

    // parses line to check if filename contains current suffix
    var endsWith = filename.indexOf(suffixList[i], filename.length - suffixList[i].length) !== -1;

    // if current extension found in filename then change the state variable
    if (endsWith) state = true;

  }

  return state;
};

Reuse:

const acceptedExtensions = ["yaml", "yml", "txt", "json"];

if (instance.endsWith(file.name, acceptedExtensions)) {
  // proceed with file upload
}

[frenchbread]

Reviewing

[brylie]

This href is not working as expected. It should provide a link to the documentation file, but currently has only a hash.