pb33f / vacuum-vscode

Other
2 stars 0 forks source link

Unresolvable Schema Objects $ref #1

Closed MichelFortes closed 1 month ago

MichelFortes commented 3 months ago

It seems that vacuum-vscode couldn't resolve the ref objects in components -> schema.

Please, see the example below:


paths:
    /accountancy/accounts:
        get:
            tags:
                - Contas
            description: Lista as contas ordenadas por código.
            operationId: loadAllAccounts
            responses:
                "200":
                    description: Resultado da pesquisa retornado com sucesso
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/PaginationResult'
                "400":
                    description: Requisição mal formada
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/ApiError'
                "500":
                    description: Erro interno
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/ApiError'
components:
    schemas:
        PaginationResult:
            required:
                - resultSetMetadata
                - results
            type: object
            properties:
                resultSetMetadata:
                    $ref: '#/components/schemas/ResultSetMetadata'
                results:
                    type: array
                    description: Lista de contas retornadas como resultado da pesquisa
                    items:
                        $ref: '#/components/schemas/Account'
        ResultSetMetadata:
            type: object
            properties:
                count:
                    type: integer
                    description: Total de resultados disponíveis na base de dados como resultado da pesquisa efetuada
                    format: int64
                offset:
                    type: integer
                    description: Deslocamento entre o começo da lista e um dado elemento. Valor default é 0.
                    format: int32
                limit:
                    maximum: 200
                    minimum: 1
                    type: integer
                    description: Quantidade máxima de resultados da pesquisa a serem retornados. Valor default é 100 e o valor máximo permitido é 200.
                    format: int32
        Account:
            type: object
            properties:
                id:
                    type: integer
                    description: Código reduzido da conta
                    example: 1
                name:
                    type: string
                    description: Nome da conta
                    example: Caixa geral
        ApiError:
            required:
                - developerMessage
                - status
            type: object
            properties:
                status:
                    type: string
                    description: Status http
                developerMessage:
                    type: string
                    description: Mensagem de erro pertinente a ser reportada ao developer consumidor da API.
                userMessage:
                    type: array
                    description: Lista contendo mensagem de errors relavantes para o utilizador final
                    items:
                        type: string
            description: Objeto que encapsula os atributos de erros da API

image

VS Code Version

Version: 1.89.1
Commit: dc96b837cf6bb4af9cd736aa3af08cf8279f7685
Date: 2024-05-07T05:16:23.416Z
Electron: 28.2.8
ElectronBuildId: 27744544
Chromium: 120.0.6099.291
Node.js: 18.18.2
V8: 12.0.267.19-electron.0
OS: Linux x64 5.15.0-107-generic
daveshanley commented 3 months ago

which version of vacuum?

MichelFortes commented 3 months ago

The version is: 0.10.0

MichelFortes commented 1 month ago

@daveshanley, this issue was happening due a missing vacuum.conf.yaml. So, vacum was not able to determine the right base path. I'm sorry for opening this issue. I'm going to close it now. Thanks