northdata / api Goto Github PK

The parameter to select the widget type should always be "type", and not "layout".

Hi,
I just experienced a undocumented behavior in your reference guide while trying out your rest api that lead to a bit confusion in our team.

It looks like that the /company/v1/publications endpoint is not behaving as documented (at least if you are only using the reference guide), while not providing a "source" parameter which is said to be "required" you still can query this endpoint which results in publication results from "Hrb" sources. If a field is marked as "required" I (and at least the other developers in our team) expected an error for an missing required parameter not defaulting to one (without documentation).
Please provide an error message or adjust your reference guide (e.g. set the parameter in the reference guide to optional and mention the defaulting to "Hrb" source behavior)

EDIT: I just saw that you mentioned this behavior on the github readme of this repository but still... wouldn't the reference guide be the better place to mention this behavior? (+ the fact that its actually not a required field)

It would be useful to have links to help center articles in the Data API user guide whereever appropriate, e.g., in the form
Please also see our help center article (linked article of title)

• Link to https://help.northdata.com/en/center/power-search-overview in introductory section of "Power Search"
• Link to https://help.northdata.com/en/center/keywords in section "Keywords"
• Link to https://help.northdata.com/en/center/industry-segment-classification in section "Filtering by segment codes"
• also check if links to the help center articles "Power Search: Geographic Filters", "Power Search: Performance Indicators", "Power Search: Event Filter" and "Quick search" would make sense

Universal search doesn't respond with nextPos as stated, but with nextOffset instead.

In swagger.yaml the host is defined as: host: www.northdata.de.

Right now doing requests with language=en receive 301 with following location:
https://www.northdata.com:443/_api/company/v1/company?name=...&language=en.

When the parameter is de, the request will not be redirected.