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

Move docs back to root dir #671

Merged
merged 2 commits into from
Feb 27, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion client/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
<modules>
<module>deployment</module>
<module>runtime</module>
<module>docs</module>
<module>test-utils</module>
</modules>
</project>
File renamed without changes.
File renamed without changes.
75 changes: 75 additions & 0 deletions docs/modules/ROOT/pages/includes/quarkus-openapi-generator.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@

:summaryTableId: quarkus-openapi-generator
[.configuration-legend]
icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime
[.configuration-reference.searchable, cols="80,.^10,.^10"]
|===

h|[[quarkus-openapi-generator_configuration]]link:#quarkus-openapi-generator_configuration[Configuration property]

h|Type
h|Default

a| [[quarkus-openapi-generator_quarkus-openapi-generator-item-configs-auth-auth-configs-token-propagation]]`link:#quarkus-openapi-generator_quarkus-openapi-generator-item-configs-auth-auth-configs-token-propagation[quarkus.openapi-generator."item-configs".auth."auth-configs".token-propagation]`


[.description]
--
Enables the authentication token propagation for this particular securityScheme.

For example, given a file named petstore.json with a securityScheme named "petstore-auth" the following configuration must be used.

quarkus.openapi-generator.petstore_json.auth.petstore_auth.token-propagation=true

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENAPI_GENERATOR__ITEM_CONFIGS__AUTH__AUTH_CONFIGS__TOKEN_PROPAGATION+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_OPENAPI_GENERATOR__ITEM_CONFIGS__AUTH__AUTH_CONFIGS__TOKEN_PROPAGATION+++`
endif::add-copy-button-to-env-var[]
--|boolean
|`false`


a| [[quarkus-openapi-generator_quarkus-openapi-generator-item-configs-auth-auth-configs-header-name]]`link:#quarkus-openapi-generator_quarkus-openapi-generator-item-configs-auth-auth-configs-header-name[quarkus.openapi-generator."item-configs".auth."auth-configs".header-name]`


[.description]
--
Configures a particular http header attribute from were to take the security token from when the token propagation is enabled. Use this fine-grained configuration in very particular scenarios.

For example, given a file named petstore.json with a securityScheme named "petstore-auth" the following configuration must be used.

quarkus.openapi-generator.petstore_json.auth.petstore_auth.header-name=MyParticularHttpHeaderName

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENAPI_GENERATOR__ITEM_CONFIGS__AUTH__AUTH_CONFIGS__HEADER_NAME+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_OPENAPI_GENERATOR__ITEM_CONFIGS__AUTH__AUTH_CONFIGS__HEADER_NAME+++`
endif::add-copy-button-to-env-var[]
--|string
|


a| [[quarkus-openapi-generator_quarkus-openapi-generator-item-configs-auth-auth-configs-auth-config-params]]`link:#quarkus-openapi-generator_quarkus-openapi-generator-item-configs-auth-auth-configs-auth-config-params[quarkus.openapi-generator."item-configs".auth."auth-configs"]`


[.description]
--
Configures a particular parameter value to be used by any of the different internal authentication filters that processes the different securityScheme definitions.

For example, given a file named petstore.json with a securityScheme named "petstore-basic-auth", that is of http basic authentication type, the following configuration can establish the user and password to be used. must be used.

quarkus.openapi-generator.petstore_json.auth.petstore_basic_auth.username=MyUserName quarkus.openapi-generator.petstore_json.auth.petstore_basic_auth.password=MyPassword

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENAPI_GENERATOR__ITEM_CONFIGS__AUTH__AUTH_CONFIGS_+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_OPENAPI_GENERATOR__ITEM_CONFIGS__AUTH__AUTH_CONFIGS_+++`
endif::add-copy-button-to-env-var[]
--|`Map<String,String>`
|

|===
4 changes: 2 additions & 2 deletions client/docs/pom.xml → docs/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<parent>
<groupId>io.quarkiverse.openapi.generator</groupId>
<artifactId>quarkus-openapi-generator-client-parent</artifactId>
<artifactId>quarkus-openapi-generator-parent</artifactId>
<version>3.0.0-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>
Expand Down Expand Up @@ -33,7 +33,7 @@
</goals>
<configuration>
<files>
<file>${project.basedir}/../../.github/project.yml</file>
<file>${project.basedir}/../.github/project.yml</file>
</files>
</configuration>
</execution>
Expand Down
1 change: 1 addition & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
<modules>
<module>client</module>
<module>server</module>
<module>docs</module>
</modules>
<scm>
<connection>:git:[email protected]:quarkiverse/quarkus-openapi-generator.git</connection>
Expand Down
Loading