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

OpenAPI Specification Extensions #2224

Closed
andersonpem opened this issue Feb 21, 2024 · 1 comment · Fixed by #2230
Closed

OpenAPI Specification Extensions #2224

andersonpem opened this issue Feb 21, 2024 · 1 comment · Fixed by #2230

Comments

@andersonpem
Copy link

andersonpem commented Feb 21, 2024

How can I use OpenAPI Specification Extensions to this bundle?

According to OpenAPI specification, any extra parameter has to start with x-*. Also, field names beginning x-oai- and x-oas- are reserved :)

Imagine I have the following code:

nelmio_api_doc:
    documentation:
        servers:
            - url: '%env(DOCUMENTATION_URL)%'
        info:
            title: Some sample API
            description: Totally realistic API
            version: 1.0.0
            x-build: '#SomeCommitHash'

I can't make the x-build be rendered in the outputted JSON. Do I need to enable some option?

I'm using v4.20 on Symfony 6.4

Thank you and sorry if this is a stupid question :)

@DjordyKoert
Copy link
Collaborator

Hmm I would have expected your x-build to be visible in the JSON. I will try and have a look sometime soon.

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 a pull request may close this issue.

2 participants