Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FIX error responses section in NGSIv2 spec #3226

Merged
merged 4 commits into from
Jun 26, 2018

Conversation

fgalan
Copy link
Member

@fgalan fgalan commented Jun 21, 2018

Section "Error responses" has been re-written, based on #1286 explaining with more detail how error are generated in NGSIv2.

I suggest not ussing diff at github, which is pretty confusing, but to read the new version directly.

Copy link
Contributor

@jmcanterafonseca jmcanterafonseca left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, with the points raised addressed


New error codes may be defined in new iterations of this specification.

All NGSIv2 server implementations must use the following HTTP response codes and `error` texts
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

HTTP status codes

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in adac43d


NGSIv2 `error` reporting is as follows:

+ If the incoming JSON payload cannot be parsed then `ParseError` (`400`) is return.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

returned

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in adac43d

NGSIv2 `error` reporting is as follows:

+ If the incoming JSON payload cannot be parsed then `ParseError` (`400`) is return.
+ Request error which only depends on the request itself (i.e. it does not depend on the NGSIv2 server status),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Errors which are only caused by request content

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in adac43d

+ Exception: incoming JSON payload errors, which have another `error` message (see previous bullet).
+ Attemp to exceed spatial index limit results in `NoResourceAvailable` (`413`). See "Geospatial properties of entities"
section for details.
+ Ambiguety due to the request may refer to several resources, e.g. attempt to update an entity providing only its ID
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

check spelling

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in adac43d

@AlvaroVega AlvaroVega merged commit b0b601d into master Jun 26, 2018
@AlvaroVega AlvaroVega deleted the hardening/ngsiv2_spec_improve_error_descriptions branch June 26, 2018 05:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants