Stack Overflow
Stack Overflow

Questions tagged [mson]

Markdown Syntax for Object Notation (MSON)

MSON is a plain-text, human and machine readable, description format for describing data structures in common markup formats such as JSON, XML or YAML.

mson github project

34 questions
2
votes
2 answers

Nested array with object in MSON is empty in Apiary.io documentation

I would like to create a nested array with objects in MSON format to use with API Blueprint and Apiary. I code looks correct but when I render it in Apiary I don't get the expected JSON. Example I want to create: A navigation has multiple…
JeroenVdb
  • 798
  • 1
  • 12
  • 21
2
votes
1 answer

apiblueprint structures to achieve desired description

I currently have such an API blueprint, but i can not achieve proper rendering. FORMAT: 1A HOST: http://polls.apiblueprint.org/ # Samwise Web API This document describes Samwise system WebAPI. Developers should refer to [this…
onkami
  • 8,791
  • 17
  • 90
  • 176
1
vote
0 answers

MSON data structures from external file

I want to use the MSON data structure defined in an external file and refer to it in my API blueprint file. Is it possible? As of now I define both in the same file. FORMAT: 1A HOST: https://polls.apiblueprint.org/ # Suppliers CRUD API to…
anil
  • 154
  • 1
  • 8
1
vote
1 answer

MSON-React UI code generator support for other backends

Amazing work as gone into MSON and it's a great project, however, it appears the backend stores available right now are only firebase, local-storage and memory. It would be good to ask if someone has successfully used MSON with a GraphQL or a…
Realz
  • 81
  • 1
  • 1
  • 4
1
vote
0 answers

Parameterize a Data Structure in API-Blueprint

I vaguely have the following document: # Group Cats ## Get ALl The Cats [GET /api/v1/cats{?page%5bsize%5d,page%5bnumber%5d,sort,filter}] + Parameters + page%5bsize%5d: 10 (number, optional) - Maximum number of resources in a single paginated…
leifg
  • 8,668
  • 13
  • 53
  • 79
1
vote
0 answers

Repeating a MSON data structure with different values

I have many places in my API where I will need to describe a list of objects. Each object has the same keys / structure but different values. How can I tweak the values of each instance of some data structure while retaining all the original type,…
zelusp
  • 3,500
  • 3
  • 31
  • 65
1
vote
1 answer

How to specify a JSON object with string values in MSON / API Blueprint?

I have been looking through the examples a lot but I didn't find a way to specify a property whose value is a JSON object with strings as values. I have an object like this: { id: 123, title: "I am a title", dynamic_attributes: { "key1":…
user1915201
  • 103
  • 1
  • 9
1
vote
0 answers

Describing object's keys with MSON

I have API that looks like this. The products object contains Product IDs (keys) and their amount in basket (values). { "id": "0a4d44aa-2ace-11e7-93ae-92361f002671", "products": { 4 => 3, // product with ID 4 is 3x in basket …
Grez
  • 306
  • 3
  • 8
1
vote
2 answers

How to override MSON Sample values

If I define a resource type with sample values, how can I override them for specific examples? I tried this, but the rendered output ignores the Body and uses the global Sample instead. ### Read item [GET] + Response 200 + Attributes (A,…
OrangeDog
  • 36,653
  • 12
  • 122
  • 207
1
vote
0 answers

How to extend rather than replace parent Parameters?

I've got a resource with multiple parameters, and a single action with one extra. How can I write this with the minimal repeats? Something like this, but that actually works: ## Items [/item{?type}] + Parameters + type (enum[string], optional) …
OrangeDog
  • 36,653
  • 12
  • 122
  • 207
1
vote
1 answer

MSON to describe object attributes in blueprint

I have an issue similar to what is described here. I have a JSON that looks like this: { "photos": [ { "key": "y37dmj10jkwof/moOIUB8912JKVgh", "caption": "A world of gamers.", "tags": [ "game", "japan" …
Stefan
  • 1,214
  • 1
  • 9
  • 17
0
votes
1 answer

How to define ApiBlueprint array values example with MSON?

Can I use MSON to specify an example values instead of + Body? Is it possible to override predefined structure values? I've tried like this: + Request (application/json) + Headers Authorization: JWT + Attributes…
Dr.eel
  • 1,837
  • 3
  • 18
  • 28
0
votes
1 answer

MSON to JSON-Schema "One of" issue

I'm try to describe in ApiBlueprint MSON notation an object with variable part. Here the simple code in ApiBlueprint : FORMAT: 1A # Test API ## Services [/Service/{id}] ### GET Service info [GET] + Request (application/json) + Headers …
Dr.eel
  • 1,837
  • 3
  • 18
  • 28
0
votes
1 answer

Is there any json schema like a excel table in Api Blueprint MSON?

Is there any json schema like a excel table in Api Blueprint MSON ? I am designing some api between several clients. So I need api documentation tool that can present as easy readable format. I search these 3 solution. (Swagger, RAML, Api…
Hyundong Hwang
  • 711
  • 1
  • 8
  • 19
0
votes
1 answer

Wrapping Data Structure in a data key API Blueprint / Apiary

So let's say I have a 200 response which body should be: { "data": [ { "id": 1, "title": "Activity 1" }, { "id": 1, "title": "Activity 2" } ] } I have managed to get this behavior of the response body by…
Pistachio
  • 1,652
  • 1
  • 18
  • 38
1
2
3