Skip to content

Conversation

@houqp
Copy link
Member

@houqp houqp commented Aug 30, 2020

openapi-generator relies on this component to generate auth code in
some of the clients.


^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code change, Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in UPDATING.md.

@boring-cyborg boring-cyborg bot added the area:API Airflow's REST/HTTP API label Aug 30, 2020
@houqp houqp requested a review from mik-laj August 30, 2020 19:42
@houqp
Copy link
Member Author

houqp commented Aug 30, 2020

This only affects documentation for go clients, but for some other languages like typescript and java, it is used a feature gate to generate the actual client code.

The go client documentation right now is not generated correctly, which will be fixed by OpenAPITools/openapi-generator#7312.

@houqp houqp requested a review from potiuk August 30, 2020 19:45
@mik-laj
Copy link
Member

mik-laj commented Aug 31, 2020

New sections have appeared in the reference documentation. I think it's worth hiding them because we have other documentation that is more precise.
Screenshot 2020-08-31 at 18 44 30
I think we can do it by noAuthAuth option in redoc.
https://github.com/Redocly/redoc#redoc-options-object

Qingping Hou added 2 commits August 31, 2020 18:17
openapi-generator relies on this component to generate auth code in
some of the clients.
@houqp houqp requested a review from mik-laj September 1, 2020 03:42
@houqp houqp force-pushed the qp/securityschemes branch from c56025d to 22073f4 Compare September 1, 2020 03:43
@mik-laj
Copy link
Member

mik-laj commented Sep 3, 2020

@jhtimmins Can I ask for a review?

Copy link
Contributor

@jhtimmins jhtimmins left a comment

Choose a reason for hiding this comment

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

This looks good. Does it warrant adding docs?

Edit: Nvm. Docs for this are handled elsewhere.

'spec': OPENAPI_FILE,
'opts': {
'hide-hostname': True,
'no-auto-auth': True,
Copy link
Contributor

Choose a reason for hiding this comment

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

What is no-auto-auth used for?

Copy link
Member

Choose a reason for hiding this comment

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

@mik-laj mik-laj changed the title add securitySchemes in openapi spec Add securitySchemes in openapi spec Sep 4, 2020
@mik-laj mik-laj merged commit 8cb4fc1 into apache:master Sep 4, 2020
@houqp houqp deleted the qp/securityschemes branch September 6, 2020 17:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:API Airflow's REST/HTTP API

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants