writeas / go-writeas Goto Github PK

Overview

Change CreatePost to take a collection alias and use the /collections/{ALIAS}/posts endpoint, instead of /posts.

Implementation

Documentation.

(not sure if this is the right place to post this, I've copied my post from https://discuss.write.as/t/markdown-alt-text-on-images-not-recognized-on-some-cases/2818)

I’ve noticed that on some of the images on my blog, the alt text (i.e. the part between ![ and ](https://my-image-url.png) is missing from the generated HTML code.

To be more precise, consider the following Markdown:
![Capture d'écran de Our House de GameGrumps (url)](https://système.pointecouteau.com/writeas/superliminal.png)

When I save my post with this code, it is correctly converted:
<img src="https://syst%C3%A8me.pointecouteau.com/writeas/superliminal.png" alt="Capture d'écran de Our House de GameGrumps (url)">

Howewer, for those two Markdown sentences, the generated HTML omits the “alt” tag entirely for some reason:

• ![Capture d'écran de "Our House" de GameGrumps](https://système.pointecouteau.com/writeas/superliminal.png)
• ![Capture d'écran de Our House de GameGrumps (https://www.youtube.com/watch?v=k55FYtqtXXU)](https://système.pointecouteau.com/writeas/superliminal.png)

Why is that? Do I need to insert some sort of escape character before quotation marks or slashes?

Overview

When creating a new page with the API, and then attempting to pin it, pinning fails because the new post isn't yet created. It sometimes takes a few seconds after the request to create the page has returned before the page actually exists.
It would be nice if the API either blocked and only returned the request when the post actually existed and could be manipulated, or if there was a mechanism to wait until a post existed (short of polling in a loop and hammering your servers until we get a page back).

I couldn't find any documentation that mentioned that page creation was eventually consistent, so if this is unintentional consider this a bug report instead of a feature request.

On this page, an old version (v1) of this library is listed: https://developers.write.as/docs/api/?go#libraries

The current version is v2. This led to me using an out of date version for a while when starting my project that uses write.as.

Similarly, the page lists a "go.code.as" import path, however, the examples and writeas-cli use an unversioned GitHub import. Having some consistency and guidance on what should be used in the documentation would be helpful.

Thanks!

Overview

The library has 3 hard-coded URLs for the API service. It should probably
support changing the URL for testing and to allow users to point the client to
their own instance of WriteFreely.

Implementation

Rather than add another parameter to the constructors (thus breaking the API),
I propose adding a NewClientWith(Config) *Client constructor where Config
is a struct with a bunch of optional fields. This will also allow adding other
new optional parameters for client configuration in the future without
breaking the API.

Overview

Add GetCollectionPosts function.

Implementation

Documentation.

It would be nice to be able to update a collection from the SDK, including the title and description but also other properties that we are not able to set when creating a post such as the domain, stylesheet, public/private status, etc.

This would allow write.as blogs to be managed entirely declarative using tools such as Terraform or custom tools designed to upload markdown files and create/delete blogs.

Overview

Add a DeleteCollection function.

Implementation

Documentation.

Overview

Add GetPosts() function to user.go that returns the authenticated user's posts.

Implementation

This method requires user authentication.

API documentation.

Overview

Add CollectPosts function to collections.go, enabling user to move one of their posts to a collection.

Implementation

Documentation.

Overview

Go client libraries typically accept a context.Context as the first
argument in all outgoing function calls. The context carries deadline and
other information across API boundaries. See also https://blog.golang.org/context.

Popular examples are,

• go-github
• Google Cloud
• AWS

Context also allows orchestrating cancelation, especially with concurrent
operations. Support for this is already built into http.Client.

Implementation

All methods that make an outgoing request would have to accept a
context.Context as their first argument and plumb it over to http.Client
with req.WithContext(ctx), likely in buildRequest or prepareRequest.

Because this will involve a breaking change to the API, it should probably be
bundled with any other breaking changes you have planned.