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

MSON Parameters and Headers #3

Closed
wants to merge 7 commits into from
Closed

MSON Parameters and Headers #3

wants to merge 7 commits into from

Conversation

zdne
Copy link
Contributor

@zdne zdne commented Sep 24, 2015

This PR proposes and discusses using MSON syntax for description of URI parameters and HTTP Headers

This PR replaces following GitHub issues:

  1. Usage of data structures in Parameters
  2. Global query URI parameter
  3. Description of enumeration elements
  4. Array in parameters
  5. Minimum/Maximum values for URI Parameters
  6. Parametric Headers Description
  7. Referenced HTTP headers
  8. Support for multiline syntax header
  9. Reuse headers and attributes

Please see the RFC for details and rationale.

Z added 2 commits September 23, 2015 18:03
Additional research on “JSON Forms” included in proposed
www-url-encoded serialization of complex structures
[parameter section][] is – similarly to attributes section – an
[MSON type declaration][].

The type being declared should inherits from Refract
Copy link
Member

Choose a reason for hiding this comment

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

inherits from -> inherit from the?

@kylef kylef added the draft label Sep 24, 2015
Would result into:

```
/resource?p%5Bmember1%5D=one&p%5Bmember2%5D=two
Copy link
Member

Choose a reason for hiding this comment

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

I think p should be q in here.

@zdne zdne changed the title MSON Parameters MSON Parameters and Headers Sep 28, 2015
otherwise. If another base type is specified it must inherit from the
*Parameters base type*.

The *Parameter base type* may the [API Description Namespace][]
Copy link
Contributor

Choose a reason for hiding this comment

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

may the?

@pksunkara
Copy link
Contributor

My review is done.

@pksunkara
Copy link
Contributor

@ashleydw We would love contributions. We are currently working on fixing a lot of MSON bugs.

@tony0918
Copy link

tony0918 commented Feb 3, 2017

I am so sorry to ask a question here as I can't find the right place to ask the question.
Is this fixing the thing like filter[published]=1&filter[uid]=2 in query string?
Thanks.

@piotrkochan
Copy link

Topic's dead?

@FranklinYu
Copy link

Is it desired if I continue the work and open a new pull request? @zdne doesn't seem interested in this any longer.

@konalegi
Copy link

Any changes on array parameters for get requests?

@pvolyntsev
Copy link

So what about the description of enumeration elements?

@fgblomqvist
Copy link

Has this proposal been thrown out? I'm curious about the support for array query params since that seems like a rather common use case.

@kylef
Copy link
Member

kylef commented Mar 30, 2018

@fgblomqvist It certainly hasn't, although it hasn't really been moving. We've been postponing some of the new feature development while we clear up some architecture problems in the API Blueprint parser. I hope we can unblock this and many other features soon!

@kylef
Copy link
Member

kylef commented Mar 30, 2018

@fgblomqvist Depending on what you are trying to do, some forms of array query parameters are actually supported. Since API Blueprint uses URI Template, the URI Template dictates how arrays should be expanded. For example:

{?list}            ?list=red,green,blue
{?list*}           ?list=red&list=green&list=blue

@fgblomqvist
Copy link

@kylef I tried the * approach (the comma one works, but is not what I want) and got an error saying that it wasn't able to find "list" in the query parameters. I believe there is a bug report about that on here that got closed due to this PR, or something.

@lorenzosfarra
Copy link

Any updates about it? I am doing a lot of copy/paste stuff for headers in a new project...Hopefully I will not have to change them :) I am following this feature request with great interest, but its flow seems somehow blocked?

Thanks.

@davidcorbin-atmosera
Copy link

So 5 years later and STILL no way to have "Dependent" parameters???? [please, please tell me I am missing something]

@pksunkara
Copy link
Contributor

This project and API Blueprint are no longer in development AFAIK

@davidcorbin-atmosera
Copy link

This project and API Blueprint are no longer in development AFAIK

And yet nobody from the product team could be bothered to update this with that information. This problem is not unique to GitHub, but the costs to the industry are staggering.

@zdne
Copy link
Contributor Author

zdne commented Oct 6, 2021

Hi @dcorbin-wintellect , as the original author of this (who left the project and company over a four years ago) I just wanted to let you know I feel bad hearing that you are let down but the lack of development. Surely not the way I wanted this to end.

To this date, I know there still is the amazing community using API Blueprint and MSON and if there would be the interest the option to fork the MIT projects and develop them as completely OSS is still on the table and I would be very happy to support it!

Bests,

– Z.

@davidcorbin-atmosera
Copy link

Z. - I wish you well in your endeavors, and it is not that development stopped, or anything along those lines - life changes.

Let me turn this around... About 6 years ago, I completely stopped blogging, writing (online) articles, hosting public projects - all for the simple reason that I felt responsible for the content that I had produced. So I spent time tracking each one, seeing if technology or other influences had moved on. Sometimes updating, other time simply noting that the material was no longer up to date and was not going to be maintained.

Eventually things accelerated to the point where I could no longer even deprecate material that I had published, and I was leaving "hanging fruit" that people would pick without the critical information that was was written no longer applied or at least was not a recommended practice or....

And so I stopped.

@zdne
Copy link
Contributor Author

zdne commented Oct 8, 2021

@dcorbin-wintellect thanks for sharing your thoughts! Part of me wants to agree, the other one screams "if you censor thyself like this, we all loose something". Your thoughts, writings, projects even outdated can sparkle new ideas, new things. This is what I choose to believe in! 🤨

Ge11ert pushed a commit to funbox/api-blueprint that referenced this pull request Jan 26, 2022
These are not supported in any parser, Refract nor the API Blueprint AST
and therefore should be removed from the specification.

This will be later supported once RFC3 has been implemented
(apiaryio/api-blueprint-rfcs#3)
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.