Skip to content

[RFC] Allow different OpenAPI groups #20

Closed

Description

It would be quite handy, if multiple sets of OpenAPI could be generated, so each client/service can have their own APIs documented and accessible in the OCS API viewer.
E.g. in Talk we have multiple different API consumers and I would like to document and generate documentation for all of them in one way only:

Proposal

Similar to PHPUnits Group attribute and the already used IgnoreOpenAPI, we could also introduce an OpenAPI(scope: XYZ) attribute.
The openapi-extractor would then group the routes into different files and the ocs-api-viewer would show:

  • spreed - All controller methods without IgnoreOpenAPI or with OpenAPI or with OpenAPI(scope: default)
  • spreed-admin - All controller methods with OpenAPI(scope: admin)
  • spreed-signaling - All controller methods with OpenAPI(scope: signaling)
  • spreed-recording - All controller methods with OpenAPI(scope: recording)
  • spreed-sip - All controller methods with OpenAPI(scope: sip)

Depending on the discussion I can also imagine to look into this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions