Directorium/Api
1
0
Fork 0
Code Issues 99 Pull requests 5 Projects Releases 1 Packages Wiki Activity Actions

[Epic] SDKs, docs portal & versioning policy #106

New issue
Open
opened 2026-07-01 06:52:38 +00:00 by manlycucumber · 0 comments
manlycucumber commented 2026-07-01 06:52:38 +00:00 (Migrated from github.com)
Copy link

Make the API a pleasure to consume. The OpenAPI spec (#56) is the source of truth; generate SDKs from it, ship a docs portal, and commit to a versioning/deprecation policy. Done when JS/PHP/Python SDKs are generated from the spec and a /v1 deprecation policy is published.

Epic — child issues are tracked as sub-issues.

Make the API a pleasure to consume. The OpenAPI spec (#56) is the source of truth; generate SDKs from it, ship a docs portal, and commit to a versioning/deprecation policy. Done when JS/PHP/Python SDKs are generated from the spec and a `/v1` deprecation policy is published. _Epic — child issues are tracked as sub-issues._
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
develop
main
ci/port-release-automation
renovate/squizlabs-php_codesniffer-4.x
renovate/phpunit-phpunit-13.x
dependabot/composer/develop/phpstan/phpstan-2.2.5
dependabot/composer/develop/phpstan/phpstan-phpunit-2.0.18
dependabot/composer/develop/squizlabs/php_codesniffer-tw-4.0
release-please--branches--develop
v0.1.0
Labels
Clear labels   
area: api
Endpoints & contracts

  
area: auth
API keys / quotas / tenants

  
area: build
Build & tooling

  
area: cache
Cache-first / static-gen / ETags

  
area: ci
CI / release

  
area: compare
Cross-edition / cross-rite comparison tool

  
area: model
Structured liturgical models (Ordo Missae, Office, diff)

  
area: provenance
Sources, citations, errata, and the resolution trace

  
area: rite
Multi-rite framework and non-Roman rites

  
backport
Cherry-pick into a maintained older line

  
blocked
Blocked until something else resolves

  
breaking
Backward-incompatible change (major bump)

  
confirmed
Reproduced / accepted as real

  
dependencies
Pull requests that update a dependency file

  
duplicate
Duplicate of another issue

  
epic
Epic — tracking issue grouping child issues

  
invalid
Not a valid issue

  
needs-info
Waiting on more detail

  
needs-triage
New, not yet reviewed

  
php
Pull requests that update php code

  
priority: high
Do next; urgent or high impact

  
priority: low
Nice to have / someday

  
priority: medium
Normal queue

  
regression
Worked in a previous release

  
type: chore
Maintenance / internal

  
type: correction
A liturgical-data correction backed by a citation

  
type: docs
Documentation

  
type: enhancement
Improvement to existing behaviour

  
type: feature
New user-facing capability

  
type: fix
Bug fix

  
type: perf
Performance improvement

  
type: refactor
Internal refactor

  
type: security
Security fix

  
wontfix
Will not be worked on

No labels
area: api
area: auth
area: build
area: cache
area: ci
area: compare
area: model
area: provenance
area: rite
backport
blocked
breaking
confirmed
dependencies
duplicate
epic
invalid
needs-info
needs-triage
php
priority: high
priority: low
priority: medium
regression
type: chore
type: correction
type: docs
type: enhancement
type: feature
type: fix
type: perf
type: refactor
type: security
wontfix
Milestone
Clear milestone
No items
No milestone
v1.0.0
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
Directorium/Api#106
No description provided.