feat: add workdir arg to openapi command

[jdecool]

🧰 Changes

We use a monorepo structure to manage our projects and our OpenAPI specification contains relative references to external models.

So when running rdme on our repository, we need to specify the current working directory to handle those relative paths.

This PR adds an optional workdir parameter to the openapi command.

🧬 QA & Testing

To test it, you have to run the openapi command using the --workdir=path.
So all file should be relative to the specified path.

[jdecool]

This PR refers to this issue comment on https://github.com/readmeio/github-readme-sync

[kanadgupta]

Thanks for the PR @jdecool! Could you add a test case for this? Along with an OpenAPI definition example that uses relative references? You can see a similar example here:

rdme/__tests__/cmds/openapi.test.js

Lines 256 to 283 in e36c610

	it('should bundle and upload the expected content', async () => {
	let requestBody = null;
	const mock = getApiNock()
	.get('/api/v1/api-specification')
	.basicAuth({ user: key })
	.reply(200, [])
	.get(`/api/v1/version/${version}`)
	.basicAuth({ user: key })
	.reply(200, { version: '1.0.0' })
	.post('/api/v1/api-specification', body => {
	requestBody = body.substring(body.indexOf('{'), body.lastIndexOf('}') + 1);
	requestBody = JSON.parse(requestBody);
	return body.match('form-data; name="spec"');
	})
	.basicAuth({ user: key })
	.reply(201, { _id: 1 }, { location: exampleRefLocation });
	await expect(openapi.run({ spec: './__tests__/__fixtures__/ref-oas/petstore.json', key, version })).resolves.toBe(
	successfulUpload
	);
	expect(console.info).toHaveBeenCalledTimes(0);
	expect(requestBody).toMatchSnapshot();
	return mock.done();
	});

[jdecool]

Thanks for your answer @kanadgupta and for your explanation.

I've just updated the PR with a test case.

[kanadgupta]

Thanks for the test @jdecool! Could you also add this parameter to the validate command?

[jdecool]

Could you also add this parameter to the validate command?

Sure.

Done in the last commit

[kanadgupta]

Thanks @jdecool!