support for version argument on generateschema command

[erancihan]

Hi everyone,

As it is now, generateschema command does not support --version argument. I was looking around the code and I found that the SchemaGenerator class currently supports version input if I am correct.

I do not know whether this is intentional or not, however if it is not, I would be more than happy to try and add it.

EDIT:
It is in order to add my Current and Expected output for the generated openapi-schema.yml file.

Current:

openapi: 3.0.2
info:
  title: My API
  version: ''
  description: My API Documentation
paths:
...

Expected:

openapi: 3.0.2
info:
  title: My API
  version: 1.0.0
  description: My API Documentation
paths:
...

I am running the following command to generate the yaml file:

python manage.py generateschema \
--title "My API" \
--description "My API Documentation" \
--format openapi \
--file path/to/static/openapi-schema.yml

including --version arg does not work, as it is not supported as of 3.13.1

[Azanul]

What is the end result you are looking for here?
If you want version to be mentioned in the generated schema document then changes will be first needed in Document Interface of core-api. Please refer to the issue in core-api repo.

[Azanul]

By the way, this argument will serve any purpose as anyone who want to mention the version can just go and add it to the file manually. The amount of work done remains the same either way 😂.
If you implement it then the use will just have to mention the version in command line argument instead of the generated document.
I think this is why it wasn't prioritised before.

[erancihan]

I get your point :D

I feel the need for it as I want to be able to update version on the fly in GitHub Actions, and have it reflect on the docs when deployed.
I found it less work to maintain version number through actions instead of manually going and updating it, when there are multiple PRs on and about 😅

[Azanul]

Now it is making sense to me. Thanks a lot for clarifying.
Don't forget mark this as answered once your PR for the same is merged.

[Azanul]

@erancihan have you not raised the PR yet?

[erancihan]

oh yes, that's done

[erancihan]

#8663