Skip to content
This repository has been archived by the owner on Nov 8, 2024. It is now read-only.

Clarification of some terms around Transaction Examples #304

Conversation

honzajavorek
Copy link
Contributor

  • Added and clarified some terms in the Glossary.
  • Proofread a bit the section about Action in specification.

This will help me with writing of specification in apiaryio/blueprint-transactions#8 (I'll just link API Blueprint glossary and spec with all the terms).

@@ -48,7 +48,7 @@ An [**HTTP Request Method**](http://en.wikipedia.org/wiki/Hypertext_Transfer_Pro

<a name="def-message"></a>
### Message
An **HTTP transaction message**.
An **HTTP ction message**.
Copy link
Contributor

Choose a reason for hiding this comment

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

some mistake?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yup, noticed immediately and fixed :)

@honzajavorek honzajavorek force-pushed the honzajavorek/clarification-of-some-terms-around-transaction-examples branch from ab7249c to 617001a Compare January 22, 2016 12:56
@@ -666,9 +666,9 @@ This section **may** include one nested [Attributes section][] defining the inpu

Action section **should** include at least one nested [Response section](#def-response-section) and **may** include additional nested [Request](#def-request-section) and [Response](#def-response-section) sections.

Nested Request and Response sections **may** be ordered into groups where each groups represent one transaction example. First transaction example group starts with the first nested Request or Response section. Subsequent groups start with the first nested Request section following a Response section.
Nested Request and Response sections **may** be ordered into implicit groups where each such group represents one transaction example. First transaction example group starts with the first nested Request or Response section. Subsequent groups start with the first nested Request section following a Response section.
Copy link
Contributor

Choose a reason for hiding this comment

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

"may be ordered into implicit" does not make sense. They are ALWAY forming implicit groups. That is why they are implicit 🙃

@honzajavorek honzajavorek deleted the honzajavorek/clarification-of-some-terms-around-transaction-examples branch March 18, 2016 14:55
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants