Skip to content

Comments

chore: add api docs server to control-plane-dev#56

Merged
jason-lynch merged 1 commit intomainfrom
chore/PLAT-86/api-docs-for-development
Jun 16, 2025
Merged

chore: add api docs server to control-plane-dev#56
jason-lynch merged 1 commit intomainfrom
chore/PLAT-86/api-docs-for-development

Conversation

@jason-lynch
Copy link
Member

Adds an API docs server to the control-plane-dev configuration. You'll be able to access the API documentation at http://localhost:8999 when you run make dev-watch.

Being able to view the API docs in this format makes it easier to review some parts of the generated OpenAPI spec, such as request and response examples.

PLAT-86

@jason-lynch jason-lynch force-pushed the chore/PLAT-86/api-docs-for-development branch from 8177e36 to ec4cc92 Compare June 15, 2025 12:47
@jason-lynch jason-lynch force-pushed the feat/PLAT-86/api-formatting branch from 713706b to d7c8169 Compare June 15, 2025 19:41
@jason-lynch jason-lynch force-pushed the chore/PLAT-86/api-docs-for-development branch from ec4cc92 to d026649 Compare June 15, 2025 19:41
@jason-lynch jason-lynch requested review from mmols and tsivaprasad June 16, 2025 11:40
Copy link
Contributor

@tsivaprasad tsivaprasad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.
image

@jason-lynch jason-lynch force-pushed the feat/PLAT-86/api-formatting branch from d7c8169 to 8f0a0bc Compare June 16, 2025 18:59
Base automatically changed from feat/PLAT-86/api-formatting to main June 16, 2025 19:04
Adds an API docs server to the `control-plane-dev` configuration. You'll
be able to access the API documentation at `http://localhost:8999` when
you run `make dev-watch`.

Being able to view the API docs in this format makes it easier to review
some parts of the generated OpenAPI spec, such as request and response
examples.

PLAT-86
@jason-lynch jason-lynch force-pushed the chore/PLAT-86/api-docs-for-development branch from d026649 to f1d628a Compare June 16, 2025 19:05
@jason-lynch jason-lynch merged commit 4a8949d into main Jun 16, 2025
2 checks passed
@jason-lynch jason-lynch deleted the chore/PLAT-86/api-docs-for-development branch June 16, 2025 19:10
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.

3 participants