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

Sourcemap description and serialization #11

Merged
merged 6 commits into from
Oct 6, 2014
Merged

Conversation

pksunkara
Copy link
Contributor

No description provided.

@pksunkara
Copy link
Contributor Author

@zdne @fosrias Please review this.


---

## Quick Links

+ [AST Description](#ast-description)
+ [Sourcemap Description](#sourcemap-description)
Copy link
Contributor

Choose a reason for hiding this comment

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

please use the term "source map" instead of "sourcemap" when discussing the topics

@zdne
Copy link
Contributor

zdne commented Oct 5, 2014

In a nutshell:

  1. Use latest MSON syntax
  2. Use Source Map instead of Sourcemap where applicable
  3. Do not duplicate descriptions, instead refer the AST objects

@zdne
Copy link
Contributor

zdne commented Oct 5, 2014

Also where is the explanation of payload source maps with the respect of references / symbol names?

@zdne
Copy link
Contributor

zdne commented Oct 5, 2014

@pksunkara

@zdne @fosrias Please review this.

No need to bump this. Also I do not think that this is for @fosrias to review (albeit he is of course welcome to do so if he wants).

@@ -93,6 +96,7 @@ An [API Blueprint payload](https://github.com/apiaryio/api-blueprint/blob/master
+ **request** payload: name of the request, if any
+ **response** payload: HTTP status code

+ `reference` ([Reference](#reference-object)) - Present if and only if the payload references a [Resource Model](https://github.com/apiaryio/api-blueprint/blob/master/API%20Blueprint%20Specification.md#ResourceModelSection)
Copy link
Contributor

Choose a reason for hiding this comment

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

This is good but I would still add some extra clarification here so that everybody understands that when a reference is present the payload object was take by resolving a reference of a resource model. Same applies to payload source map

@zdne
Copy link
Contributor

zdne commented Oct 6, 2014

Note since we are changing the AST here you need to bump the version of AST serializations formats (do not forget to update parse results format as well).

zdne added a commit that referenced this pull request Oct 6, 2014
Sourcemap description and serialization
@zdne zdne merged commit e75d4bf into master Oct 6, 2014
@zdne zdne deleted the pksunkara/sourcemap branch October 6, 2014 14:52
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.

2 participants