Inline action syntax

[pksunkara]

For @zdne to review & merge.

I was unable to decide about adding an example API showing the inline action in the examples folder. Please correct me if I am wrong, but the examples folder is for the major things, right?

[zdne]

"For @zdne to review & merge", again @kylef is fully capable of doing this as well :)

[zdne]

Please correct me if I am wrong, but the examples folder is for the major things, right?

I would say it is for any and all examples that are worthy. If they are part of the "course" they should be numbered where the lower number the more fundamental topic of the example (so maybe this is one with a fairly high number)

[zdne]

I would remove "This is also known by the name Inline Action."

[zdne]

Blockers are my comments above and missing example both in specification and in the examples folder. Also it would be good to explain action a resource affordance represented by link transition. Distinguishing state transition within the same resource ## <identifier> [<HTTP request method>] and state transition that to another resource ## <identifier> [<HTTP request method> <URI template>].

Feel free to spend some time studying the state transition topic as it is fundamental principle of REST architecture.

[pksunkara]

Updated.

[zdne]

So while we use this name "internally" I do not think we should communicate is as a (new) concept. There is no such a thing as inlined transitions or affordances. I would simply name this example as "Advanced Action"

[zdne]

Solid kick-off. Although I think in needs a little bit of touch – Since we are introducing the term "state transition" here for the first time, if I am correct, I think it would be good to mention somewhere in the lead that Action as such is a state transition..

[pksunkara]

Updated.

[zdne]

An action in a resource in the API Blueprint can be considered as a state transition

A resource action is – in fact – a state transition.

This API example demonstrates that a resource can contain a state transition to another resource.

This API example demonstrates an action – state transition – to another resource.

This allows us to show that the resource Task can afford an action that is not limited to the resource Task.

I would remove this sentence completely

[kylef]

In the specification's resource section (10), there is the following statement:

URI parameters discussed in the scope of a Resource section apply to any and all nested Action sections.

I think this needs to be reworded as I don't believe it applies anymore anymore, given the following example:

## User [/users/{username}]

+ Parameters
    + username...

### Create a User [POST /users]

[zdne]

I think this needs to be reworded as I don't believe it applies anymore anymore

@kylef good catch!

@pksunkara please take this into account

[pksunkara]

Updated.

[zdne]

The last sentence does not make sense. Please re-read it loud & then improve it.

[zdne]

Please fix the example.

[pksunkara]

Oops. Forgot to remove the word that. Fixed now.