MokoConsulting/MokoSuiteOpenGraph
1
0
Fork 0
Code Issues 3 Pull Requests Releases 1 Wiki Activity

Add OpenAPI/Swagger spec for REST API #80

New Issue
Closed
opened 2026-06-23 13:33:04 +00:00 by jmiller · 1 comment
jmiller commented 2026-06-23 13:33:04 +00:00
Owner
Copy Link
Copy Source

Summary

Document the /api/v1/mokoog/tags REST API with an OpenAPI 3.0 specification.

Why

  • MokoOG's REST API is a unique competitive advantage — no other Joomla OG extension has one
  • External integrations (mobile apps, headless CMS, CI/CD) need API documentation
  • OpenAPI spec enables auto-generated client SDKs and Swagger UI

Endpoints to Document

  • GET /api/v1/mokoog/tags — List all tags (with filters: content_type, content_id, language, published)
  • GET /api/v1/mokoog/tags/{id} — Get single tag
  • POST /api/v1/mokoog/tags — Create tag
  • PATCH /api/v1/mokoog/tags/{id} — Update tag
  • DELETE /api/v1/mokoog/tags/{id} — Delete tag

Implementation

  • Create openapi.yaml in project root
  • Document request/response schemas, authentication (API token), error responses
  • Consider adding Swagger UI page in admin component
## Summary Document the `/api/v1/mokoog/tags` REST API with an OpenAPI 3.0 specification. ## Why - MokoOG's REST API is a unique competitive advantage — no other Joomla OG extension has one - External integrations (mobile apps, headless CMS, CI/CD) need API documentation - OpenAPI spec enables auto-generated client SDKs and Swagger UI ## Endpoints to Document - `GET /api/v1/mokoog/tags` — List all tags (with filters: content_type, content_id, language, published) - `GET /api/v1/mokoog/tags/{id}` — Get single tag - `POST /api/v1/mokoog/tags` — Create tag - `PATCH /api/v1/mokoog/tags/{id}` — Update tag - `DELETE /api/v1/mokoog/tags/{id}` — Delete tag ## Implementation - Create `openapi.yaml` in project root - Document request/response schemas, authentication (API token), error responses - Consider adding Swagger UI page in admin component
jmiller added this to the Code Quality & Testing milestone 2026-06-23 13:33:04 +00:00
jmiller added the documentation label 2026-06-23 13:33:04 +00:00
jmiller commented 2026-06-23 13:33:10 +00:00
Author
Owner
Copy Link
Copy Source

Branch created: feature/80-add-openapi-swagger-spec-for-rest-api

git fetch origin
git checkout feature/80-add-openapi-swagger-spec-for-rest-api
Branch created: [`feature/80-add-openapi-swagger-spec-for-rest-api`](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteOpenGraph/src/branch/feature/80-add-openapi-swagger-spec-for-rest-api) ```bash git fetch origin git checkout feature/80-add-openapi-swagger-spec-for-rest-api ```
Sign in to join this conversation.
Labels
Clear labels
bug
Something is broken
 documentation
Documentation improvements
 enhancement
production-readiness
Required before v1.0 release
 security
Security vulnerability or hardening
 testing
Test coverage and QA
No labels documentation
Priority Medium
Type Feature
Milestone
No items
No Milestone Code Quality & Testing
Assignees
Clear assignees
jmiller (Jonathan Miller)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: MokoConsulting/MokoSuiteOpenGraph#80
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?