Skip to content

[Documentation] Document API endpoints using OpenAPI standard #1985

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
alexjustesen merged 8 commits into from
Jan 14, 2025
Merged

[Documentation] Document API endpoints using OpenAPI standard #1985

alexjustesen merged 8 commits into from
Jan 14, 2025

Conversation

@alexjustesen
Copy link
Owner

@alexjustesen alexjustesen commented Jan 13, 2025 •
edited
Loading

📃 Description

This PR implements OpenAPI documentation generation. To generate the docs run:

sail bin openapi ./app/Http/Controllers/Api -o openapi.json -f json

🪵 Changelog

➕ Added

  • openapi.json which will be imported into the docs

@alexjustesen alexjustesen added the documentation Improvements or additions to documentation label Jan 13, 2025
@alexjustesen alexjustesen self-assigned this Jan 13, 2025
@alexjustesen alexjustesen merged commit e4ce2f6 into main Jan 14, 2025
1 check passed
@alexjustesen alexjustesen deleted the document-api-using-openapi-standard branch January 14, 2025 01:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@alexjustesen alexjustesen

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@alexjustesen