TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2025-08-11 17:07:31 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
docs_inconsistent_naming_organization_domain
zitadel/docs/buf.gen.yaml

19 lines
444 B
YAML
Raw Permalink Normal View History

docs: improve api docs (#5158) * integrate docs into nav * generator for local use, production needs to be set by env * fix typo * local dev * docs: annotate the first user endpoints in the management api * docs: annotate the first user endpoints in the management api * docs: annotate the first user endpoints in the management api * docs: annotate the first user endpoints in the management api * docs: add header params * rewrite docs links and improve ci * tweak build command * fix path * Update docs/docusaurus.config.js Co-authored-by: Max Peintner <max@caos.ch> * fix docker * docs: add header params * docs: Add tags to management api. add some descriptions * docs: more descriptions * docs: more descriptions * docs: required fields * docs: example request * docs: example request * docs: example request * docs: example request * docs: example request * docs: user metadata requests * docs: user requests * docs: user requests * docs: user requests * docs: user requests * docs: change nav add first methods to authentication api * docs: auth api * docs: auth api * docs: auth api * docs: auth api * docs: auth api * docs: api sidenav * chore: use buf without docker * fix deploy * fix ci * fix vercel * docs: admin * docs: admin api docs * docs: admin api docs * docs: admin api docs * docs: admin api docs * docs: security * docs: security * docs: admin api * docs: change to env vars * docs: auth api * docs: remove assets, deprecated requests, menu * reworked page with PaloAltoNetworks/docusaurus-openapi-docs * works with the resolutions * fix broken build by adding assets again * add tags to menu * chore: improve build speed * no-minify * test ssr * ssr 20 * use lazy * increase mem * use default mem * change names * docs: remove assets, deprecated requests, menu * docs: management api * docs: management api * docs: management api * docs: sidebar * not the best word smithing but it is ;-) * more typos * merge main * fix some error * trial * update grpc gateway * trigger vercel build * docs: deprecated requests * docs: deprecated requests --------- Co-authored-by: Fabienne <fabienne.gerschwiler@gmail.com> Co-authored-by: Max Peintner <max@caos.ch>
2023-02-23 12:08:06 +01:00
# buf.gen.yaml
feat: exchange gRPC server implementation to connectRPC (#10145) # Which Problems Are Solved The current maintained gRPC server in combination with a REST (grpc) gateway is getting harder and harder to maintain. Additionally, there have been and still are issues with supporting / displaying `oneOf`s correctly. We therefore decided to exchange the server implementation to connectRPC, which apart from supporting connect as protocol, also also "standard" gRCP clients as well as HTTP/1.1 / rest like clients, e.g. curl directly call the server without any additional gateway. # How the Problems Are Solved - All v2 services are moved to connectRPC implementation. (v1 services are still served as pure grpc servers) - All gRPC server interceptors were migrated / copied to a corresponding connectRPC interceptor. - API.ListGrpcServices and API. ListGrpcMethods were changed to include the connect services and endpoints. - gRPC server reflection was changed to a `StaticReflector` using the `ListGrpcServices` list. - The `grpc.Server` interfaces was split into different combinations to be able to handle the different cases (grpc server and prefixed gateway, connect server with grpc gateway, connect server only, ...) - Docs of services serving connectRPC only with no additional gateway (instance, webkey, project, app, org v2 beta) are changed to expose that - since the plugin is not yet available on buf, we download it using `postinstall` hook of the docs # Additional Changes - WebKey service is added as v2 service (in addition to the current v2beta) # Additional Context closes #9483 --------- Co-authored-by: Elio Bischof <elio@zitadel.com>
2025-07-04 10:06:20 -04:00
version: v2
docs: improve api docs (#5158) * integrate docs into nav * generator for local use, production needs to be set by env * fix typo * local dev * docs: annotate the first user endpoints in the management api * docs: annotate the first user endpoints in the management api * docs: annotate the first user endpoints in the management api * docs: annotate the first user endpoints in the management api * docs: add header params * rewrite docs links and improve ci * tweak build command * fix path * Update docs/docusaurus.config.js Co-authored-by: Max Peintner <max@caos.ch> * fix docker * docs: add header params * docs: Add tags to management api. add some descriptions * docs: more descriptions * docs: more descriptions * docs: required fields * docs: example request * docs: example request * docs: example request * docs: example request * docs: example request * docs: user metadata requests * docs: user requests * docs: user requests * docs: user requests * docs: user requests * docs: change nav add first methods to authentication api * docs: auth api * docs: auth api * docs: auth api * docs: auth api * docs: auth api * docs: api sidenav * chore: use buf without docker * fix deploy * fix ci * fix vercel * docs: admin * docs: admin api docs * docs: admin api docs * docs: admin api docs * docs: admin api docs * docs: security * docs: security * docs: admin api * docs: change to env vars * docs: auth api * docs: remove assets, deprecated requests, menu * reworked page with PaloAltoNetworks/docusaurus-openapi-docs * works with the resolutions * fix broken build by adding assets again * add tags to menu * chore: improve build speed * no-minify * test ssr * ssr 20 * use lazy * increase mem * use default mem * change names * docs: remove assets, deprecated requests, menu * docs: management api * docs: management api * docs: management api * docs: sidebar * not the best word smithing but it is ;-) * more typos * merge main * fix some error * trial * update grpc gateway * trigger vercel build * docs: deprecated requests * docs: deprecated requests --------- Co-authored-by: Fabienne <fabienne.gerschwiler@gmail.com> Co-authored-by: Max Peintner <max@caos.ch>
2023-02-23 12:08:06 +01:00
managed:
enabled: true
plugins:
feat: exchange gRPC server implementation to connectRPC (#10145) # Which Problems Are Solved The current maintained gRPC server in combination with a REST (grpc) gateway is getting harder and harder to maintain. Additionally, there have been and still are issues with supporting / displaying `oneOf`s correctly. We therefore decided to exchange the server implementation to connectRPC, which apart from supporting connect as protocol, also also "standard" gRCP clients as well as HTTP/1.1 / rest like clients, e.g. curl directly call the server without any additional gateway. # How the Problems Are Solved - All v2 services are moved to connectRPC implementation. (v1 services are still served as pure grpc servers) - All gRPC server interceptors were migrated / copied to a corresponding connectRPC interceptor. - API.ListGrpcServices and API. ListGrpcMethods were changed to include the connect services and endpoints. - gRPC server reflection was changed to a `StaticReflector` using the `ListGrpcServices` list. - The `grpc.Server` interfaces was split into different combinations to be able to handle the different cases (grpc server and prefixed gateway, connect server with grpc gateway, connect server only, ...) - Docs of services serving connectRPC only with no additional gateway (instance, webkey, project, app, org v2 beta) are changed to expose that - since the plugin is not yet available on buf, we download it using `postinstall` hook of the docs # Additional Changes - WebKey service is added as v2 service (in addition to the current v2beta) # Additional Context closes #9483 --------- Co-authored-by: Elio Bischof <elio@zitadel.com>
2025-07-04 10:06:20 -04:00
- remote: buf.build/grpc-ecosystem/openapiv2
docs: improve api docs (#5158) * integrate docs into nav * generator for local use, production needs to be set by env * fix typo * local dev * docs: annotate the first user endpoints in the management api * docs: annotate the first user endpoints in the management api * docs: annotate the first user endpoints in the management api * docs: annotate the first user endpoints in the management api * docs: add header params * rewrite docs links and improve ci * tweak build command * fix path * Update docs/docusaurus.config.js Co-authored-by: Max Peintner <max@caos.ch> * fix docker * docs: add header params * docs: Add tags to management api. add some descriptions * docs: more descriptions * docs: more descriptions * docs: required fields * docs: example request * docs: example request * docs: example request * docs: example request * docs: example request * docs: user metadata requests * docs: user requests * docs: user requests * docs: user requests * docs: user requests * docs: change nav add first methods to authentication api * docs: auth api * docs: auth api * docs: auth api * docs: auth api * docs: auth api * docs: api sidenav * chore: use buf without docker * fix deploy * fix ci * fix vercel * docs: admin * docs: admin api docs * docs: admin api docs * docs: admin api docs * docs: admin api docs * docs: security * docs: security * docs: admin api * docs: change to env vars * docs: auth api * docs: remove assets, deprecated requests, menu * reworked page with PaloAltoNetworks/docusaurus-openapi-docs * works with the resolutions * fix broken build by adding assets again * add tags to menu * chore: improve build speed * no-minify * test ssr * ssr 20 * use lazy * increase mem * use default mem * change names * docs: remove assets, deprecated requests, menu * docs: management api * docs: management api * docs: management api * docs: sidebar * not the best word smithing but it is ;-) * more typos * merge main * fix some error * trial * update grpc gateway * trigger vercel build * docs: deprecated requests * docs: deprecated requests --------- Co-authored-by: Fabienne <fabienne.gerschwiler@gmail.com> Co-authored-by: Max Peintner <max@caos.ch>
2023-02-23 12:08:06 +01:00
out: .artifacts/openapi
chore(api): initial definition of API for user schemas (user v3 and user schema v3 service) (#7372) Adds the initial proto definition for a new user service (v3) based on user schema and it's corresponding user schema service (v3)
2024-02-15 11:22:48 +01:00
opt:
- allow_delete_body
- remove_internal_comments=true
- preserve_rpc_order=true
chore(docs): prevent readme overwrite (#10170) # Which Problems Are Solved To generate the docs, we rely on a protoc plugin to generate an openAPI definition from connectRPC / proto. Since the plugin is not available on buf.build, we currently download the released version. As the tar contains a licence and a readme, this overwrote existing internal files. # How the Problems Are Solved Download and extract the plugin in a separate folder and update buf.gen.yaml accordingly. # Additional Changes None # Additional Context relates to #9483
2025-07-07 03:28:38 -04:00
- local: ./protoc-gen-connect-openapi/protoc-gen-connect-openapi
feat: exchange gRPC server implementation to connectRPC (#10145) # Which Problems Are Solved The current maintained gRPC server in combination with a REST (grpc) gateway is getting harder and harder to maintain. Additionally, there have been and still are issues with supporting / displaying `oneOf`s correctly. We therefore decided to exchange the server implementation to connectRPC, which apart from supporting connect as protocol, also also "standard" gRCP clients as well as HTTP/1.1 / rest like clients, e.g. curl directly call the server without any additional gateway. # How the Problems Are Solved - All v2 services are moved to connectRPC implementation. (v1 services are still served as pure grpc servers) - All gRPC server interceptors were migrated / copied to a corresponding connectRPC interceptor. - API.ListGrpcServices and API. ListGrpcMethods were changed to include the connect services and endpoints. - gRPC server reflection was changed to a `StaticReflector` using the `ListGrpcServices` list. - The `grpc.Server` interfaces was split into different combinations to be able to handle the different cases (grpc server and prefixed gateway, connect server with grpc gateway, connect server only, ...) - Docs of services serving connectRPC only with no additional gateway (instance, webkey, project, app, org v2 beta) are changed to expose that - since the plugin is not yet available on buf, we download it using `postinstall` hook of the docs # Additional Changes - WebKey service is added as v2 service (in addition to the current v2beta) # Additional Context closes #9483 --------- Co-authored-by: Elio Bischof <elio@zitadel.com>
2025-07-04 10:06:20 -04:00
out: .artifacts/openapi3
strategy: all
opt:
- short-service-tags
- ignore-googleapi-http
- base=base.yaml
Reference in New Issue Copy Permalink