Feedback for “Public API”

[nmbgeek]

Can this be expanded? I am trying to use the API and not having luck getting a simple Facebook post to be added.
Response when I try: {"message":["shortLink should not be null or undefined","shortLink must be a boolean value","tags should not be null or undefined","tags must be an array"],"error":"Bad Request","statusCode":400}

I have tried adding tags and shortLink to the values in various different places being sent in the POST request without luck and there seems to be no other documentation than what is on this page.

[egelhaus]

Please open an Issue in our main Repository or in our Discord Server.

[egelhaus]

Never mind, this is a Documentation Issue, sorry about that.

[nmbgeek]

I do see that shortLink and tags go in the top level of the post request and placing them there does work. However they are not documented.

It looks like they should likely be made optional here: https://github.com/gitroomhq/postiz-app/blob/c8d93aed8874de9312a47fb3f32281318b61aa03/libraries/nestjs-libraries/src/dtos/posts/create.post.dto.ts#L104

Additionally, can I specify a link for a Facebook post? I've looked through the dto files used and don't see one. https://developers.facebook.com/docs/pages-api/posts#publish-posts

This is the sample from here: https://docs.postiz.com/public-api which doesn't reference shortLink or tags and no other documentation does either.

{
  "type": "draft|schedule|now",
  "date": "2024-12-14T08:18:54.274Z",
  "posts": [
    {
      "integration": {
        "id": "asdfsad23rwdfasfsddc"
      },
      "value": [
        {
          "content": "This is my cool post",
          "id": "Only if you want to edit an existing post",
          "image": [
            {
              "id": "string"
            }
          ]
        }
      ],
      "group": "uniqueId for all the posts in the same group",
      "settings": {
        "[key]": "check each integration DTOs in the files, or wait for the error on a new request"
      }
    }
  ]
}

working version:

{
  "type": "draft|schedule|now",
  "date": "2024-12-14T08:18:54.274Z",
  "shortLink": true|false // what does this do? What link is it shortening and how is it doing so?
  "tags": [], // and this - I do see there is a create.tag.dto
  "posts": [
    {
      "integration": {
        "id": "asdfsad23rwdfasfsddc"
      },
      "value": [
        {
          "content": "This is my cool post",
          "id": "Only if you want to edit an existing post",
          "image": [
            {
              "id": "string"
            }
          ]
        }
      ],
      "group": "uniqueId for all the posts in the same group",  // what does this do?
      "settings": {
        "[key]": "check each integration DTOs in the files, or wait for the error on a new request"
      }
    }
  ]
}