loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

[zapier] add response middleware (#19760)

Browse Source 
* feat: add zapier response middleware

* chore: add samples
This commit is contained in:
Alex Wallen 2024-10-02 10:02:25 -07:00 committed by GitHub
parent 168a1d5d1f
commit 43ce2a8e10
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 59 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
modules/openapi-generator/src/main/resources/zapier/api.mustache vendored
View File

@ -104,7 +104,7 @@ module.exports = {
} }
return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => { return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => {
response.throwForStatus(); response.throwForStatus();
const results = response.json; const results = utils.responseOptionsMiddleware(z, bundle, '{{operationId}}', response.json);
return {{#returnType}}{{#returnTypeIsPrimitive}}{ data: results }{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}results{{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}results{{/returnType}}; return {{#returnType}}{{#returnTypeIsPrimitive}}{ data: results }{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}results{{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}results{{/returnType}};
}) })
}, },

26
modules/openapi-generator/src/main/resources/zapier/utils.mustache vendored
View File

@ -28,13 +28,6 @@ const isCreateAction = (key) => {
return !isSearchAction(key); return !isSearchAction(key);
} }
const requestOptionsMiddleware = (z, bundle, requestOptions) => {
// TODO: modify the request options for all outgoing request to your api
// if you are using session authentication without a Bearer token.
// This may be true if your API uses basic authentication or api keys.
return requestOptions
}
const isTrigger = (key) => { const isTrigger = (key) => {
// TODO: custom logic // TODO: custom logic
return false return false
@ -44,6 +37,24 @@ const triggerMiddleware = (action) => {
return action return action
} }
const requestOptionsMiddleware = (z, bundle, requestOptions) => {
// TODO: modify the request options for all outgoing request to your api
// if you are using session authentication without a Bearer token.
// This may be true if your API uses basic authentication or api keys.
return requestOptions
}
const responseOptionsMiddleware = (z, bundle, key, json) => {
// TODO: modify if your response needs to be transformed before returning the
// data to Zapier. For example, you may need to map an id field to the
// "id" field. For example, map "contactId": 1 to "id": 1. Or wrap your
// response in a json object. For example, { data: response }.
//
// Note that if the type being returned from the endpoint is a primitive
// type, the response is automatically wrapped like this: { data: response }.
return json
}
module.exports = { module.exports = {
replacePathParameters: replacePathParameters, replacePathParameters: replacePathParameters,
childMapping: childMapping, childMapping: childMapping,
@ -53,6 +64,7 @@ module.exports = {
isSearchAction: isSearchAction, isSearchAction: isSearchAction,
searchMiddleware: searchMiddleware, searchMiddleware: searchMiddleware,
requestOptionsMiddleware: requestOptionsMiddleware, requestOptionsMiddleware: requestOptionsMiddleware,
responseOptionsMiddleware: responseOptionsMiddleware,
isTrigger: isTrigger, isTrigger: isTrigger,
triggerMiddleware: triggerMiddleware, triggerMiddleware: triggerMiddleware,
isCreateAction: isCreateAction, isCreateAction: isCreateAction,

16
samples/client/petstore/zapier/apis/PetApi.js
View File

@ -37,7 +37,7 @@ module.exports = {
} }
return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => { return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => {
response.throwForStatus(); response.throwForStatus();
const results = response.json; const results = utils.responseOptionsMiddleware(z, bundle, 'addPet', response.json);
return results; return results;
}) })
}, },
@ -84,7 +84,7 @@ module.exports = {
} }
return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => { return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => {
response.throwForStatus(); response.throwForStatus();
const results = response.json; const results = utils.responseOptionsMiddleware(z, bundle, 'deletePet', response.json);
return results; return results;
}) })
}, },
@ -126,7 +126,7 @@ module.exports = {
} }
return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => { return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => {
response.throwForStatus(); response.throwForStatus();
const results = response.json; const results = utils.responseOptionsMiddleware(z, bundle, 'findPetsByStatus', response.json);
return results; return results;
}) })
}, },
@ -168,7 +168,7 @@ module.exports = {
} }
return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => { return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => {
response.throwForStatus(); response.throwForStatus();
const results = response.json; const results = utils.responseOptionsMiddleware(z, bundle, 'findPetsByTags', response.json);
return results; return results;
}) })
}, },
@ -211,7 +211,7 @@ module.exports = {
} }
return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => { return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => {
response.throwForStatus(); response.throwForStatus();
const results = response.json; const results = utils.responseOptionsMiddleware(z, bundle, 'getPetById', response.json);
return results; return results;
}) })
}, },
@ -250,7 +250,7 @@ module.exports = {
} }
return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => { return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => {
response.throwForStatus(); response.throwForStatus();
const results = response.json; const results = utils.responseOptionsMiddleware(z, bundle, 'updatePet', response.json);
return results; return results;
}) })
}, },
@ -302,7 +302,7 @@ module.exports = {
} }
return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => { return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => {
response.throwForStatus(); response.throwForStatus();
const results = response.json; const results = utils.responseOptionsMiddleware(z, bundle, 'updatePetWithForm', response.json);
return results; return results;
}) })
}, },
@ -358,7 +358,7 @@ module.exports = {
} }
return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => { return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => {
response.throwForStatus(); response.throwForStatus();
const results = response.json; const results = utils.responseOptionsMiddleware(z, bundle, 'uploadFile', response.json);
return results; return results;
}) })
}, },

8
samples/client/petstore/zapier/apis/StoreApi.js
View File

@ -38,7 +38,7 @@ module.exports = {
} }
return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => { return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => {
response.throwForStatus(); response.throwForStatus();
const results = response.json; const results = utils.responseOptionsMiddleware(z, bundle, 'deleteOrder', response.json);
return results; return results;
}) })
}, },
@ -74,7 +74,7 @@ module.exports = {
} }
return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => { return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => {
response.throwForStatus(); response.throwForStatus();
const results = response.json; const results = utils.responseOptionsMiddleware(z, bundle, 'getInventory', response.json);
return { data: results }; return { data: results };
}) })
}, },
@ -117,7 +117,7 @@ module.exports = {
} }
return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => { return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => {
response.throwForStatus(); response.throwForStatus();
const results = response.json; const results = utils.responseOptionsMiddleware(z, bundle, 'getOrderById', response.json);
return results; return results;
}) })
}, },
@ -156,7 +156,7 @@ module.exports = {
} }
return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => { return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => {
response.throwForStatus(); response.throwForStatus();
const results = response.json; const results = utils.responseOptionsMiddleware(z, bundle, 'placeOrder', response.json);
return results; return results;
}) })
}, },

16
samples/client/petstore/zapier/apis/UserApi.js
View File

@ -34,7 +34,7 @@ module.exports = {
} }
return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => { return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => {
response.throwForStatus(); response.throwForStatus();
const results = response.json; const results = utils.responseOptionsMiddleware(z, bundle, 'createUser', response.json);
return results; return results;
}) })
}, },
@ -76,7 +76,7 @@ module.exports = {
} }
return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => { return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => {
response.throwForStatus(); response.throwForStatus();
const results = response.json; const results = utils.responseOptionsMiddleware(z, bundle, 'createUsersWithArrayInput', response.json);
return results; return results;
}) })
}, },
@ -118,7 +118,7 @@ module.exports = {
} }
return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => { return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => {
response.throwForStatus(); response.throwForStatus();
const results = response.json; const results = utils.responseOptionsMiddleware(z, bundle, 'createUsersWithListInput', response.json);
return results; return results;
}) })
}, },
@ -160,7 +160,7 @@ module.exports = {
} }
return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => { return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => {
response.throwForStatus(); response.throwForStatus();
const results = response.json; const results = utils.responseOptionsMiddleware(z, bundle, 'deleteUser', response.json);
return results; return results;
}) })
}, },
@ -203,7 +203,7 @@ module.exports = {
} }
return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => { return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => {
response.throwForStatus(); response.throwForStatus();
const results = response.json; const results = utils.responseOptionsMiddleware(z, bundle, 'getUserByName', response.json);
return results; return results;
}) })
}, },
@ -253,7 +253,7 @@ module.exports = {
} }
return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => { return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => {
response.throwForStatus(); response.throwForStatus();
const results = response.json; const results = utils.responseOptionsMiddleware(z, bundle, 'loginUser', response.json);
return { data: results }; return { data: results };
}) })
}, },
@ -289,7 +289,7 @@ module.exports = {
} }
return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => { return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => {
response.throwForStatus(); response.throwForStatus();
const results = response.json; const results = utils.responseOptionsMiddleware(z, bundle, 'logoutUser', response.json);
return results; return results;
}) })
}, },
@ -333,7 +333,7 @@ module.exports = {
} }
return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => { return z.request(utils.requestOptionsMiddleware(z, bundle, options)).then((response) => {
response.throwForStatus(); response.throwForStatus();
const results = response.json; const results = utils.responseOptionsMiddleware(z, bundle, 'updateUser', response.json);
return results; return results;
}) })
}, },

26
samples/client/petstore/zapier/utils/utils.js
View File

@ -28,13 +28,6 @@ const isCreateAction = (key) => {
return !isSearchAction(key); return !isSearchAction(key);
} }
const requestOptionsMiddleware = (z, bundle, requestOptions) => {
// TODO: modify the request options for all outgoing request to your api
// if you are using session authentication without a Bearer token.
// This may be true if your API uses basic authentication or api keys.
return requestOptions
}
const isTrigger = (key) => { const isTrigger = (key) => {
// TODO: custom logic // TODO: custom logic
return false return false
@ -44,6 +37,24 @@ const triggerMiddleware = (action) => {
return action return action
} }
const requestOptionsMiddleware = (z, bundle, requestOptions) => {
// TODO: modify the request options for all outgoing request to your api
// if you are using session authentication without a Bearer token.
// This may be true if your API uses basic authentication or api keys.
return requestOptions
}
const responseOptionsMiddleware = (z, bundle, key, json) => {
// TODO: modify if your response needs to be transformed before returning the
// data to Zapier. For example, you may need to map an id field to the
// "id" field. For example, map "contactId": 1 to "id": 1. Or wrap your
// response in a json object. For example, { data: response }.
//
// Note that if the type being returned from the endpoint is a primitive
// type, the response is automatically wrapped like this: { data: response }.
return json
}
module.exports = { module.exports = {
replacePathParameters: replacePathParameters, replacePathParameters: replacePathParameters,
childMapping: childMapping, childMapping: childMapping,
@ -53,6 +64,7 @@ module.exports = {
isSearchAction: isSearchAction, isSearchAction: isSearchAction,
searchMiddleware: searchMiddleware, searchMiddleware: searchMiddleware,
requestOptionsMiddleware: requestOptionsMiddleware, requestOptionsMiddleware: requestOptionsMiddleware,
responseOptionsMiddleware: responseOptionsMiddleware,
isTrigger: isTrigger, isTrigger: isTrigger,
triggerMiddleware: triggerMiddleware, triggerMiddleware: triggerMiddleware,
isCreateAction: isCreateAction, isCreateAction: isCreateAction,