Document Ore deployment API #670

Katrix · 2018-03-06T09:48:18Z

Documents the Ore deployment API, including the two recent pull requests to add more options to it.

ST-DDT

Could you add an example curl request which specifies the above parameter so its easier to decipher what you actually have to send. Because some APIs wrap their (meta)data in json.

ST-DDT · 2018-03-06T11:17:03Z

source/ore/routes/deploy-version.rst

+        }],
+        "downloads": 26,
+        "author": "ewoutvs_"
+    }


Newline at EOF.

Inscrutable

Mostly makes sense. Table is big and ugly but not a critical issue.

Inscrutable · 2018-03-06T11:21:26Z

source/ore/routes/deploy-version.rst

+-------------+------------------------------+------------------------------------------------------------------------------------------------+
+| Name        | Data Type                    | Description                                                                                    |
+=============+==============================+================================================================================================+
+| apiKey      | String                       | An Ore deployment key gotten through the Ore settings.                                         |


Can we use "obtained" instead of "gotten"?

Inscrutable · 2018-03-06T11:28:00Z

source/ore/routes/deploy-version.rst

+-------------+------------------------------+------------------------------------------------------------------------------------------------+
+| recommended | Boolean                      | If this version should be set as the recommended version. Defaults to true.                    |
+-------------+------------------------------+------------------------------------------------------------------------------------------------+
+| forumPost   | Boolean                      | Overrides the project setting of if a forum post should be created for this version. Optional. |


Does this really mean "If True, create a forum post for this version. This overrides the project setting." ?

Maybe we could phrase it like this.
Whether a forum post should be created or not. If no value is specified, it will default to the project's setting.

Inscrutable · 2018-03-06T11:30:27Z

source/ore/routes/deploy-version.rst

+
+Deploys a new version for the specified project. The body should be sent as ``multipart/form-data`` with the fields shown below. Returns a JSON representation of the deployed version.
+
+-------------+------------------------------+------------------------------------------------------------------------------------------------+


Does the table really need to be this wide in raw format? Our preference is 120 character wide or lower. (Guideline 13 in https://docs.spongepowered.org/stable/en/contributing/spongedocs.html). It's easier to edit.

Katrix · 2018-03-17T23:29:29Z

Fixed problems and included suggestions. Not too familiar with Curl (generally just use Powershell) so it would be nice if someone else could fix that.

Inscrutable · 2018-03-18T00:50:10Z

If someone can provide a curl example it would be handy, but otherwise I'm happy to merge this. Pending the addition of a final newline, of course.

phit · 2018-03-18T02:09:15Z

this should work for a deployment, not tested

curl -F "apiKey=string" -F "apiKey=string" -F "channel=string" -F "recommended=boolean" \
-F "forumPost=boolean" -F "changelog=string" -F pluginFile=@localPluginFile \
-F pluginSig=@localpluginSig https://URL.org/api/v1/projects/:pluginId/versions/:version

Katrix · 2018-03-18T07:20:23Z

Ok, added the curl usage. The newline should already be there.

ST-DDT · 2018-03-18T08:22:21Z

source/ore/routes/deploy-version.rst

+
+    curl -F "apiKey=string" -F "apiKey=string" -F "channel=string" -F "recommended=boolean" \
+    -F "forumPost=boolean" -F "changelog=string" -F pluginFile=@localPluginFile \
+    -F pluginSig=@localpluginSig https://URL.org/api/v1/projects/:pluginId/versions/:version


Please replace URL.org with the real URL.

ST-DDT · 2018-03-18T08:27:05Z

I guess there a quite a few developers using Windows out there.

Maybe we should add an Powershell example as well? That way we could encourage new developers to try the API as well. What do you think?

phit · 2018-03-18T17:45:27Z

shouldnt really be needed, https://blogs.technet.microsoft.com/virtualization/2017/12/19/tar-and-curl-come-to-windows/

ST-DDT · 2018-04-10T17:39:34Z

@Katrix- AFAICT the url is the only remaining issue with this PR.
Could you please update it or is there anything else missing before merge?

Katrix · 2018-04-10T18:17:50Z

Sorry, kind of forgot about that one. Fixed

Inscrutable added the needs review The submission is ready and needs to be reviewed label Mar 6, 2018

ST-DDT requested changes Mar 6, 2018

View reviewed changes

source/ore/routes/deploy-version.rst

}],

"downloads": 26,

"author": "ewoutvs_"

}

Copy link

Member

ST-DDT Mar 6, 2018 •

edited

Choose a reason for hiding this comment

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

Newline at EOF.

Inscrutable reviewed Mar 6, 2018

View reviewed changes

Inscrutable added help wanted We would appreciate contributions and removed needs review The submission is ready and needs to be reviewed labels Mar 18, 2018

Document Ore deployment API

cee3b07

ST-DDT requested changes Mar 18, 2018

View reviewed changes

Inscrutable added needs review The submission is ready and needs to be reviewed and removed help wanted We would appreciate contributions labels Mar 31, 2018

Fix url

7a7b944

ST-DDT approved these changes Apr 10, 2018

View reviewed changes

Inscrutable removed the needs review The submission is ready and needs to be reviewed label Apr 11, 2018

Inscrutable merged commit 172598a into SpongePowered:stable Apr 11, 2018

Katrix deleted the featue/ore-deploy branch May 16, 2019 10:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document Ore deployment API #670

Document Ore deployment API #670

Katrix commented Mar 6, 2018

ST-DDT left a comment

ST-DDT Mar 6, 2018 •

edited

Inscrutable left a comment

Inscrutable Mar 6, 2018

Inscrutable Mar 6, 2018

ST-DDT Mar 6, 2018

Inscrutable Mar 6, 2018

Katrix commented Mar 17, 2018

Inscrutable commented Mar 18, 2018

phit commented Mar 18, 2018 •

edited

Katrix commented Mar 18, 2018

ST-DDT Mar 18, 2018

ST-DDT commented Mar 18, 2018

phit commented Mar 18, 2018

ST-DDT commented Apr 10, 2018

Katrix commented Apr 10, 2018


		Deploys a new version for the specified project. The body should be sent as ``multipart/form-data`` with the fields shown below. Returns a JSON representation of the deployed version.

		+-------------+------------------------------+------------------------------------------------------------------------------------------------+

Document Ore deployment API #670

Document Ore deployment API #670

Conversation

Katrix commented Mar 6, 2018

ST-DDT left a comment

Choose a reason for hiding this comment

ST-DDT Mar 6, 2018 • edited

Choose a reason for hiding this comment

Inscrutable left a comment

Choose a reason for hiding this comment

Inscrutable Mar 6, 2018

Choose a reason for hiding this comment

Inscrutable Mar 6, 2018

Choose a reason for hiding this comment

ST-DDT Mar 6, 2018

Choose a reason for hiding this comment

Inscrutable Mar 6, 2018

Choose a reason for hiding this comment

Katrix commented Mar 17, 2018

Inscrutable commented Mar 18, 2018

phit commented Mar 18, 2018 • edited

Katrix commented Mar 18, 2018

ST-DDT Mar 18, 2018

Choose a reason for hiding this comment

ST-DDT commented Mar 18, 2018

phit commented Mar 18, 2018

ST-DDT commented Apr 10, 2018

Katrix commented Apr 10, 2018

ST-DDT Mar 6, 2018 •

edited

phit commented Mar 18, 2018 •

edited