Skip to content
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.

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

Nestia v2 -> v3 Migration #867

Open
SatyaanM opened this issue Apr 11, 2024 · 1 comment
Open

Nestia v2 -> v3 Migration #867

SatyaanM opened this issue Apr 11, 2024 · 1 comment
Assignees
Labels
good first issue Good for newcomers invalid This doesn't seem right question Further information is requested wontfix This will not be worked on

Comments

@SatyaanM
Copy link

SatyaanM commented Apr 11, 2024

Hi @samchon , thank you for the great work on nestia and typia! I saw v3 is released and I have some questions about upgrading.

  1. Is it possible to disable inferring the Title from the first line of a comment?
  1. info.license.identifier and info.license.url is not being generated in the OpenAPI 3.1.0 file. Can I configure these values somewhere or is this not supported?
@samchon samchon self-assigned this May 4, 2024
@samchon samchon added enhancement New feature or request good first issue Good for newcomers invalid This doesn't seem right wontfix This will not be worked on question Further information is requested and removed enhancement New feature or request labels May 4, 2024
@samchon
Copy link
Owner

samchon commented May 4, 2024

Sorry for long time waiting.

Automatic JsonSchema.title composition

As considering the first line terminated with dot (.) as @summary or @title feature was traditional convention from very long time ago (ASDoc, JavaDoc), I don't want to disable it. Instead, you can skip the first line to be @summary or @title by not terminating with the dot (.) characeter.

info.license.identifier

You can configure it onto the nestia.config.ts file.

import { INestiaConfig } from "@nestia/sdk";

export const NESTIA_CONFIG: INestiaConfig = {
  input: ["src/controllers"],
  output: "src/api",
  swagger: {
    output: "swagger.json",
    info: { ... },
  },
};
export default NESTIA_CONFIG;

https://nestia.io/docs/sdk/swagger/#configuration

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers invalid This doesn't seem right question Further information is requested wontfix This will not be worked on
Projects
None yet
Development

No branches or pull requests

2 participants