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

Elements of a Hypermedia Message Document #10

Merged
merged 18 commits into from
Nov 24, 2014

Conversation

smizell
Copy link
Contributor

@smizell smizell commented Sep 18, 2014

Per issue #4, this is the first draft of this document describing the elements of a hypermedia message. It is all open for discussion, and I'd be happy to change anything. Below are some discussion items.

  • 1. Is the categorization of transitions helpful?
  • 2. Should this include the concept of curies or prefixes?
  • 3. Is the concept of anonymous links and actions helpful?
  • 4. Does it make sense to include embedded resources under transitions?
  • 5. How do we address more complex attributes? Ones that may include arrays of objects in JSON or nested elements in XML?

Once we come to a consensus, we can merge it into the repo. Thanks!

@smizell
Copy link
Contributor Author

smizell commented Nov 10, 2014

@fosrias @kylef @zdne @kylef All comments and questions addressed offline. Good to merge!

@@ -0,0 +1,132 @@
# Elements of Hypermedia Media Types
Copy link
Contributor

Choose a reason for hiding this comment

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

@smizell Should this be Hypermedia Messages?

Copy link
Member

Choose a reason for hiding this comment

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

Agree with @fosrias, lets talk about Hypermedia message (based on examination of hypermedia formats – media types)

Copy link
Member

Choose a reason for hiding this comment

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

In addition I would explicitly state that this document is describing elements of Hypermedia Messages in HTTP APIs, not in general.

Copy link
Contributor

Choose a reason for hiding this comment

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

Is this actually protocol dependent?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I believe I've included HTTP stuff, but we should make it protocol independent. I don't think it would take much effort. Most of the HTTP stuff centers around the HTTP methods.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Regarding the title, I thought @fosrias was interested in changing from referring to this as message, which is what I originally had:

smizell@91950c0

I'm really fine either way, and I think both are applicable.

Copy link
Contributor

Choose a reason for hiding this comment

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

@smizell Sorry for the confusion. Wanted to keep messages. So, your original commit was good.

@fosrias
Copy link
Contributor

fosrias commented Nov 11, 2014

@smizell Finished commenting on your comments.

@smizell
Copy link
Contributor Author

smizell commented Nov 21, 2014

@fosrias @zdne @kylef Ok, finally, I got around to this. Maybe it's good to merge now?

fosrias added a commit that referenced this pull request Nov 24, 2014
Elements of a Hypermedia Message Document
@fosrias fosrias merged commit 4946e1b into the-hypermedia-project:master Nov 24, 2014
@zdne
Copy link
Member

zdne commented Nov 24, 2014

👍

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