[Tools-discuss] Re: documents by WG --- RFCs and related documents -- are there APIs

[Tom Pusateri <[e-mail]>]

Hopefully, the v1 API won’t change. Isn’t that the point of versioning? If the models were to change, then you should define a new v2 API so that you don’t break all the existing v1 users.

Thanks,
Tom

> On Jul 30, 2025, at 11:16 AM, Jennifer Richards <[e-mail]> wrote:
> 
> Hi Michael,
> 
>> On 2025-07-27 12:33 PM, Michael Richardson wrote:
>> Now I am thinking that I want to automate bring RFCxxxx into each directory.
>> 1. Is there an API that would return a WG's "RFC list"?
>> 2. Is there an API that would return a WG's Related Documents list?
>> Yes, I can read the DT source code, but asking here would tell me if the API
>> contract is stable, or if someone is considering changing it.
> 
> You can do this with the v1 (tastypie) API for RFCs:
> 
> $ curl -s 'https://datatracker.ietf.org/api/v1/doc/document/?type=rfc&group__acronym=httpapi' | jq -r '.objects[].name'
> rfc9512
> rfc9264
> rfc9457
> rfc9652
> rfc9745
> rfc9727
> 
> The related documents is more difficult because it involves a configuratble list of search rules. You can get ones that were explicitly added to the document list starting with
> 
> $ curl -s 'http://localhost:8000/api/v1/community/communitylist/?group__acronym=httpapi' | jq -r '.objects[].added_docs[]'
> /api/v1/doc/document/draft-pot-authentication-link/
> 
> which you can parse for the name or fetch as an API url to get more details.
> 
> AFAIK there's no (reasonable) way to get the related documents that appear because of search rule matches. It might be technically possible, but you'd likely be happier looking these up manually.
> 
> This API is stable, though closely reflects datatracker's models so may change if the modeling evolves. That's not likely to come up often.
> 
> jennifer
> 
> -----------------------------------------------
> Tools-discuss mailing list -- [e-mail]
> To unsubscribe send an email to [e-mail]
> https://mailarchive.ietf.org/arch/browse/tools-discuss/