-
Notifications
You must be signed in to change notification settings - Fork 129
docs: add @APIResponse annotations to config REST interfaces #550
Copy link
Copy link
Open
Labels
documentationJavadoc, markdown docs, OpenAPI annotations, code commentsJavadoc, markdown docs, OpenAPI annotations, code commentsgood first issueClear scope, low risk, pattern to follow - ideal for newcomersClear scope, low risk, pattern to follow - ideal for newcomershelp wantedsize: SSmall: about 1 hour, 2-8 files, mechanical pattern-followingSmall: about 1 hour, 2-8 files, mechanical pattern-following
Description
Activity
Metadata
Metadata
Assignees
Labels
documentationJavadoc, markdown docs, OpenAPI annotations, code commentsJavadoc, markdown docs, OpenAPI annotations, code commentsgood first issueClear scope, low risk, pattern to follow - ideal for newcomersClear scope, low risk, pattern to follow - ideal for newcomershelp wantedsize: SSmall: about 1 hour, 2-8 files, mechanical pattern-followingSmall: about 1 hour, 2-8 files, mechanical pattern-following
Summary
Several REST interfaces have
@Operationannotations but are missing@APIResponseannotations for HTTP status codes. Adding these improves the generated OpenAPI spec and Swagger UI documentation.Interfaces to update
@APIResponseconfigs/IRestVersionInfo.javaconfigs/properties/IRestPropertiesStore.javaconfigs/deployment/IRestDeploymentStore.javaconfigs/descriptors/IRestDocumentDescriptorStore.javaconfigs/channels/IRestChannelIntegrationStore.javaconfigs/agents/IRestCapabilityRegistry.javaPattern to follow
See
IRestAgentStore.javafor the established pattern:Common status codes by HTTP method:
Acceptance criteria
@APIResponseannotations./mvnw compilepasses