Skip to content

fix #49: use pagination when fetching existing documentation parts #50

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
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

fix #49: use pagination when fetching existing documentation parts #50

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9ba3f14
fix #49: use pagination when fetching existing documentation parts
Jan 14, 2025
84484bf
fix tests
Jan 15, 2025
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
111 changes: 74 additions & 37 deletions src/documentation.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,39 @@ function determinePropertiesToGet (type) {

var autoVersion;


async function getAllDocumentationParts(aws, restApiId) {
let allDocumentationParts = [];
let nextToken = null;

do {
const params = {
restApiId: restApiId,
limit: 500
};

if (nextToken) {
params.position = nextToken;
}

try {
const response = await aws.request('APIGateway', 'getDocumentationParts', params);

if (response.items) {
allDocumentationParts = allDocumentationParts.concat(response.items);
}

nextToken = response.position;
} catch (error) {
console.error('Error fetching documentation parts:', error);
throw error;
}
} while (nextToken);

return allDocumentationParts;
}


module.exports = function() {
return {
_createDocumentationPart: function _createDocumentationPart(part, def, knownLocation) {
Expand Down Expand Up @@ -93,47 +126,51 @@ module.exports = function() {
});
},

_updateDocumentation: function _updateDocumentation() {
_updateDocumentation: async function _updateDocumentation() {
const aws = this.serverless.providers.aws;
return aws.request('APIGateway', 'getDocumentationVersion', {
restApiId: this.restApiId,
documentationVersion: this.getDocumentationVersion(),
}).then(() => {
const msg = 'documentation version already exists, skipping upload';
console.info('-------------------');
console.info(msg);
return Promise.reject(msg);
}, err => {
if (err.providerError && err.providerError.statusCode === 404) {
return Promise.resolve();
}

return Promise.reject(err);
})
.then(() =>
aws.request('APIGateway', 'getDocumentationParts', {
restApiId: this.restApiId,
limit: 9999,
})
)
.then(results => results.items.map(
part => aws.request('APIGateway', 'deleteDocumentationPart', {
documentationPartId: part.id,
restApiId: this.restApiId,
})
))
.then(promises => Promise.all(promises))
.then(() => this.documentationParts.reduce((promise, part) => {
return promise.then(() => {
part.properties = JSON.stringify(part.properties);
return aws.request('APIGateway', 'createDocumentationPart', part);
});
}, Promise.resolve()))
.then(() => aws.request('APIGateway', 'createDocumentationVersion', {
try {
// Check if documentation version exists
await aws.request('APIGateway', 'getDocumentationVersion', {
restApiId: this.restApiId,
documentationVersion: this.getDocumentationVersion(),
stageName: this.options.stage,
}));
});

const msg = 'documentation version already exists, skipping upload';
console.info('-------------------');
console.info(msg);
throw new Error(msg);

} catch (err) {
if (!(err.providerError && err.providerError.statusCode === 404)) {
throw err;
}
// If 404, continue with the update process
}

// Get all existing documentation parts
const existingParts = await getAllDocumentationParts(aws, this.restApiId);

// Delete all existing documentation parts
await Promise.all(existingParts.map(part =>
aws.request('APIGateway', 'deleteDocumentationPart', {
documentationPartId: part.id,
restApiId: this.restApiId,
})
));

// Create new documentation parts
for (const part of this.documentationParts) {
part.properties = JSON.stringify(part.properties);
await aws.request('APIGateway', 'createDocumentationPart', part);
}

// Create new documentation version
await aws.request('APIGateway', 'createDocumentationVersion', {
restApiId: this.restApiId,
documentationVersion: this.getDocumentationVersion(),
stageName: this.options.stage,
});
},

getGlobalDocumentationParts: function getGlobalDocumentationParts() {
Expand Down