Skip to content

Commit

Permalink
fix: Add draftMessage and undocumentedMessage to endpoint, param …
Browse files Browse the repository at this point in the history
…and prop (#114)

* Add draftMessage and undocumentedMessage props

* ci: Generate code

---------

Co-authored-by: Seam Bot <devops@getseam.com>
  • Loading branch information
andrii-balitskyi and seambot authored Oct 9, 2024
1 parent 1749887 commit e7bdd06
Show file tree
Hide file tree
Showing 5 changed files with 1,046 additions and 9 deletions.
31 changes: 22 additions & 9 deletions src/lib/blueprint.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,23 +53,27 @@ export interface Endpoint {
path: string
name: string
description: string
isUndocumented: boolean
isDeprecated: boolean
isDraft: boolean
deprecationMessage: string
isUndocumented: boolean
undocumentedMessage: string
isDraft: boolean
draftMessage: string
request: Request
response: Response
codeSamples: CodeSample[]
}

interface BaseParameter {
name: string
description: string
isRequired: boolean
isUndocumented: boolean
isDeprecated: boolean
isDraft: boolean
deprecationMessage: string
description: string
isUndocumented: boolean
undocumentedMessage: string
isDraft: boolean
draftMessage: string
}

interface StringParameter extends BaseParameter {
Expand Down Expand Up @@ -165,7 +169,9 @@ interface BaseProperty {
isDeprecated: boolean
deprecationMessage: string
isUndocumented: boolean
undocumentedMessage: string
isDraft: boolean
draftMessage: string
}

export type Property =
Expand Down Expand Up @@ -484,12 +490,13 @@ const createEndpoint = async (
const description = parsedOperation.description

const isUndocumented = parsedOperation['x-undocumented'].length > 0
const undocumentedMessage = parsedOperation['x-undocumented']

const isDeprecated = parsedOperation.deprecated
const deprecationMessage = parsedOperation['x-deprecated']

const isDraft = parsedOperation['x-draft'].length > 0

const deprecationMessage = parsedOperation['x-deprecated']
const draftMessage = parsedOperation['x-draft']

const request = createRequest(methods, operation, path)

Expand All @@ -498,10 +505,12 @@ const createEndpoint = async (
name,
path: endpointPath,
description,
isUndocumented,
isDeprecated,
isDraft,
deprecationMessage,
isUndocumented,
undocumentedMessage,
isDraft,
draftMessage,
response: createResponse(operation, path),
request,
}
Expand Down Expand Up @@ -618,7 +627,9 @@ const createParameter = (
isDeprecated: parsedProp['x-deprecated'].length > 0,
deprecationMessage: parsedProp['x-deprecated'],
isUndocumented: parsedProp['x-undocumented'].length > 0,
undocumentedMessage: parsedProp['x-undocumented'],
isDraft: parsedProp['x-draft'].length > 0,
draftMessage: parsedProp['x-draft'],
}

switch (parsedProp.type) {
Expand Down Expand Up @@ -831,7 +842,9 @@ const createProperty = (
isDeprecated: parsedProp['x-deprecated'].length > 0,
deprecationMessage: parsedProp['x-deprecated'],
isUndocumented: parsedProp['x-undocumented'].length > 0,
undocumentedMessage: parsedProp['x-undocumented'],
isDraft: parsedProp['x-draft'].length > 0,
draftMessage: parsedProp['x-draft'],
}

switch (parsedProp.type) {
Expand Down
Loading

0 comments on commit e7bdd06

Please sign in to comment.