Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Make consume/bulk-consume APIs consistent with sysFields

See original GitHub issue

By default both should not return system fields. System fields will return iff with-meta parameter is supplied.

Issue Analytics

State:
Created 6 years ago
Comments:6 (5 by maintainers)

Top GitHub Comments

1reaction

hochgicommented, Nov 9, 2017

This also means with-data by default (or else you get empty response by default).
It should be handled correctly for “thin responses”, e.g: tsv.
We should fix docs saying that “streamable APIs” have with-meta=false by default, whereis “expansable APIs” have with-meta=true by default. This is no longer true given this change.

0reactions

hochgicommented, Nov 12, 2017

all the formatting parameters should be available to all APIs. difference is which we defaults to.

Top Results From Across the Web

What does it really mean to design a 'consistent' API?

With that comes the need to design API that is consistent, reliable, well-documented, and easy to understand.

Apigee API Management - Google Cloud

Operate APIs—built or deployed anywhere—with consistency (Learn more). Create API products to generate new revenue streams and vibrant communities (Guide).

Announcing AWS Data Exchange for APIs: Find, Subscribe to ...

Today, I'm happy to announce the general availability of AWS Data Exchange for APIs, a new capability that lets you find, subscribe to,...

Spectral - Open Source API Description Linter - Stoplight

Reduce decision-making and promote consistent API descriptions. Ask 100 API designers what makes a good API design and you'll get 101 answers, but...