feat(oas): declare x-codegen on Admin routes - D to PRI

[patrick-medusajs]

What

Declare x-codegen in OAS for Admin routes - D to PRI.

Why

We are introducing a new x-codegen OpenApi extension, also known as vendor extension, in order to help with passing information down to code generators.

In our case, we wish to declare the method name that we would expect to call on a client. This mimics our current JS client package.
E.g. medusaClient.product.list where product is the tag of the route and list is the x-codegen.method value.

We are also defining the name of a potential typed object for query parameters. OAS 3.0 does not allow to bundle query parameters under a single definition but it is not uncommon to see API clients handle all query parameters as a single typed object, like our JS client package. With x-codegen.queryParams, a code generator can create a named and typed object to bundle all query parameters for a given route.
E.g. medusaClient.customer.retrieve(id: string, queryParams: AdminGetCustomerParams)

How

Declare x-codegen as an object with fields method and queryParams on all paths.

Match method and queryParams values with equivalent ones from our current JS client package.

Test

• Ran OAS validator.
• Ran docs build script.

Expect no visible changes to the documentation.

[changeset-bot]

🦋 Changeset detected

Latest commit: bce77ab

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
@medusajs/medusa	Patch
@medusajs/inventory	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[patrick-medusajs]

self-review: highlighting noteworthy code changes

[patrick-medusajs]

medusa/packages/medusa-js/src/resources/admin/gift-cards.ts

Lines 17 to 20 in 75f9c7a

	create(
	payload: AdminPostGiftCardsReq,
	customHeaders: Record<string, any> = {}
	): ResponsePromise<AdminGiftCardsRes> {

[patrick-medusajs]

medusa/packages/medusa-js/src/resources/admin/gift-cards.ts

Lines 40 to 43 in 75f9c7a

	delete(
	id: string,
	customHeaders: Record<string, any> = {}
	): ResponsePromise<AdminGiftCardsDeleteRes> {

[patrick-medusajs]

medusa/packages/medusa-js/src/resources/admin/gift-cards.ts

Lines 51 to 54 in 75f9c7a

	retrieve(
	id: string,
	customHeaders: Record<string, any> = {}
	): ResponsePromise<AdminGiftCardsRes> {

[patrick-medusajs]

medusa/packages/medusa-js/src/resources/admin/gift-cards.ts

Lines 62 to 65 in 75f9c7a

	list(
	query?: AdminGetGiftCardsParams,
	customHeaders: Record<string, any> = {}
	): ResponsePromise<AdminGiftCardsListRes> {

[patrick-medusajs]

medusa/packages/medusa-js/src/resources/admin/gift-cards.ts

Lines 28 to 32 in 75f9c7a

	update(
	id: string,
	payload: AdminPostGiftCardsGiftCardReq,
	customHeaders: Record<string, any> = {}
	): ResponsePromise<AdminGiftCardsRes> {

[patrick-medusajs]

medusa/packages/medusa-js/src/resources/admin/price-lists.ts

Lines 107 to 111 in 75f9c7a

	deleteVariantPrices(
	priceListId: string,
	variantId: string,
	customHeaders: Record<string, any> = {}
	): ResponsePromise<AdminPriceListDeleteBatchRes> {

[patrick-medusajs]

medusa/packages/medusa-js/src/resources/admin/price-lists.ts

Lines 43 to 46 in 75f9c7a

	retrieve(
	id: string,
	customHeaders: Record<string, any> = {}
	): ResponsePromise<AdminPriceListRes> {

[patrick-medusajs]

medusa/packages/medusa-js/src/resources/admin/price-lists.ts

Lines 65 to 69 in 75f9c7a

	listProducts(
	id: string,
	query?: AdminGetPriceListsPriceListProductsParams,
	customHeaders: Record<string, any> = {}
	): ResponsePromise<any> {

[patrick-medusajs]

medusa/packages/medusa-js/src/resources/admin/price-lists.ts

Lines 51 to 54 in 75f9c7a

	list(
	query?: AdminGetPriceListPaginationParams,
	customHeaders: Record<string, any> = {}
	): ResponsePromise<AdminPriceListsListRes> {

[patrick-medusajs]

medusa/packages/medusa-js/src/resources/admin/price-lists.ts

Lines 26 to 30 in 75f9c7a

	update(
	id: string,
	payload: AdminPostPriceListsPriceListPriceListReq,
	customHeaders: Record<string, any> = {}
	): ResponsePromise<AdminPriceListRes> {

[patrick-medusajs]

self-review: highlighting noteworthy code changes

[shahednasser]

LGTM