Skip to content

Split OpenAPI specification (consumer-facing, protocol definition) #285

@daniel-mader

Description

@daniel-mader

Description

Advantages

We should consider not including the standardized protocol endpoint in the public OpenAPI definition since they are not intended to be called directly by consumers. Also, it's less effort to not document them explicitly.

Disadvantags

How do we make sure we're compliant with the standards if we don't automatically generate and export the endpoints? Would it improve testing efforts if we have an OpenAPI specification or is that unnecessary effort since the test environments know about the protocols and endpoints anyway?

Motivation

No response

Resources

No response

To-do List

n/a

Metadata

Metadata

Assignees

No one assigned

    Labels

    DRAFTMarks an issue or a pull request as "not yet ready".DocumentationImprovements or additions to documentationEnhancementNew feature or improvement to an existing feature

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions