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

feat chaotic: allow object in root of file #779

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

lirik90
Copy link
Contributor

@lirik90 lirik90 commented Dec 1, 2024

Здравствуйте!
Очень нуждаюсь в функционале генерации моделей из схем разделённых по разным файлам. Видел в коде что в каком то виде это уже реализовано, но сейчас при использовании $ref требуется указать in-path путь до модели внутри файла, но я не нашёл как указать модель описанную в корне файла.

В этом ПР попытка реализовать генерацию из моделей описаных в корне openapi файла. Т.е. когда описание начинается сразу в корне файла:

Пример файла Param.yaml

type: object
required:
  - id
  - paramId
properties:
  id:
    type: integer
    format: int64
    minimum: 0
  paramId:
    type: integer
    format: int64
    minimum: 0

Для проверки работы можно например с помощью инструмента redocly/cli разбить монолитный openapi файл на отдельные файлы и для получившейся папки schemes применить chaotic-gen с такими параметрами:

chaotic-gen \
   -n "/components/schemas/([^/]*)/=my_ns::api::{0}" \
   -f "(.*)={0}" \
   --plain-object-path-map '.*/([^/]+)\.yaml$$=/components/schemas/{0}/' \
   --clang-format=clang-format \
   --generate-serializers \
   --output-dir src/api \
   --relative-to=$(PWD)/components/schemas \
   $(PWD)/components/schemas/*.yaml

Тут добавляется параметр plain-object-path-map который помогает смапить имя файла во внутреннее имя (должно совпадать с тем именем которое указано в -n параметре).


Note: by creating a PR or an issue you automatically agree to the CLA. See CONTRIBUTING.md. Feel free to remove this note, the agreement holds.

@lirik90 lirik90 force-pushed the feature/chaotic-object-in-root-of-file branch from a2a279f to 4f978f5 Compare December 6, 2024 00:18
def match(self, data: str) -> Optional[str]:
match = self.pattern.fullmatch(data) # pylint: disable=no-member
if match:
return self.dest.format(*match.groups())
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

давай тут добавим возможность задавать stem (filename without ext), это будет чище и будет расширять возможности уже существующего -n

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants