Skip to content

Comments

docs: add summaries to api endpoints#49

Merged
jason-lynch merged 1 commit intomainfrom
feat/PLAT-86/api-endpoint-summaries
Jun 13, 2025
Merged

docs: add summaries to api endpoints#49
jason-lynch merged 1 commit intomainfrom
feat/PLAT-86/api-endpoint-summaries

Conversation

@jason-lynch
Copy link
Member

@jason-lynch jason-lynch commented Jun 12, 2025

Adds summary and tag metadata fields to our API endpoints in the OpenAPI spec. The summary fields show in the restish help text. The tag fields are used by documentation generators to group endpoints together.

PLAT-86

@jason-lynch jason-lynch force-pushed the feat/PLAT-86/consistent-api-errors branch from 1af8911 to d3f2f7e Compare June 12, 2025 20:58
@jason-lynch jason-lynch force-pushed the feat/PLAT-86/api-endpoint-summaries branch from 8a7079b to c2400d1 Compare June 12, 2025 21:02
@jason-lynch jason-lynch force-pushed the feat/PLAT-86/consistent-api-errors branch 3 times, most recently from 1f9b253 to 8d0cd4d Compare June 12, 2025 21:16
@jason-lynch jason-lynch force-pushed the feat/PLAT-86/api-endpoint-summaries branch 2 times, most recently from e64f881 to b8c6248 Compare June 12, 2025 21:22
@jason-lynch jason-lynch force-pushed the feat/PLAT-86/consistent-api-errors branch from 8d0cd4d to 70afbc3 Compare June 12, 2025 21:53
@jason-lynch jason-lynch force-pushed the feat/PLAT-86/api-endpoint-summaries branch from b8c6248 to f1d8414 Compare June 12, 2025 21:54
@jason-lynch jason-lynch force-pushed the feat/PLAT-86/consistent-api-errors branch from 70afbc3 to 9abe765 Compare June 13, 2025 11:31
@jason-lynch jason-lynch force-pushed the feat/PLAT-86/api-endpoint-summaries branch from f1d8414 to 5e4ae7a Compare June 13, 2025 11:32
@jason-lynch jason-lynch force-pushed the feat/PLAT-86/consistent-api-errors branch 2 times, most recently from f3cc418 to 692fb66 Compare June 13, 2025 17:17
Adds summary and tag metadata fields to our API endpoints in the OpenAPI
spec. The summary fields show in the restish help text. The tag fields
are used by documentation generators to group endpoints together.

PLAT-86
@jason-lynch jason-lynch force-pushed the feat/PLAT-86/api-endpoint-summaries branch from 5e4ae7a to e0216f5 Compare June 13, 2025 17:19
Base automatically changed from feat/PLAT-86/consistent-api-errors to main June 13, 2025 18:20
@jason-lynch jason-lynch merged commit 5dc1697 into main Jun 13, 2025
2 checks passed
@jason-lynch jason-lynch deleted the feat/PLAT-86/api-endpoint-summaries branch June 13, 2025 18:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants