Skip to content

Commit f4b9bd1

Browse files
v3.1.0: bring ResourceDoc parity from 49 to 5 mismatches
Run scripts/restore_resource_doc_bodies.py against APIMethods310.scala (source of truth — fully stubbed, 102 commented `resourceDocs += ResourceDoc` blocks) to restore the canonical Lift descriptions, request/response examples, error lists, summaries, and tags into Http4s310.scala. 66 field rewrites across: description: 46 (46 → 0) successResponseBody: 8 (8 → 0) errorResponseBodies: 6 (6 → 0) exampleRequestBody: 3 (3 → 0) summary: 2 (2 → 0) tags: 1 (1 → 0) Upstream's rehydrate_resource_docs.py reported "0 patched" for v3.1.0 because it only matches non-stub `staticResourceDocs += ResourceDoc` blocks; the v3.1.0 APIMethods file uses `// resourceDocs += ResourceDoc` which my script handles via uncomment(). Supporting code carried over from the commented-out APIMethods310.scala so the restored descriptions compile: - Import: Glossary (the object, not the wildcard). - Four private vals referenced inside `s"""..."""` doc interpolations: productAttributeGeneralInfo, accountAttributeGeneralInfo, supportedConnectorNames, generalObpConsentText. Remaining 5 audit diffs are all structural drifts where http4s renamed the URL placeholder for ResourceDocMatcher / middleware reasons: createAccount ACCOUNT_ID → NEW_ACCOUNT_ID (PUT-creates pattern; middleware would 404 on ACCOUNT_ID lookup) deleteSystemView VIEW_ID → SYS_VIEW_ID (disambiguates from other VIEW_ID usages) getSystemView VIEW_ID → SYS_VIEW_ID (same) updateSystemView VIEW_ID → SYS_VIEW_ID (same) getFirehoseCustomers BANK_ID → FIREHOSE_BANK_ID (firehose middleware bypass — prop check before bank lookup) These are required for middleware correctness; the resolution is to document at the http4s site, not to revert. Per the source-of-truth rule, APIMethods310.scala is NOT modified.
1 parent 1647c01 commit f4b9bd1

1 file changed

Lines changed: 1014 additions & 197 deletions

File tree

0 commit comments

Comments
 (0)