Skip to content

feat: Handle overridden api route #76

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
nik-ponomarov wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: Handle overridden api route #76

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
22 changes: 13 additions & 9 deletions src/openapi/generators.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,6 +389,7 @@ const isOpenToPublic = async (checker: Access): Promise<boolean> => {

const generateCollectionOperations = async (
collection: Collection,
apiRoute: string,
): Promise<Record<string, OpenAPIV3.PathItemObject & OpenAPIV3_1.PathItemObject>> => {
const { slug } = collection.config
const { singular, plural } = collectionName(collection)
Expand All @@ -400,7 +401,7 @@ const generateCollectionOperations = async (
} satisfies OpenAPIV3_1.ResponsesObject & OpenAPIV3.ResponsesObject

return {
[`/api/${slug}`]: {
[`${apiRoute}/${slug}`]: {
get: {
operationId: componentName('schemas', plural, { prefix: 'list' }),
summary: `Retrieve a list of ${plural}`,
Expand Down Expand Up @@ -462,7 +463,7 @@ const generateCollectionOperations = async (
security: (await isOpenToPublic(collection.config.access.create)) ? [] : [apiKeySecurity],
},
},
[`/api/${slug}/{id}`]: {
[`${apiRoute}/${slug}/{id}`]: {
parameters: [
...baseQueryParams,
{
Expand Down Expand Up @@ -563,13 +564,14 @@ const generateGlobalSchemas = (

const generateGlobalOperations = async (
global: SanitizedGlobalConfig,
apiRoute: string,
): Promise<Record<string, OpenAPIV3.PathItemObject & OpenAPIV3_1.PathItemObject>> => {
const slug = global.slug
const singular = globalName(global)
const tags = [singular]

return {
[`/api/globals/${slug}`]: {
[`${apiRoute}/globals/${slug}`]: {
get: {
summary: `Get the ${singular}`,
tags,
Expand Down Expand Up @@ -663,18 +665,19 @@ export const generateV30Spec = async (
shouldIncludeCollection(collection, filters),
)
const globals = req.payload.globals.config.filter(global => shouldIncludeGlobal(global, filters))
const apiRoute = req.payload.config.routes.api

const spec = {
openapi: '3.0.3',
info: options.metadata,
servers: [{ url: `${req.protocol}//${req.headers.get('host')}` }],
paths: Object.assign(
{},
...(await Promise.all(collections.map(generateCollectionOperations))),
...(await Promise.all(globals.map(generateGlobalOperations))),
...(await Promise.all(collections.map(v => generateCollectionOperations(v, apiRoute)))),
...(await Promise.all(globals.map(v => generateGlobalOperations(v, apiRoute)))),
),
components: {
securitySchemes: generateSecuritySchemes(options.authEndpoint),
securitySchemes: generateSecuritySchemes(options.authEndpoint, apiRoute),
schemas: await mapValuesAsync(jsonSchemaToOpenapiSchema, schemas),
requestBodies: await mapValuesAsync(
async requestBody => ({
Expand Down Expand Up @@ -727,18 +730,19 @@ export const generateV31Spec = async (
shouldIncludeCollection(collection, filters),
)
const globals = req.payload.globals.config.filter(global => shouldIncludeGlobal(global, filters))
const apiRoute = req.payload.config.routes.api;

const spec = {
openapi: '3.1.0',
info: options.metadata,
servers: [{ url: `${req.protocol}//${req.headers.get('host')}` }],
paths: Object.assign(
{},
...(await Promise.all(collections.map(generateCollectionOperations))),
...(await Promise.all(globals.map(generateGlobalOperations))),
...(await Promise.all(collections.map(v => generateCollectionOperations(v, apiRoute)))),
...(await Promise.all(globals.map(v => generateGlobalOperations(v, apiRoute)))),
),
components: {
securitySchemes: generateSecuritySchemes(options.authEndpoint),
securitySchemes: generateSecuritySchemes(options.authEndpoint, apiRoute),
schemas: schemas as Record<string, OpenAPIV3_1.SchemaObject>,
requestBodies,
responses,
Expand Down
3 changes: 2 additions & 1 deletion src/openapi/securitySchemes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,13 @@ export const apiKeySecurity = { ApiKey: [] }

export const generateSecuritySchemes = (
tokenUrl: string,
apiRoute: string,
): Record<string, OpenAPIV3.SecuritySchemeObject & OpenAPIV3_1.SecuritySchemeObject> => ({
ApiKey: {
type: 'oauth2',
flows: {
password: {
tokenUrl: `/api/${tokenUrl}`,
tokenUrl: `${apiRoute}/${tokenUrl}`,
scopes: {},
},
},
Expand Down
Loading