Generating api-spec with Scriptappy #508
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
miralemd
reviewed
Sep 14, 2018
src/qix.js
Outdated
| * @interface Mixin | ||
| * @property {String|Array<String>} types String or array of strings containing the API-types that | ||
| * will be mixed in. | ||
| * @param {Object} [extend] Object literal containing the methods that will be extended on the |
There was a problem hiding this comment.
I think all of these should be @property instead of @param
miralemd
reviewed
Sep 14, 2018
src/intercept.js
Outdated
| /** | ||
| * This method is invoked when a request is about to be sent to QIX Engine. | ||
| * @function InterceptorRequest#onFulfilled | ||
| * @param {Object} session The session executing the interceptor. |
There was a problem hiding this comment.
might as well use Session as type here since its' defined in session.js
miralemd
reviewed
Sep 14, 2018
src/qix.js
Outdated
| * @property {String} genericType Corresponds to the qInfo.qType property on the generic object's | ||
| * properties object. | ||
| * @property {Object} session Contains a reference to the session that this API belongs to. | ||
| * @property {String} handle Contains the handle QIX Engine assigned to the API. Used interally in |
miralemd
reviewed
Sep 14, 2018
src/qix.js
Outdated
| * @property {String} type Contains the schema class name for this API. | ||
| * @property {String} genericType Corresponds to the qInfo.qType property on the generic object's | ||
| * properties object. | ||
| * @property {Object} session Contains a reference to the session that this API belongs to. |
miralemd
reviewed
Sep 14, 2018
src/qix.js
Outdated
| * @param {Object} config The configuration object for the QIX session. | ||
| * @returns {Session} Returns a new QIX session. | ||
| * @param {Configuration} config The configuration object for the QIX session. | ||
| * @returns {Object} Returns a new QIX session. |
peol
approved these changes
Sep 14, 2018
| @@ -0,0 +1,442 @@ | |||
| { | |||
| "scriptappy": "1.0.0", | |||
There was a problem hiding this comment.
What does this version mean? Is this the API spec version?
There was a problem hiding this comment.
It's scriptappy schema version..
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.