api.congress.gov icon indicating copy to clipboard operation
api.congress.gov copied to clipboard

Published 20 hours ago • verified publisher icon LibraryOfCongress

#280 Upgrade API documentation (Swagger -> OpenAPI 3.0)

Open paulrinaldi opened this issue 4 months ago • 5 comments
trafficstars

Addresses https://github.com/LibraryOfCongress/api.congress.gov/issues/280

paulrinaldi avatar Jul 14 '25 18:07 paulrinaldi

I noticed that none of the successful responses have a fleshed out schema. Why is that?

douglasmanzelmann avatar Aug 02 '25 15:08 douglasmanzelmann

I noticed that none of the successful responses have a fleshed out schema. Why is that?

@douglasmanzelmann - can you please create an issue that details 1) what you are currently experiencing and 2) what your expectation of the data is? That way, we can analyze what you report. Thank you.

apreiter18 avatar Aug 05 '25 11:08 apreiter18

I noticed that none of the successful responses have a fleshed out schema. Why is that?

@douglasmanzelmann - can you please create an issue that details 1) what you are currently experiencing and 2) what your expectation of the data is? That way, we can analyze what you report. Thank you.

apreiter18 avatar Aug 05 '25 11:08 apreiter18

I noticed that none of the successful responses have a fleshed out schema. Why is that?

@douglasmanzelmann - can you please create an issue that details 1) what you are currently experiencing and 2) what your expectation of the data is? That way, we can analyze what you report. Thank you.

Considering this isn't merged, would creating an issue make sense?

As for what I'm expecting, here's an example of the issue. A successful response returns an object without specifying any of the fields that would be returned. So if I wanted to generate an API client from this, it would still require a lot of manual work and guess work to know what would come back.

douglasmanzelmann avatar Sep 27 '25 18:09 douglasmanzelmann

I noticed that none of the successful responses have a fleshed out schema. Why is that?

@douglasmanzelmann - can you please create an issue that details 1) what you are currently experiencing and 2) what your expectation of the data is? That way, we can analyze what you report. Thank you.

Considering this isn't merged, would creating an issue make sense?

As for what I'm expecting, here's an example of the issue. A successful response returns an object without specifying any of the fields that would be returned. So if I wanted to generate an API client from this, it would still require a lot of manual work and guess work to know what would come back.

Thanks - this is helpful. No issue needed here.

apreiter18 avatar Sep 29 '25 14:09 apreiter18