/directory endpoint changes on staging

[jekstrom]

It looks like there is an additional property added (“meta”), which is a breaking change with the library I am currently using (we are working on a fix).

My question is, is there a mailing list or a post on these boards, or some other way to know when changes are being pushed to the staging and production APIs?

https://acme-staging.api.letsencrypt.org/directory
returns

{
  "izmAVcgt9L4": "https://community.letsencrypt.org/t/adding-random-entries-to-the-directory/33417",
  "key-change": "https://acme-staging.api.letsencrypt.org/acme/key-change",
  "meta": {
    "terms-of-service": "https://letsencrypt.org/documents/LE-SA-v1.1.1-August-1-2016.pdf"
  },
  "new-authz": "https://acme-staging.api.letsencrypt.org/acme/new-authz",
  "new-cert": "https://acme-staging.api.letsencrypt.org/acme/new-cert",
  "new-reg": "https://acme-staging.api.letsencrypt.org/acme/new-reg",
  "revoke-cert": "https://acme-staging.api.letsencrypt.org/acme/revoke-cert"
}

https://acme-v01.api.letsencrypt.org/directory
returns

{
  "key-change": "https://acme-v01.api.letsencrypt.org/acme/key-change",
  "new-authz": "https://acme-v01.api.letsencrypt.org/acme/new-authz",
  "new-cert": "https://acme-v01.api.letsencrypt.org/acme/new-cert",
  "new-reg": "https://acme-v01.api.letsencrypt.org/acme/new-reg",
  "revoke-cert": "https://acme-v01.api.letsencrypt.org/acme/revoke-cert"
}

[pfg]

Yep, this forum has an API Announcements category for this purpose. You can subscribe to new posts using the steps described here.

This is the announcement for the new meta entry:

Adding random entries to the directory

A…

[cpu]

Hi @jekstrom,

@pfg’s answer (Thank you!) about the API announcements category is the correct place to look. I haven’t made an announcement about this change yet but will post one today.

@jekstrom What client library are you working on? There was one other report of this breaking a client and I’ve filed https://github.com/letsencrypt/boulder/issues/2883 to have a central place to discuss. Since the “meta” entry has been present since draft-02 I’m hesitant to roll it back at this point and would instead encourage clients to take the approach you are & develop a fix.

This is the announcement for the new meta entry:

Small correction: That’s the announcement for a separate random entry at the top level of the /directory. There isn’t an announcement about the “meta” entry.

[cpu]

I’ve posted an API announcement about the /directory feature.

[jekstrom]

Thanks for the reponses. We will have to monitor the API Announcement channel.

I am not directly involved in creating a client, but we have issued a PR (noted on the github issue) on the client that we’re using (https://github.com/fszlin/certes).

The issue was the client library was assuming a general structure of string -> uri.