Badge

Create Badge Endorsement

Changed on

Add a new string to the badge's endorsement. The input data could be anything typed by the user.

post/v1/badge/{badge_id}/endorsements

Request

  • Base URL
    https://api.navigatr.app (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Password
    Token URL/v1/token

Path parameters

badge_idinteger required

Headers

X-Access-Tokenstring nullable

Request body

external_idstring nullable
namestring required
descriptionstring required
urlstring nullable
image_urlstring nullable
image_url_2xstring nullable
image_url_originalstring nullable

Example request

{
  "external_id": "zyxw-vut-srq-ponmlkjih",
  "url": "https://Endorsement/Example.org",
  "image_url": "https://media.navigatr.app/endorsement.webp",
  "image_url_2x": "https://media.navigatr.app/endorsement_2x.webp",
  "image_url_original": "https://media.navigatr.app/endorsement_original.webp"
}

Response

Successful Response

external_idstring nullable
namestring nullable
descriptionstring nullable
urlstring nullable
image_urlstring nullable
image_url_2xstring nullable
image_url_originalstring nullable
idinteger nullable
badge_idinteger nullable

Example response

{
  "external_id": "zyxw-vut-srq-ponmlkjih",
  "name": "Endorsement Example",
  "description": "This is an example of a badge endorsement",
  "url": "https://Endorsement/Example.org",
  "image_url": "https://media.navigatr.app/endorsement.webp",
  "image_url_2x": "https://media.navigatr.app/endorsement_2x.webp",
  "image_url_original": "https://media.navigatr.app/endorsement_original.webp"
}

Changes

    • info

      api operation id create_badge_endorsement_v1_badge__badge_id__endorsements_post removed and replaced with badge_create_badge_endorsement

    • info

      added the new optional header request parameter X-Access-Token

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      the response's property default value changed from Unauthorized access to Insufficient permissions for the status

    • breaking

      response property badge_id list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property description list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property external_id list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property id list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property image_url list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property image_url_2x list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property image_url_original list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property name list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property url list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      the response property's maxLength was unset from 65536 for the response status

    • breaking

      the response property's maxLength was unset from 65536 for the response status

    • breaking

      the response property's maxLength was unset from 65536 for the response status

    • breaking

      the response property's maxLength was unset from 65536 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      the request property's minLength was decreased from 1 to 0

    • info

      the request property's minLength was decreased from 1 to 0

    • info

      the request property's minLength was decreased from 1 to 0

    • info

      the request property's minLength was decreased from 1 to 0