Skip to content

fix: adding support for non-alphanumerical operation ids #180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 16, 2020
Merged

fix: adding support for non-alphanumerical operation ids #180

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions packages/httpsnippet-client-api/__tests__/__fixtures__/output/issue-119.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
const sdk = require('api')('https://example.com/openapi.json');
sdk.auth('123');

sdk['find/pets-by-status']({status: 'available'})
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));
156 changes: 156 additions & 0 deletions packages/httpsnippet-client-api/__tests__/__fixtures__/request/issue-119/definition.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,156 @@
{
"openapi": "3.0.0",
"info": {
"version": "1.0.0",
"title": "Swagger Petstore"
},
"servers": [
{
"url": "http://petstore.swagger.io/v2"
}
],
"paths": {
"/pet/findByStatus": {
"get": {
"summary": "Finds Pets by status",
"description": "Multiple status values can be provided with comma separated strings",
"operationId": "find/pets-by-status",
"parameters": [
{
"name": "status",
"in": "query",
"description": "Status values that need to be considered for filter",
"required": true,
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"available",
"pending",
"sold"
],
"default": "available"
}
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Pet"
}
}
}
}
},
"400": {
"description": "Invalid status value"
}
},
"security": [
{
"petstore_auth": [
"write:pets",
"read:pets"
]
}
]
}
}
},
"components": {
"securitySchemes": {
"petstore_auth": {
"type": "oauth2",
"flows": {
"implicit": {
"authorizationUrl": "http://petstore.swagger.io/oauth/dialog",
"scopes": {
"write:pets": "modify pets in your account",
"read:pets": "read your pets"
}
}
}
},
"api_key": {
"type": "apiKey",
"name": "api_key",
"in": "header"
}
},
"schemas": {
"Category": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
}
}
},
"Tag": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
}
}
},
"Pet": {
"type": "object",
"required": [
"name",
"photoUrls"
],
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"category": {
"$ref": "#/components/schemas/Category"
},
"name": {
"type": "string",
"example": "doggie"
},
"photoUrls": {
"type": "array",
"items": {
"type": "string"
}
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
}
},
"status": {
"type": "string",
"description": "pet status in the store",
"enum": [
"available",
"pending",
"sold"
]
}
}
}
}
}
}
32 changes: 32 additions & 0 deletions packages/httpsnippet-client-api/__tests__/__fixtures__/request/issue-119/har.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{
"log": {
"entries": [
{
"request": {
"cookies": [],
"headers": [
{
"name": "Authorization",
"value": "Bearer 123"
}
],
"httpVersion": "HTTP/1.1",
"method": "GET",
"postData": {
"jsonObj": false,
"mimeType": "application/octet-stream",
"paramsObj": false,
"size": 0
},
"queryString": [
{
"name": "status",
"value": "available"
}
],
"url": "http://petstore.swagger.io/v2/pet/findByStatus"
}
}
]
}
}
1 change: 1 addition & 0 deletions packages/httpsnippet-client-api/__tests__/index.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ describe('snippets', () => {
['issue-76'],
['issue-78'],
['issue-78-operationid'],
['issue-119'],
['issue-128'],
['jsonObj-multiline'],
['jsonObj-null-value'],
Expand Down
10 changes: 9 additions & 1 deletion packages/httpsnippet-client-api/src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,14 @@ module.exports = function (source, options) {
args.push(`'${decodeURIComponent(path)}'`);
}

// If the operation or method accessor is non-alphanumeric, we need to add it to the SDK object as an array key.
// https://github.com/readmeio/api/issues/119
if (accessor.match(/[^a-zA-Z\d\s:]/)) {
accessor = `['${accessor}']`;
} else {
accessor = `.${accessor}`;
}

if (typeof body !== 'undefined') {
args.push(stringifyObject(body, { indent: ' ', inlineCharacterLimit: 80 }));
}
Expand All @@ -232,7 +240,7 @@ module.exports = function (source, options) {
code.blank();

code
.push(`sdk.${accessor}(${args.join(', ')})`)
.push(`sdk${accessor}(${args.join(', ')})`)
.push(1, '.then(res => res.json())')
.push(1, '.then(json => console.log(json))')
.push(1, '.catch(err => console.error(err));');
Expand Down