feat: RPC modernization APIs #9631

jennifer-richards · 2025-09-29T19:38:41Z

No description provided.

chore: Merge main branch

feat: api endpoint for docs submitted to the rpc

feat: optimize fetching persons

* feat: adding rev to demo doc creation * fix: remove attempt to control required

* feat: Add @requires_api_token decorator * refactor: Use @requires_api_token * refactor: Tweak api token endpoints This might be drifting from the design intent, but at least uses the defined endpoint values. Further cleanup may well be needed.

chore: Merge main into feat/rpc-api

* feat: subject_id -> Person api call * doc: Add error responses to openapi spec

chore: Merge main into feat/rpc-api

# Conflicts: # ietf/doc/models.py

chore: Merge main into feat/rpc-api

# Conflicts: # ietf/doc/models.py

chore: merge main into feat/rpc-api

* refactor: rpc_person -> PersonViewSet * refactor: rpc_subject_person -> SubjectPersonView * refactor: rpc_persons -> RpcPersonsView * refactor: move get_persons into PersonViewSet Changes the interface to return a list of Persons instead of a map from ID to name. * refactor: rpc_draft -> DraftViewSet * refactor: drafts_by_names -> DraftsByNameView * refactor: submitted_to_rpc -> DraftViewSet * refactor: rfc_original_stream -> RfcViewSet * refactor: rpc demo APIs -> viewset * refactor: get_draft_refs -> DraftViewSet * refactor: persons_by_email -> PersonViewSet * refactor: rfc_authors -> RfcViewSet * refactor: draft_authors -> DraftViewSet * refactor: avoid \x00 in regex validator Gets turned into a literal nul somewhere in the process of generating a schema and building a Python client for purple. This has the same effect but avoids the nul. * fix: missing arg on references() action * style: ruff, remove unused imports * style: ruff ruff * chore: remove rpcapi.yaml * refactor: move API to /api/purple Side effect is that the purple API client is named PurpleApi instead of RpcApi. * fix: get_draft_authors returns DraftWithAuthors * fix: distinguish CharField flavors * fix: no serializer validators for draft name/title This prevents at least one existing draft from being looked up. * fix: get_draft_authors works with str, not int * Revert "refactor: avoid \x00 in regex validator" This reverts commit 63f40cf * Revert "Revert "refactor: avoid \x00 in regex validator"" (#9111) This reverts commit d8656f4.

chore: merge main into feat/rpc-api

# Conflicts: # requirements.txt

feat: expose consensus in submission api

* refactor: central def of subseries doc types * feat: subseries doc API * refactor: optimize queries via prefetch Reduced 4500 to 18 queries * chore: remove debug * fix: fix serialization of draft field * refactor: clean up prefetch a bit * feat: filter by subseries type * fix: restore max_limit for RFC pagination

* feat: add subseries to RfcMetadataSerializer * feat: titlepage_name for RfcAuthorSerializer Always blank for now * chore: update copyrights * refactor: use py3.12 typing syntax

rjsparks

First pass inspecting "can this safely come into main".
I haven't done the "are the apis all sufficiently access guarded" read yet.

rjsparks · 2025-09-30T17:15:55Z

dev/deploy-to-container/settings_local.py

 APP_API_TOKENS = {
-  "ietf.api.views.ingest_email_test": ["ingestion-test-token"]
+  "ietf.api.views.ingest_email_test": ["ingestion-test-token"],  # Not a real secret
+  "ietf.api.views_rpc" : ["devtoken"],  # For RPC dev work only, remove before merging to main!!!


Replace this with "not a real secret"?

rjsparks · 2025-09-30T17:16:53Z

docker/configs/settings_local.py

    }
+
+APP_API_TOKENS = {
+    "ietf.api.views_rpc" : ["devtoken"],


not a real secret?

rjsparks · 2025-09-30T17:18:55Z

ietf/api/urls_rpc.py

+]
+
+# add routers at the end so individual routes can steal parts of their address
+# space (specifically, ^person/ routes so far)


verify that this is current?

rjsparks · 2025-09-30T17:23:00Z

ietf/api/views_rpc_demo.py

@@ -0,0 +1,98 @@
+# Copyright The IETF Trust 2023-2025, All Rights Reserved


Should this capability come to main? I'm thinking it shouldn't.

rjsparks · 2025-09-30T17:24:43Z

ietf/doc/models.py

    def part_of(self):
        return self.related_that("contains")
-
+    


rjsparks · 2025-09-30T17:26:34Z

ietf/doc/models.py

+            return self.docevent_set.filter(type="iesg_approved").order_by("-time").first()
+        elif self.stream_id in ["iab", "irtf", "ise"]:
+            return self.docevent_set.filter(type="requested_publication").order_by("-time").first()
+        #elif self.stream_id == "editorial": #TODO


we have one now to look at and then add this branch to the logic

feat: add consensus on FullDraftSerializer

feat: add type field in group serializer

* feat: tag subseries API endpoints for purple * ruff

* change slugs/names * change slug names * fix: update RfcStatusSlugT

This was meant to include the API call in both purple and red API clients. It seems this does not work, at least with some generators. Need to investigate further, but we should be able to work around it.

* feat: rfc authors * fix: distinct rfc search results * fix: include titlepage_name in author name searches * fix: add is_editor to rfcauthor model. Adjust FK on_delete. Tweak admin. * fix: renumber migration * refactor: realistic titlepage_name in factory * refactor: comment + rename iteration var * chore: bump copyright year * chore: remove country from RfcAuthor Not planning to track this * refactor: make blank=False explicit * chore: remove country from admin * fix: author_list() for type=rfc * fix: blankable RfcAuthor.person * feat: RfcAuthor-aware document_json() * feat: limit docs to rfcs for RfcAuthor admin * test: document_json authors * fix: use author_names() for get_document_emails() * feat: suggest affiliation based on RfcAuthor * chore: revert "remove country from RfcAuthor" This reverts commit 3044d10. * chore: revert "remove country from admin" This reverts commit 2088793. * feat: use rfcauthors for nomcom eligibility (#9629) * refactor: author-based eligibility cleanup * feat: use rfcauthor recs for nomcom eligbility * chore: remove commented code * refactor: factor out helper for testing * test: test_get_qualified_author_queryset * fix: restore a necessary import * test: fix test_elig_by_author * test: fix test_decorate_volunteers_with_qualifications * test: add comment * fix: drop test for draft-rfceditor state Attempted to limit to drafts literally in the queue, but was not a valid check when looking back in time. As a practical matter, the test is not necessary. * fix: exclude double counting, not rfc pub state * test: update test --------- Co-authored-by: Robert Sparks <[email protected]>

* refactor: move get_rfc_authors API URL * refactor: drop format_suffixes from router Creates a bunch of API endpoints we have no intention of ever using * feat: RfcAuthor API (WIP) * fix: remove debug code * style: remove stray whitespace

* fix: partial implementation of rfc authors() Does not handle RfcAuthor instances where person is None yet. * refactor: authors -> bulk_authors for URL consistency

* fix: add OpenApi param definition doc_id * add schema def for person_id

* feat: API to publish RFC (WIP) Incomplete and in need of refactoring, but publishes an RFC. * feat: group / formal_languages from draft * feat: allow optional formal_languages via API Could do the same with group, but not clear it would ever be used. * feat: fill in overrides/updates * feat: subseries membership * fix: tolerate race to create related docs * fix: wrap pub in a transaction * feat: prevent re-publishing draft as RFC * chore: remove stale code * chore: remove debug * feat: RFC file upload API (WIP) Checkpointing progress before going further. * feat: specify RFC, validate file exts * feat: move uploaded files into place * feat: add replace option * fix: add rest of replace option * feat: handle ad/group more consistently * chore: remove inadvertent change * chore: drop external_url, get note from draft * refactor: clarify default value logic * refactor: ID obsoletes/updates by number * fix: handle draft-stream-editorial

jennifer-richards and others added 30 commits September 26, 2023 10:44

feat: Add rpc_person API call

0e4a032

chore: Add OpenAPI yaml for RPC API

e92136c

Merge pull request #6388 from ietf-tools/main

0f90c4d

chore: Merge main branch

feat: api endpoint for docs submitted to the rpc

0e309d0

chore: remove some debug

3998f34

Merge pull request #6390 from rjsparks/submitted_to_rpc

14471ec

feat: api endpoint for docs submitted to the rpc

feat: api for created demo people

76f043a

feat: optimize fetching persons

ec324e0

Merge pull request #6391 from rjsparks/persons_optimization

75d01b2

feat: optimize fetching persons

feat: api for creating demo drafts (#6402)

f27ff98

fix: Typo in rpcapi.yaml

9e9a787

refactor: Allow existing Person in create_demo_person (#6398)

fd90d8b

fix: include pubreq docevents in demo drafts (#6404)

fbc1dde

fix: Minor API fixes (#6405)

57f5c9a

chore: Document 404 from rpcapi get_person_by_id

603ba8c

feat: adding rev to demo doc creation (#6425)

084e863

* feat: adding rev to demo doc creation * fix: remove attempt to control required

refactor: Improve usability of @requires_api_token

8c29605

feat: get_draft_by_id api call (#6446)

272db6d

fix: construct the cdn photo url correctly (#6491)

4bc5ec6

chore: restructure the rpc api (#6505)

5c0cdec

fix: authenticate person api correctly

f2b3138

chore: Fix plain_name lookup

6b75cff

Merge pull request #6551 from ietf-tools/main

524f714

chore: Merge main into feat/rpc-api

feat: subject_id -> Person api call (#6566)

3f04ca7

* feat: subject_id -> Person api call * doc: Add error responses to openapi spec

Merge pull request #6631 from ietf-tools/main

4a129ac

chore: Merge main into feat/rpc-api

Merge pull request #6717 from ietf-tools/main

adf4f5a

chore: Merge main into feat/rpc-api

Merge remote-tracking branch 'upstream/main' into feat/rpc-api

02bdf4f

# Conflicts: # ietf/doc/models.py

Merge pull request #6788 from ietf-tools/main

5d5459f

chore: Merge main into feat/rpc-api

Merge branch 'main' into feat/rpc-api

633e000

# Conflicts: # ietf/doc/models.py

jennifer-richards and others added 13 commits July 7, 2025 13:46

Merge pull request #9108 from ietf-tools/main

fc7b1c5

chore: merge main into feat/rpc-api

ci: only migrate blobdb if it is configured

84da631

feat: add email/url to purple person API (#9127)

8bca0e1

Merge pull request #9316 from ietf-tools/main

24d9815

chore: merge main into feat/rpc-api

Merge branch 'main' into feat/rpc-api

5eae568

# Conflicts: # requirements.txt

feat: expose consensus in submission api

b34bb04

Merge pull request #9504 from rudimatz/feat/add-consensus-submission

9bb80a5

feat: expose consensus in submission api

feat: add subseries+stub titlepage_name to rfc serializer (#9569)

cb34712

* feat: add subseries to RfcMetadataSerializer * feat: titlepage_name for RfcAuthorSerializer Always blank for now * chore: update copyrights * refactor: use py3.12 typing syntax

chore: merge main to feat/rpc-api

6c6b8d7

fix: renumber migrations

983c794

feat: add consensus on FullDraftSerializer

4f5da10

rjsparks reviewed Sep 30, 2025

View reviewed changes

jennifer-richards and others added 12 commits October 1, 2025 11:57

Merge pull request #9605 from rudimatz/feat/add-consensus-submission

3daf659

feat: add consensus on FullDraftSerializer

feat: add type field in serializer

18cc41a

Merge pull request #9776 from rudimatz/feat/add-type-for-group

8d0bbb2

feat: add type field in group serializer

feat: tag subseries API endpoints for purple (#9763)

23960e9

* feat: tag subseries API endpoints for purple * ruff

feat: change slugs/names (#9778)

d1aa690

* change slugs/names * change slug names * fix: update RfcStatusSlugT

fix: remove double tag (#9787)

c020f0f

This was meant to include the API call in both purple and red API clients. It seems this does not work, at least with some generators. Need to investigate further, but we should be able to work around it.

chore: merge main into feat/rpc-api

18faad8

fix: renumber migrations

1f574f3

feat: basic RfcAuthor API (#9940)

a487afb

* refactor: move get_rfc_authors API URL * refactor: drop format_suffixes from router Creates a bunch of API endpoints we have no intention of ever using * feat: RfcAuthor API (WIP) * fix: remove debug code * style: remove stray whitespace

fix: authors API for xfer (#9961)

d4a8c02

* fix: partial implementation of rfc authors() Does not handle RfcAuthor instances where person is None yet. * refactor: authors -> bulk_authors for URL consistency

fix: add OpenApi param definition doc_id (#9962)

c598089

* fix: add OpenApi param definition doc_id * add schema def for person_id

jennifer-richards had a problem deploying to dev November 17, 2025 22:48 — with GitHub Actions Failure

jennifer-richards added 3 commits November 24, 2025 20:17

feat: split unknown vs already published draft error (#10011)

3f73e55

feat: use RfcAuthor for red API (#10014)

9fce327

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: RPC modernization APIs #9631

feat: RPC modernization APIs #9631

jennifer-richards commented Sep 29, 2025

Uh oh!

rjsparks left a comment

Uh oh!

rjsparks Sep 30, 2025

Uh oh!

rjsparks Sep 30, 2025

Uh oh!

rjsparks Sep 30, 2025

Uh oh!

rjsparks Sep 30, 2025

Uh oh!

rjsparks Sep 30, 2025

Uh oh!

rjsparks Sep 30, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

		@@ -0,0 +1,98 @@
		# Copyright The IETF Trust 2023-2025, All Rights Reserved

feat: RPC modernization APIs #9631

Are you sure you want to change the base?

feat: RPC modernization APIs #9631

Conversation

jennifer-richards commented Sep 29, 2025

Uh oh!

rjsparks left a comment

Choose a reason for hiding this comment

Uh oh!

rjsparks Sep 30, 2025

Choose a reason for hiding this comment

Uh oh!

rjsparks Sep 30, 2025

Choose a reason for hiding this comment

Uh oh!

rjsparks Sep 30, 2025

Choose a reason for hiding this comment

Uh oh!

rjsparks Sep 30, 2025

Choose a reason for hiding this comment

Uh oh!

rjsparks Sep 30, 2025

Choose a reason for hiding this comment

Uh oh!

rjsparks Sep 30, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants