Establish the LibreSign OpenAPI foundation for official SDKs

オープン
#9,087 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
8/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
php, typescript
領域
api

調査の方向性

This is a multi-stage epic, not a single task: it needs an approved ten-tag taxonomy applied through attributes in the PHP controllers under lib/Controller/, then a generated typescript-axios client evaluated for a Go/No-Go decision. Start by reading the controllers and the existing openapi.json, openapi-administration.json and openapi-full.json, and treat the epic's definition of done as the finish line. Do not hand-edit the generated OpenAPI or TypeScript files.

索引モデルが issue の本文から書いたものです。

説明

enhancement

Objective

Prepare LibreSign's PHP-owned OpenAPI contracts for the generation of official SDKs, starting with TypeScript. This foundational epic has two implementation outcomes:

  1. Classify every existing documented operation into an approved, functional SDK taxonomy.
  2. Generate and evaluate a real TypeScript Axios HTTP client from the resulting contract, producing reproducible test evidence and a Go/No-Go decision for official SDK infrastructure.

This epic does not publish an SDK.

Verified starting point

  • openapi.json: 68 default-scope operations.
  • openapi-administration.json: 20 administration-scope operations.
  • openapi-full.json: 88 combined operations, currently grouped under 16 controller-oriented tags.
  • OpenAPI specifications are extracted from PHP by nextcloud/openapi-extractor; existing TypeScript definitions are generated by openapi-typescript.
  • The existing OpenAPI workflow verifies regenerated files. PHPUnit API tests already use byjg/swagger-test.
  • Contract hardening has already been done in PR #7662; do not repeat it.

Required deliverables

1. Classify the existing API into ten functional tags

Approved proposed groups, with expected operation counts:

Tag Operations
policies 17
identity 14
documents 6
requests 5
signing 8
appearance 16
verification 4
certificates 12
notifications 3
system 3
Total 88

The taxonomy issue carries the exact old-tag-to-new-tag mapping, including per-method routing where one old tag splits into multiple domains. The Policy Workbench is a conceptual reference, not a set of OpenAPI tags.

Tags must be changed in PHP controller attributes under lib/Controller/. The OpenAPI JSON and generated TypeScript declarations are outputs of the existing generation process, not files to edit manually.

2. Generate and evaluate the TypeScript client

From the classified openapi-full.json, use a pinned OpenAPI Generator typescript-axios toolchain to generate TypeScript API methods, types and an Axios-backed transport client in a disposable location.

Verify generation, compilation, operation coverage, grouping, representative schema fidelity, request serialization, OCS paths/headers, custom base paths and non-OCS paths. Document unsupported request bodies (notably existing multipart upload limitations) and issue a reproducible Go/No-Go decision.

A successful CLI command alone is not evidence that the generated SDK is usable.

Engineering and CI boundaries

  • PHP controllers remain the API source of truth; never patch generated OpenAPI artifacts by hand.
  • Preserve HTTP paths/methods, operationId values, scopes, security requirements, parameters, request/response contracts and backend authorization.
  • Retain existing OpenAPI extractor and ByJG workflows. Do not require exhaustive coverage of 88 operations / 182 documented responses.
  • No new PHP test generator, new test framework, database matrix or broad PHPUnit expansion.
  • Keep generator validation focused and independently runnable; measure costs before suggesting a mandatory recurring CI step.
  • Do not implement local OpenAPI multipart extractor workarounds while upstream support remains incomplete.

Long-term program direction — not part of this epic

The verified foundation will inform future work on:

  1. A dedicated, release-integrated SDK Generator with pinned inputs, reproducible builds and source provenance.
  2. An official, framework-independent TypeScript SDK with Nextcloud-compatible Axios injection.
  3. Migration of LibreSign-specific frontend API calls.
  4. Versioned Developer Manual API references, historical release notes, breaking changes, migration guidance and executable integration examples, with selection between supported stable release lines.
  5. Additional SDKs such as PHP and C# only when justified by real integration needs.

Keep application release version, supported Nextcloud version, HTTP API path version, OpenAPI document version and future SDK package version distinct. An SDK must be traceable to its originating LibreSign revision/contract.

Definition of done

  • The complete functional taxonomy has been explicitly approved and applied in PHP controllers.
  • The regenerated default, administration and full specifications preserve their existing operation inventories and HTTP contracts.
  • TypeScript Axios client generation is reproducible from a pinned specification and toolchain.
  • Generated API grouping, representative models and HTTP behavior have been tested, with limitations recorded.
  • A documented Go/No-Go conclusion states whether typescript-axios is suitable for the next stage.
  • Relevant existing validation passes without unjustified recurring CI cost.

Mandatory handoff before closing

Review the implemented PHP attributes, generated contracts, client and compatibility findings together. Record the validated revision, generator version/configuration, capabilities and limitations, Axios/OCS integration requirements, upstream multipart dependencies, release compatibility assumptions and what the next SDK Generator implementation must deliver.

Only after this review prepare and decompose the next epic. On a No-Go outcome, revisit the generator/architecture before creating permanent SDK infrastructure.

Out of scope

Broad API contract-test coverage; automatic PHPUnit test generation; permanent SDK repositories; npm/Packagist/NuGet publication; production frontend migration; PHP/C# SDK implementation; multipart extractor development; implementation of versioned documentation navigation; and changing the LibreSign release process.

主要言語
PHP
スター
844
フォーク
176
平均マージ
14時間 3分
マージ済み PR(30日)
344

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

LibreSign/libresign のほかの issue

LibreSign/libresign の issue をすべて見る

似ている issue

PHP の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。