Skip to content

fix(docs): render nested objects in payloads and responses #29

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

Open
p-fernandez wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(docs): render nested objects in payloads and responses #29

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
2 changes: 1 addition & 1 deletion content/code-examples/subscribers/update-preference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export const novu = new Novu('<REPLACE_WITH_API_KEY_FROM_ADMIN_PANEL>');

await novu.subscribers.updatePreference(user.id, templateId, {
channel: {
type: 'fcm',
Copy link
Contributor Author

@p-fernandez p-fernandez Feb 1, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This channel doesn't exist.

type: 'email',
enabled: true,
},
enabled: true,
Expand Down
22 changes: 22 additions & 0 deletions src/utils/build-properties.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import getValueForParameter from './get-value-for-parameter';

export const buildProperty = (propertyName, property) => `
${propertyName}: ${getValueForParameter(property, property.type, propertyName)}`;

export const buildPropertyFromAllOf = (propertyName, property, allOf) => {
const { properties } = allOf[0];

const renderedProperties = Object.keys(properties).map((propertyName) => {
const property = properties[propertyName];

if (property.allOf) {
return buildPropertyFromAllOf(propertyName, property, property.allOf);
}

return buildProperty(propertyName, property);
});

return `
${propertyName}: {${renderedProperties}
}`;
};
28 changes: 18 additions & 10 deletions src/utils/generate-responses.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,20 @@
import getValueForParameter from './get-value-for-parameter';
import { buildPropertyFromAllOf, buildProperty } from './build-properties';

const renderProperties = (properties) =>
Object.keys(properties).map((propertyName) => {
const property = properties[propertyName];

if (property.allOf) {
return buildPropertyFromAllOf(propertyName, property, property.allOf);
}

return buildProperty(propertyName, property);
});

const buildContent = (properties) =>
`{
${renderProperties(properties)}
}`;

const generateResponses = (responses) => {
const items = responses
Expand All @@ -17,15 +33,7 @@ const generateResponses = (responses) => {
return {
label: `${response.status}`,
language: 'json',
content: `{
${Object.keys(props)
.map((propertyName) => {
const { type } = props[propertyName];

return `${propertyName}: ${getValueForParameter(props[propertyName], type, propertyName)}`;
})
.join(',\n ')}
}`,
content: buildContent(props),
};
}

Expand Down
96 changes: 24 additions & 72 deletions src/utils/generate-snippets.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
import { buildPropertyFromAllOf } from './build-properties';
import getValueForParameter from './get-value-for-parameter';

const buildParameters = (parameters, addQuotes) =>
Object.keys(parameters?.body?.properties)
.map((name) => {
const property = parameters.body.properties[name];
const { type, allOf } = property;
const escapedName = addQuotes ? `"${name}"` : `${name}`;
if (allOf) {
return buildPropertyFromAllOf(name, property, allOf);
}

return `${escapedName}: ${getValueForParameter(property, type, name)}`;
})
.filter((item) => !!item)
.join(',\n ');

const generateSnippets = ({ method, endpoint, parameters, url }) => [
{
label: 'Node.js',
Expand All @@ -15,14 +31,8 @@ const response = await fetch('${url}${endpoint}', {
'Authorization': 'ApiKey REPLACE_WITH_API_KEY',
},
body: JSON.stringify({
${Object.keys(parameters?.body?.properties)
.map((name) => {
const { type } = parameters.body.properties[name];
return `${name}: ${getValueForParameter(parameters.body.properties[name], type, name)}`;
})
.filter((item) => !!item)
.join(',\n ')}
}),`
${buildParameters(parameters)},
})`
: ''
}
});
Expand All @@ -36,14 +46,8 @@ const data = await response.json();
parameters?.body?.properties
? ` -H "Content-Type: application/json" \\\n -d ` +
`'{
${Object.keys(parameters?.body?.properties)
.map((name) => {
const { type } = parameters.body.properties[name];
return `"${name}": ${getValueForParameter(parameters.body.properties[name], type, name)}`;
})
.filter((item) => !!item)
.join(',\n ')}
}' \\\n`
${buildParameters(parameters, true)}
}' \\\n`
: ''
}https://api.novu.co${endpoint}`,
},
Expand All @@ -55,17 +59,7 @@ const data = await response.json();
response = requests.${method.toLowerCase()}('${url}${endpoint}'${
parameters?.body?.properties
? `, json={
${Object.keys(parameters?.body?.properties)
.map((name) => {
const { type } = parameters.body.properties[name];
return `"${name}": ${getValueForParameter(
parameters.body.properties[name],
type,
name
)},`;
})
.filter((item) => !!item)
.join(',\n ')}\n` +
${buildParameters(parameters, true)}\n` +
`}, headers={
'Content-Type': 'application/json'
'Authorization': 'ApiKey REPLACE_WITH_API_KEY'
Expand All @@ -87,21 +81,7 @@ http = Net::HTTP.new(uri.host, uri.port)
request = Net::HTTP::Post.new(uri.request_uri)

request.body = '{
${
parameters?.body?.properties
? Object.keys(parameters?.body?.properties)
.map((name) => {
const { type } = parameters.body.properties[name];
return `"${name}": ${getValueForParameter(
parameters.body.properties[name],
type,
name
)}`;
})
.filter((item) => !!item)
.join(',\n ')
: '[options]'
}
${parameters?.body?.properties ? buildParameters(parameters, true) : '[options]'}
}'
request.content_type = 'application/json'
request.add_field('Authorization', 'ApiKey REPLACE_WITH_API_KEY')
Expand All @@ -120,21 +100,7 @@ puts response.body

$url = '${url}${endpoint}';
$data = array(
${
parameters?.body?.properties
? Object.keys(parameters?.body?.properties)
.map((name) => {
const { type } = parameters.body.properties[name];
return `"${name}": ${getValueForParameter(
parameters.body.properties[name],
type,
name
)}`;
})
.filter((item) => !!item)
.join(',\n ')
: '[options]'
}
${parameters?.body?.properties ? buildParameters(parameters, true) : '[options]'}
);
$options = array(
"http" => array(
Expand Down Expand Up @@ -166,21 +132,7 @@ import (
func main() {
url := "${url}${endpoint}"
data := map[string]string{
${
parameters?.body?.properties
? Object.keys(parameters?.body?.properties)
.map((name) => {
const { type } = parameters.body.properties[name];
return `"${name}": ${getValueForParameter(
parameters.body.properties[name],
type,
name
)}`;
})
.filter((item) => !!item)
.join(',\n ')
: '[options]'
}
${parameters?.body?.properties ? buildParameters(parameters, true) : '[options]'}
}
jsonValue, _ := json.Marshal(data)
req, _ := http.NewRequest("${method.toUpperCase()}", url, bytes.NewBuffer(jsonValue))
Expand Down