Swagger api calls #17

darvid7 · 2018-04-22T18:19:26Z

Add Swagger Codegen API call

need to make it support *.yaml files, it just supports json for now.

darvid7 · 2018-04-22T18:20:25Z

Does anyone know how to change the diffbase?
There is some stuff here that #16 does but the diff still shows :(

Not sure if we can do this:

PatrickShaw · 2018-04-23T12:27:15Z

src/backend/specifications.tsx

@@ -1,5 +1,6 @@
 import { Specification } from 'model/Specification';
 import { BuildStatus } from 'model/SDK';
+import { isUndefined } from 'util';


@darvid7 Why do you need this? It's a deprecated method for one thing.

Ty for pointing that out, idk webstorm just prompted me to use it :P

PatrickShaw · 2018-04-23T12:28:37Z

src/backend/specifications.tsx

@@ -42,6 +53,11 @@ const specifications: Specification[] = [
 * @return {Specification | undefined} - returns the Specification with the matching id if it exists
 */
 export function getSpecificationById(id: number): Specification | undefined {
+ // TODO: Remove this later.
+ if (isUndefined(id)) {


Why do we get the last item if we don't specify an id? The parameter doesn't allow for undefined values.

When trying to implement it was always undefined so I just added it to show it can work.
Also the type being Specification | undefined, doesn't that allow it to be undefined?

No as in id is never undefined (as specified by the parameter type) so why account for id being undefined if the function explicitly says that id will only ever be a number (i.e. never be undefined)

That is true, idk what I was thinking. Thanks for pointing it out!

PatrickShaw · 2018-04-23T12:29:34Z

src/client/sdkGeneration.tsx

+ console.log('generateSdk');
+ let body = { swaggerUrl: spec['path'] };
+ console.log(body);
+ return fetch(SWAGGER_CODEGEN_ENDPOINT + 'python', {


Can we change this to use await?

Change .then()s to await

Does this mean we need to nest them somehow because there are two .thens()?

Figured out how to :) although if you know what .json() does pls lmk

PatrickShaw · 2018-04-23T12:36:09Z

src/client/sdkGeneration.tsx

+ if ('type' in json && json['type'] == 'error') {
+ return BAD_SPECIFICATION;
+ }
+ return json['link'];


Please use json.type and json.link rather than json['link']

Change ['xx'] syntax to .xx

Didn't know this was a thing, ty

PatrickShaw · 2018-04-23T12:39:06Z

src/client/sdkGeneration.tsx

+import fetch from 'node-fetch';
+
+const SWAGGER_CODEGEN_ENDPOINT = 'http://generator.swagger.io/api/gen/clients/';
+const BAD_SPECIFICATION = 'Error: Bad specification';

 export async function generateSdk(spec: Specification): Promise<string> {


I'm surprised this passed the checker:types test. By the looks of things, generateSdk doesn't return Promise<string> anymore. Can we make this something less wrong for now? (E.g. Promise<any> or something similar?)

Change the return type of generateSdk

PatrickShaw · 2018-04-23T12:39:47Z

src/client/sdkGeneration.tsx

+ // TODO: Get it working for .yaml files like below.
+ // 'https:/OAI/OpenAPI-Specification/blob/master/examples/v2.0/yaml/uber.yaml' }
+ console.log('generateSdk');
+ let body = { swaggerUrl: spec['path'] };


spec.path rather than spec['path']

… return type

darvid7 · 2018-04-23T14:48:20Z

@PatrickShaw Please take another look, made all changes except the getting last item if an id is not specified.

Wasn't any point having it since id is never undefined

PatrickShaw

I think this LGTM now 👍

PatrickShaw · 2018-04-23T15:59:41Z

src/backend/specifications.tsx

@@ -42,6 +53,11 @@ const specifications: Specification[] = [
 * @return {Specification | undefined} - returns the Specification with the matching id if it exists
 */
 export function getSpecificationById(id: number): Specification | undefined {
+ // TODO: Remove this later.
+ if (isUndefined(id)) {


No as in id is never undefined (as specified by the parameter type) so why account for id being undefined if the function explicitly says that id will only ever be a number (i.e. never be undefined)

General Updates Just going to merge it now cuz I forgot to merge it before #17 and idk what is going to happen to the git tree now :)

gammmaf added 3 commits April 23, 2018 00:52

Update github URL

d301ee6

Add .idea to gitignore

cdf9746

Add Swagger API call

f01e09d

darvid7 requested review from PatrickShaw and TimGebert April 22, 2018 18:19

PatrickShaw reviewed Apr 23, 2018

View reviewed changes

PatrickShaw requested changes Apr 23, 2018

View reviewed changes

gammmaf added 2 commits April 24, 2018 00:24

remove isUndefined, changed json accessing syntax, change generateSdk…

8a688fe

… return type

Change .then() to await

27a16d9

Removed id undefined check in getSpecificationById

23fee9c

Wasn't any point having it since id is never undefined

PatrickShaw approved these changes Apr 23, 2018

View reviewed changes

Removed let variables in favour of const

6ce5d02

darvid7 merged commit 94adf81 into telstra:development Apr 24, 2018

darvid7 added a commit that referenced this pull request Apr 24, 2018

Merge pull request #16 from darvid7/updates

280deaf

General Updates Just going to merge it now cuz I forgot to merge it before #17 and idk what is going to happen to the git tree now :)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Swagger api calls #17

Swagger api calls #17

darvid7 commented Apr 22, 2018

darvid7 commented Apr 22, 2018 •

edited

Loading

PatrickShaw Apr 23, 2018 •

edited

Loading

darvid7 Apr 23, 2018

PatrickShaw Apr 23, 2018

darvid7 Apr 23, 2018

PatrickShaw Apr 23, 2018

darvid7 Apr 24, 2018

PatrickShaw Apr 23, 2018 •

edited by darvid7

Loading

darvid7 Apr 23, 2018

darvid7 Apr 23, 2018

PatrickShaw Apr 23, 2018 •

edited by darvid7

Loading

darvid7 Apr 23, 2018

PatrickShaw Apr 23, 2018 •

edited by darvid7

Loading

PatrickShaw Apr 23, 2018

darvid7 Apr 23, 2018

darvid7 commented Apr 23, 2018

PatrickShaw left a comment

PatrickShaw Apr 23, 2018

Swagger api calls #17

Swagger api calls #17

Conversation

darvid7 commented Apr 22, 2018

darvid7 commented Apr 22, 2018 • edited Loading

PatrickShaw Apr 23, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PatrickShaw Apr 23, 2018 • edited by darvid7 Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PatrickShaw Apr 23, 2018 • edited by darvid7 Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PatrickShaw Apr 23, 2018 • edited by darvid7 Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

darvid7 commented Apr 23, 2018

PatrickShaw left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

darvid7 commented Apr 22, 2018 •

edited

Loading

PatrickShaw Apr 23, 2018 •

edited

Loading

PatrickShaw Apr 23, 2018 •

edited by darvid7

Loading

PatrickShaw Apr 23, 2018 •

edited by darvid7

Loading

PatrickShaw Apr 23, 2018 •

edited by darvid7

Loading