Page MenuHomePhabricator
Create Task
Maniphest T91711

Allow pre-filling api request parameters from a link
Closed, DeclinedPublic
Actions

Description

For tutorials and in-depth documentation it would be great to be able to pass in example requests to the API docs / sandbox using a link. There doesn't seem to be obvious support for this in https://github.com/swagger-api/swagger-ui, so this might be something we'd have to add.

Related Objects

Event Timeline

• GWicke created this task.Mar 5 2015, 11:33 PM
• GWicke raised the priority of this task from to Medium.
• GWicke updated the task description. (Show Details)
• GWicke added a project: RESTBase.
• GWicke added subscribers: • GWicke, • Spage.
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptMar 5 2015, 11:33 PM
• GWicke added a project: Documentation.Mar 5 2015, 11:36 PM
• GWicke set Security to None.
• GWicke updated the task description. (Show Details)
• Spage added a comment.Mar 5 2015, 11:44 PM

As a comparison, you can put the query string from an api.php request into the hashtag for Special:ApISandbox and it will prefill the latter's form, i.e. take

and make the URL

allowing T89680: Template:ApiEx on mw.org should have a link to "[view in ApiSandbox]".. I think we could build a similar Template:RestApiEx for RESTBase example requests on mw.org.

• GWicke added a project: Services.Oct 12 2016, 11:19 PM
• Pchelolo moved this task from Backlog to blocked on the Services board.Oct 12 2016, 11:44 PM
• Pchelolo edited projects, added Services (blocked); removed Services.
• srodlund moved this task from Backlog to API Documentation Request on the Documentation board.Aug 15 2018, 12:35 AM
• mobrovac added a project: Platform Team Workboards (Blocked Externally).Dec 20 2018, 12:46 PM
• mobrovac closed this task as Declined.Mar 14 2019, 12:42 AM
• mobrovac subscribed.

This is unlikely to happen at this point, so declining.

CCicalese_WMF moved this task from Blocked Externally to Done with CPT on the Platform Team Workboards board.Mar 14 2019, 3:02 PM
CCicalese_WMF edited projects, added Platform Team Workboards (Done with CPT); removed Platform Team Workboards (Blocked Externally).
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits