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 text for the Method Requirement example #5779

Closed
wants to merge 1 commit into from

Conversation

carlos-granados
Copy link

The text associated with this example described an old example which was changed in this branch (2.3)

The text associated with this example described an old example which was changed in this branch (2.3)
@xabbuh
Copy link
Member

xabbuh commented Oct 20, 2015

Thanks for proposing this Carlos. Actually, we do discuss this in #5583 and someone also proposed a change in #5659.

@wouterj
Copy link
Member

wouterj commented Dec 21, 2015

Thank you for trying to fix the documentation, @carlos-granados!

I've created #6062, which rewrites this section to try to explain this feature using a valid use-case. I'm going this close this PR in favor of that new one. 🎄

@wouterj wouterj closed this Dec 21, 2015
xabbuh added a commit that referenced this pull request Jan 11, 2016
This PR was merged into the 2.3 branch.

Discussion
----------

Update HTTP method requirement example

| Q | A
| --- | ---
| Doc fix? | yes
| New docs? | no
| Applies to | 2.3+
| Fixed tickets | #5583

After many reports (#5779, #5659) of the text no longer matching the example, I think it's time to update the example.

The example now uses an API, which is a very common thing now and often needs this feature. API's are already used in the Page Creation article, which is placed before this article, so it shouldn't be too hard to understand.

I know that from a REST prespective, HEAD and GET using the same action doesn't seem that great, but it's the only action I could think of that may support 2 methods.

Commits
-------

30c2750 Update method requirement example
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