Edit - Software Engineering Stack Exchange

You are not logged in. Your edit will be placed in a queue until it is peer reviewed.

We welcome edits that make the post easier to understand and more valuable for readers. Because community members review edits, please try to make the post substantially better than how you found it, for example, by fixing grammar or adding additional resources and hyperlinks.

Required fields*

Rev

1

And it doesn't hurt to document what you are doing in the documentation of your API.

gnasher729
– gnasher729

2016-02-12 08:27:15 +00:00
Commented Feb 12, 2016 at 8:27
1

Good documentation is the key here, but knowing what different standards say about it and what other people do or expect is useful when implementing your API.

David Perfors
– David Perfors

2016-02-12 09:06:32 +00:00
Commented Feb 12, 2016 at 9:06
David, thanks. That's very helpful and exactly the type of answer I'm looking for. I want my API to do the "expected" thing (as long as the expected thing is within the guidelines of http and REST). So if this is how jsonapi and odata are working, and it's kind of the de facto expected behavior, that's how I'll implement it.

richard
– richard

2016-02-13 01:06:27 +00:00
Commented Feb 13, 2016 at 1:06

Add a comment |

Correct minor typos or mistakes
Clarify meaning without changing it
Add related resources or links
Always respect the author’s intent
Don’t use edits to reply to the author

create code fences with backticks ` or tildes ~
```
like so
```
add language identifier to highlight code
```python
def function(foo):
print(foo)
```
put returns between paragraphs
for linebreak add 2 spaces at end
_italic_ or **bold**
indent code by 4 spaces
backtick escapes `like _so_`
quote by placing > at start of line
to make links (use https whenever possible)

<https://example.com>

[example](https://example.com)

<a href="https://example.com">example</a>

formatting help »
answering help »