Zum Inhalt springen
DoliNews
Menü
Der Strom Veröffentlichen Die Prüfung Zusagen Regeln API Feed einbinden
Anmeldung Registrieren

API-Dokumentation

Version 1.0.0 - OpenAPI-Spezifikation

Basis der Aufrufe: https://dolinews.com/api/v1

The service tells what was announced, and when. It never states the current state of a module.

Reading and the generic feeds are free and need no account. Writing needs a contributor account and a personal token. A token grants the right to SUBMIT, never the right to publish: every submission enters the same human review circuit as the web surface, and is published only once the review has accepted it.

Submitting is a declaration that the author holds the rights on the content, places it under CC BY-SA 4.0, and breaks neither the law nor a third-party right, trademarks included. The usage rules are identical through a token and through the web.

The version prefix is frozen: nothing breaks under /api/v1 without a /api/v2 published alongside it.

Einen Artikel einreichen, von Anfang bis Ende

Vier Schritte. Ein Token gibt das Recht einzureichen: die Veröffentlichung kommt aus der Prüfung, nie aus dem Aufruf.

  1. Eröffnen Sie ein Beitragendenkonto und erstellen Sie ein Token auf der Token-Seite Ihres Kontos. Das Geheimnis erscheint nur einmal. Der vollständige Weg, Schritt für Schritt
  2. Laden Sie Ihre Bildschirmfotos mit POST /media hoch und notieren Sie die zurückgegebenen Kennungen.
  3. Erstellen Sie den Artikel mit POST /articles und nennen Sie die Bild-URLs im Text sowie ihre Kennungen in media_ids.
  4. Reichen Sie ihn zur Prüfung ein mit POST /articles/{id}/submit, oder direkt, indem submit im vorigen Schritt auf true gesetzt wird. 
TOKEN="1|abc..."

# 1. Déposer une capture
curl -H "Authorization: Bearer $TOKEN" \
     -F file=@capture.png -F editor_id=3 -F alt="Écran de configuration" \
     https://dolinews.com/api/v1/media

# 2. Créer l'article et le soumettre dans le même appel
curl -H "Authorization: Bearer $TOKEN" \
     -H "Content-Type: application/json" \
     -d '{"editor_id":3,"type":"release","title":"Module XY 2.1",
          "version":"2.1.0","locale":"fr_FR","maturity":"stable",
          "summary":"Correction de la génération des relances.",
          "body":"## Corrections\n\n- relances","media_ids":[42],
          "submit":true}' \
     https://dolinews.com/api/v1/articles

Es wird keine Prüfdauer zugesagt: der Artikel erscheint, sobald die Prüfung ihn angenommen hat. Angezeigt wird die beobachtete Dauer, der Median der letzten Entscheidungen.

Authentifizierung

Personal token of a contributor account, minted from the account page or from POST /tokens. Sent as Authorization: Bearer <token>. It grants the right to submit, never the right to publish.

Authorization: Bearer <Ihr Token>

Ratenbegrenzung

Aufrufe Ohne Konto Mit einem Token
Lesen 60 requests per minute and per IP address 120 requests per minute and per account
Schreiben 5 requests per minute and per IP address 10 requests per minute and per account

Articles

The feed: reading published articles, submitting new ones, translating and correcting them.

GET /articles

ohne Konto

List published articles

The published feed, filterable exactly like the web surface. Non-stable maturities are excluded unless named: the default is stable alone.

Abfrageparameter

Feld Typ Pflicht Beschreibung
editor string nein Editor slug.
project string nein Project slug.
dolibarr integer nein Dolibarr major version the announcement concerns. Reads as "announcements concerning this version", never as "modules compatible with it".
focus string nein Nature of a release publication. Werte: doc, cleanup, feature_minor, feature_major, bugfix_minor, bugfix_major, security, compat, eol
locale string nein Content locale of the article, such as fr_FR. Werte: fr_FR, en_US, es_ES, de_DE, it_IT, nl_NL, pt_PT
maturity array of string nein Maturities to include, repeatable. Omitted, only stable articles come back. An unknown value is ignored rather than emptying the list. Werte: alpha, beta, rc, stable, deprecated
q string nein Free-text search over the title, the summary and the body. Words are ANDed, five of them at most are honoured.
per_page integer nein Articles per page. Clamped to the 1-100 range. Standard: 25

Antworten

200 One page of published articles.
429 RATE_LIMITED: too many requests.

POST /articles

Token erforderlich Beitragendenkonto Schreibgrenze

Create a draft article

Creates a draft for an editor the account is a member of. With submit set to true, the draft enters the review queue in the same call and a publication token is consumed.

Illustrations are ids returned by POST /media beforehand: the body references their URLs, media_ids ties them to the article. Unbound media are purged as orphans after the grace period.

A version is proposed once: an announcement is identified by its project, version number and locale within the editor. Sending one that is still a draft, under review or rejected updates that article (200, meta.existing_article) instead of creating a second one; an identical text changes nothing and keeps the accords. Sending one already published answers ALREADY_PUBLISHED with detail.article_id: propose a revision of that article instead. Without a project or a version number, nothing is matched.

Rumpf der Anfrage application/json

Feld Typ Pflicht Beschreibung
editor_id integer ja Editor the article is published for. The account must be a member. Required on creation, ignored on edit.
type string ja A release publishes a version, an announcement does not. Werte: release, announcement
project_id integer nein Sheet the article belongs to.
focus string nein Nature of a release publication. Werte: doc, cleanup, feature_minor, feature_major, bugfix_minor, bugfix_major, security, compat, eol
title string ja
version string nein
summary string ja
body string ja Markdown. Free HTML is refused.
locale string ja Content locale, five characters. Werte: fr_FR, en_US, es_ES, de_DE, it_IT, nl_NL, pt_PT
dolibarr_min integer nein Lowest Dolibarr major version announced. Compatibility lives on the article, with its date, never on the sheet.
dolibarr_max integer nein Highest Dolibarr major version announced.
maturity string nein Werte: alpha, beta, rc, stable, deprecated
compat_status string nein How the announced compatibility was established. Werte: declared, tested, experimental
media_ids array of integer nein Identifiers returned by POST /media. Binds the images to this article and saves them from the orphan purge.
featured_media_id integer | null nein The image put forward on the feed card, the sharing card and the feeds: a media deposited for the article's editor. Reviewed with the article. Without it, the first image of the body is used. Refused on a translation, which shows the image of its source.
submit boolean nein Submit to the review right away, consuming a publication token.

Antworten

200 The version was already proposed and not yet published: that article was updated, and submitted when submit was true. meta.existing_article is true.
201 Draft created, submitted too when submit was true.
401 INVALID_TOKEN: missing, revoked or expired token.
403 CONTRIBUTOR_REQUIRED: a verified contributor account is needed. A reader account can read and subscribe, never write.
409 ALREADY_PUBLISHED: this version of the project is already published in this locale, detail.article_id names it; a published article changes only through a revision. CONFLICT: the version is under review by another member of the editor (detail.article_id), or the state of the article forbids the update.
422 VALIDATION_FAILED: invalid payload. detail names the offending fields.
429 QUOTA_BUCKET_EMPTY or QUEUE_CEILING_REACHED: the publication credit of the project is spent, or too many announcements of this editor are already under review. Neither is a rate limit: retrying later is the only remedy.

GET /articles/{id}

ohne Konto

Read one published article

Adds the rendered body and the language versions of the group. A version flagged stale was translated from an earlier revision of its source.

Pfadparameter

Feld Typ Pflicht Beschreibung
id integer ja Article identifier.

Antworten

200 The article, its rendered body and its language versions.
404 NOT_FOUND: unknown resource, or one the account may not see.
429 RATE_LIMITED: too many requests.

PATCH /articles/{id}

Token erforderlich Schreibgrenze

Edit an unpublished article

Edits a draft or a rejected article of the calling account. Editing an article under review counts as a resubmission and resets the acceptances already given.

A published article is never edited in place: use the revisions endpoint.

Pfadparameter

Feld Typ Pflicht Beschreibung
id integer ja Article identifier.

Rumpf der Anfrage application/json

Feld Typ Pflicht Beschreibung
editor_id integer ja Editor the article is published for. The account must be a member. Required on creation, ignored on edit.
type string ja A release publishes a version, an announcement does not. Werte: release, announcement
project_id integer nein Sheet the article belongs to.
focus string nein Nature of a release publication. Werte: doc, cleanup, feature_minor, feature_major, bugfix_minor, bugfix_major, security, compat, eol
title string ja
version string nein
summary string ja
body string ja Markdown. Free HTML is refused.
locale string ja Content locale, five characters. Werte: fr_FR, en_US, es_ES, de_DE, it_IT, nl_NL, pt_PT
dolibarr_min integer nein Lowest Dolibarr major version announced. Compatibility lives on the article, with its date, never on the sheet.
dolibarr_max integer nein Highest Dolibarr major version announced.
maturity string nein Werte: alpha, beta, rc, stable, deprecated
compat_status string nein How the announced compatibility was established. Werte: declared, tested, experimental
media_ids array of integer nein Identifiers returned by POST /media. Binds the images to this article and saves them from the orphan purge.
featured_media_id integer | null nein The image put forward on the feed card, the sharing card and the feeds: a media deposited for the article's editor. Reviewed with the article. Without it, the first image of the body is used. Refused on a translation, which shows the image of its source.
submit boolean nein Submit to the review right away, consuming a publication token.

Antworten

200 The updated article.
401 INVALID_TOKEN: missing, revoked or expired token.
404 NOT_FOUND: unknown resource, or one the account may not see.
409 CONFLICT: the state of the resource forbids the action.
422 VALIDATION_FAILED: invalid payload. detail names the offending fields.
429 RATE_LIMITED: too many requests.

POST /articles/{id}/submit

Token erforderlich Schreibgrenze

Submit an article to the review

Sends a draft of the calling account into the review queue and consumes a publication token. No review delay is announced: an article is published when the review has accepted it. What the service displays is the observed delay, the median of the recent decisions.

Pfadparameter

Feld Typ Pflicht Beschreibung
id integer ja Article identifier.

Antworten

200 The article, now pending review.
401 INVALID_TOKEN: missing, revoked or expired token.
404 NOT_FOUND: unknown resource, or one the account may not see.
409 CONFLICT: the state of the resource forbids the action.
429 QUOTA_BUCKET_EMPTY or QUEUE_CEILING_REACHED: the publication credit of the project is spent, or too many announcements of this editor are already under review. Neither is a rate limit: retrying later is the only remedy.

POST /articles/{id}/translations

Token erforderlich Beitragendenkonto Schreibgrenze

Translate an article

Adds a language version to the group of the source article. One locale per group at most. Open to the author of the announcement, to the members of its editor, and to accounts the editor mandated for that locale. A translation consumes no publication token and carries no quorum: submitted by its own editor it is published straight away, submitted by a mandated translator it goes through one reviewer. It never publishes before its source, and takes the source's publication date.

Pfadparameter

Feld Typ Pflicht Beschreibung
id integer ja Article identifier.

Rumpf der Anfrage application/json

Feld Typ Pflicht Beschreibung
locale string ja Content locale, five characters. Werte: fr_FR, en_US, es_ES, de_DE, it_IT, nl_NL, pt_PT
title string ja
summary string ja
body string ja Markdown. Free HTML is refused.
submit boolean nein Submit to the review right away.

Antworten

201 The translated article.
401 INVALID_TOKEN: missing, revoked or expired token.
403 CONTRIBUTOR_REQUIRED: a verified contributor account is needed. A reader account can read and subscribe, never write.
404 NOT_FOUND: unknown resource, or one the account may not see.
409 That locale already exists in the group.
422 VALIDATION_FAILED: invalid payload. detail names the offending fields.
429 QUEUE_CEILING_REACHED: too many announcements of this editor are already under review, every project combined. The unit is the announcement, not the article: the language versions of one announcement hold a single slot.

POST /articles/{id}/revisions

Token erforderlich Schreibgrenze

Propose a revision of a published article

A published article is never modified in place. A revision re-enters the review; once accepted, the article carries the mention of its correction and the original version stays readable.

Send only the fields that change. The motive is mandatory and is shown to the review team.

Pfadparameter

Feld Typ Pflicht Beschreibung
id integer ja Article identifier.

Rumpf der Anfrage application/json

Feld Typ Pflicht Beschreibung
title string nein
summary string nein
body string nein
featured_media_id integer | null nein New featured image, a media of the article's editor. Null takes the designation away. Applied with the revision, never before.
media_ids array of integer nein Images the corrected body or the new featured image brings, deposited through POST /media. Binding them shows nothing before the revision is applied.
motive string ja Why the correction is needed.

Antworten

201 The revision, pending review.
401 INVALID_TOKEN: missing, revoked or expired token.
404 NOT_FOUND: unknown resource, or one the account may not see.
409 CONFLICT: the state of the resource forbids the action.
422 VALIDATION_FAILED: invalid payload. detail names the offending fields.
429 RATE_LIMITED: too many requests.

Projects

Project sheets. A sheet is persistent and carries NO Dolibarr compatibility: anything dated lives on the article, with its date.

GET /projects

ohne Konto

List project sheets

Abfrageparameter

Feld Typ Pflicht Beschreibung
per_page integer nein Items per page. Clamped to the 1-100 range. Standard: 25

Antworten

200 One page of sheets.
429 RATE_LIMITED: too many requests.

POST /projects

Token erforderlich Beitragendenkonto Schreibgrenze

Create a project sheet

The sheet is persistent and carries no dated information: no Dolibarr compatibility, no version. Those live on the articles, each with its date.

Rumpf der Anfrage application/json

Feld Typ Pflicht Beschreibung
editor_id integer ja Editor the sheet belongs to. The account must be a member.
name string ja
summary string ja
description string nein
license string nein

Antworten

201 The created sheet.
401 INVALID_TOKEN: missing, revoked or expired token.
403 CONTRIBUTOR_REQUIRED: a verified contributor account is needed. A reader account can read and subscribe, never write.
422 VALIDATION_FAILED: invalid payload. detail names the offending fields.
429 RATE_LIMITED: too many requests.

GET /projects/{slug}

ohne Konto

Read one project sheet

Adds the typed links, the translations, the logo and the gallery of the sheet.

A sheet masked by the moderation team answers 404, except to a token of its own editor, which keeps reading it to correct it: `hidden` is then true. The announcements filed under it stay published and carry no project.

Pfadparameter

Feld Typ Pflicht Beschreibung
slug string ja Project slug.

Antworten

200 The sheet, its links, its translations, its logo and its gallery.
404 NOT_FOUND: unknown resource, or one the account may not see.
429 RATE_LIMITED: too many requests.

PATCH /projects/{slug}

Token erforderlich Schreibgrenze

Edit the reference fields of a sheet

Rewrites the text of a sheet the calling account publishes for: name, language, summary, description and licence. Only the fields present in the call are touched, so a tool fixing the description alone cannot blank the licence it did not send.

The description is Markdown, rendered through the same whitelist as an article body, and bounded by the instance. A sheet presents a project and never states its current Dolibarr compatibility: what is dated lives in the announcements.

Links, translations and status have their own endpoints.

Pfadparameter

Feld Typ Pflicht Beschreibung
slug string ja Project slug.

Rumpf der Anfrage application/json

Feld Typ Pflicht Beschreibung
name string nein
locale string nein Content locale the sheet is written in (fr_FR, es_ES...).
summary string nein
description string | null nein Markdown, bounded by the instance (8000 characters by default).
license string | null nein

Antworten

200 The sheet as it now reads.
401 INVALID_TOKEN: missing, revoked or expired token.
403 FORBIDDEN: the account is not a member of the editor that owns the resource.
404 NOT_FOUND: unknown resource, or one the account may not see.
422 VALIDATION_FAILED: invalid payload. detail names the offending fields.
429 RATE_LIMITED: too many requests.

POST /projects/{slug}/gallery

Token erforderlich Schreibgrenze

Add an image to the gallery of a sheet

Deposit the image with POST /media first, then name its id here. The media must belong to the editor of the sheet. Naming an image already in the gallery rewrites its caption and, when given, its position: a tool can run again without piling up duplicates.

The gallery is bounded by the instance; the refusal names the maximum. A Dolibarr screenshot routinely holds real personal data: publish screenshots taken on demonstration data only.

Pfadparameter

Feld Typ Pflicht Beschreibung
slug string ja Project slug.

Rumpf der Anfrage application/json

Feld Typ Pflicht Beschreibung
media_id integer ja
caption string | null nein
position integer | null nein Display order. Defaults to after the last image.

Antworten

200 The image was already in the gallery; its caption and position were rewritten.
201 The image added to the gallery.
401 INVALID_TOKEN: missing, revoked or expired token.
403 Not a member of the sheet's editor, or media of another editor.
404 NOT_FOUND: unknown resource, or one the account may not see.
422 Invalid input, or gallery full: detail.gallery_max carries the maximum.
429 RATE_LIMITED: too many requests.

DELETE /projects/{slug}/gallery/{mediaId}

Token erforderlich Schreibgrenze

Take an image out of the gallery of a sheet

The file itself stays deposited; it is purged later if nothing else holds it.

Pfadparameter

Feld Typ Pflicht Beschreibung
slug string ja Project slug.
mediaId integer ja Media identifier of the gallery image.

Antworten

200 The image left the gallery.
401 INVALID_TOKEN: missing, revoked or expired token.
403 FORBIDDEN: the account is not a member of the editor that owns the resource.
404 Unknown sheet, or image not in its gallery.
429 RATE_LIMITED: too many requests.

POST /projects/{slug}/translations

Token erforderlich Beitragendenkonto Schreibgrenze

Translate a project sheet

Sheet translations live on their own, one row per locale. Unlike an article translation, this one does not go through the review.

Pfadparameter

Feld Typ Pflicht Beschreibung
slug string ja Project slug.

Rumpf der Anfrage application/json

Feld Typ Pflicht Beschreibung
locale string ja Content locale, five characters. Werte: fr_FR, en_US, es_ES, de_DE, it_IT, nl_NL, pt_PT
name string ja
summary string ja
description string nein

Antworten

201 The translated sheet.
401 INVALID_TOKEN: missing, revoked or expired token.
403 CONTRIBUTOR_REQUIRED: a verified contributor account is needed. A reader account can read and subscribe, never write.
404 NOT_FOUND: unknown resource, or one the account may not see.
422 VALIDATION_FAILED: invalid payload. detail names the offending fields.
429 RATE_LIMITED: too many requests.

Editors

Directory of the organisations and people who publish.

GET /editors

ohne Konto

List editors

Abfrageparameter

Feld Typ Pflicht Beschreibung
per_page integer nein Items per page. Clamped to the 1-100 range. Standard: 25

Antworten

200 One page of editors.
429 RATE_LIMITED: too many requests.

POST /editors

Token erforderlich Beitragendenkonto Schreibgrenze

Create the editor you publish for

Creates the editor the calling account owns and becomes a member of. This is the first call of a new integration: the identifier it returns is the editor_id every write endpoint asks for.

Creating is not being verified. The editor comes back with verified false and stays that way until the moderation team acts on it; nothing in the API grants that state.

Rumpf der Anfrage application/json

Feld Typ Pflicht Beschreibung
name string ja
contact_email string ja Address the review team writes to. Never published.
website string nein
description string nein

Antworten

201 The created editor, unverified.
401 INVALID_TOKEN: missing, revoked or expired token.
403 CONTRIBUTOR_REQUIRED: a verified contributor account is needed. A reader account can read and subscribe, never write.
409 The account already owns an editor. The publication credit and the queue ceiling are counted per editor, so an account mints one and joins the others on invitation.
422 VALIDATION_FAILED: invalid payload. detail names the offending fields.
429 RATE_LIMITED: too many requests.

GET /editors/{slug}

ohne Konto

Read one editor

Adds the description, the website and the project sheets of the editor.

Pfadparameter

Feld Typ Pflicht Beschreibung
slug string ja Editor slug.

Antworten

200 The editor and its sheets.
404 NOT_FOUND: unknown resource, or one the account may not see.
429 RATE_LIMITED: too many requests.

Media

Image deposit. Step one of the two-step illustrated publication.

POST /media

Token erforderlich Beitragendenkonto Schreibgrenze

Deposit an image

Step one of an illustrated publication: deposit the image, get its id and URL, reference the URL in the article body, then list the id in media_ids.

The file is re-encoded whatever it claims to be; the declared MIME type and the extension are never taken as proof. EXIF data does not survive the rewrite. SVG is refused.

The response carries a warning worth relaying to your users: a Dolibarr screenshot routinely holds real personal data.

A media held by nothing - no article, no sheet logo or gallery, no editor logo - is purged after the grace period.

source_hash is the sha256 of the file as sent, before re-encoding: a client compares it with the hash of its own file to know whether an image is already deposited.

Rumpf der Anfrage multipart/form-data

Feld Typ Pflicht Beschreibung
file string ja Bitmap image. SVG refused.
editor_id integer ja Editor the media belongs to. The account must be a member.
alt string nein Alternative text.

Antworten

201 The stored media, after re-encoding.
401 INVALID_TOKEN: missing, revoked or expired token.
403 CONTRIBUTOR_REQUIRED: a verified contributor account is needed. A reader account can read and subscribe, never write.
413 PAYLOAD_TOO_LARGE: file above the ceiling.
415 UNSUPPORTED_MEDIA: bitmap images only, never SVG.
422 VALIDATION_FAILED: invalid payload. detail names the offending fields.
429 RATE_LIMITED: too many requests.

Attestations

Test indicators attached to a sheet. Declarative, never a certification.

POST /attestations

Token erforderlich Beitragendenkonto Schreibgrenze

Publish a test indicator for one of your sheets

The indicator is declarative as long as the test instances are hosted by the editors themselves. It is displayed as "tests published by the editor", never as "certified" nor as a quality label, and the wording is part of the contract.

Rumpf der Anfrage application/json

Feld Typ Pflicht Beschreibung
project string ja Slug of one of your sheets.
article_id integer nein Article the measurement relates to, when there is one.
source_type string ja Werte: captests, ci, other
source_url string ja
metric string ja
value string ja
unit string nein
measured_at string nein When the measurement was taken. Never in the future.
signature string nein

Antworten

201 The recorded indicator.
401 INVALID_TOKEN: missing, revoked or expired token.
403 CONTRIBUTOR_REQUIRED: a verified contributor account is needed. A reader account can read and subscribe, never write.
404 NOT_FOUND: unknown resource, or one the account may not see.
422 VALIDATION_FAILED: invalid payload. detail names the offending fields.
429 RATE_LIMITED: too many requests.

Account

Profile, personal tokens and subscriptions of the calling account.

GET /profile

Token erforderlich

Read the calling account

Includes the editors the account is a member of, with its role in each: those are the editor_id values the write endpoints accept.

Antworten

200 The account and its editor memberships.
401 INVALID_TOKEN: missing, revoked or expired token.
429 RATE_LIMITED: too many requests.

POST /logout

Token erforderlich

Revoke the calling token

Revokes the token that made the call, and only that one. The other tokens of the account stay valid.

Antworten

200 Token revoked.
401 INVALID_TOKEN: missing, revoked or expired token.

GET /tokens

Token erforderlich

List the tokens of the account

Names and metadata. A token secret is never returned twice.

Antworten

200 The tokens, most recent first.
401 INVALID_TOKEN: missing, revoked or expired token.

POST /tokens

Token erforderlich

Mint a token

Lets an integration chain rotate its own tokens. The first token is minted from the web account page: this endpoint needs a valid token already.

The secret appears exactly once, in this response.

Rumpf der Anfrage application/json

Feld Typ Pflicht Beschreibung
name string ja What this token is for. Shown on the account page.

Antworten

201 The minted token. Store the secret now.
401 INVALID_TOKEN: missing, revoked or expired token.
422 VALIDATION_FAILED: invalid payload. detail names the offending fields.

DELETE /tokens/{id}

Token erforderlich

Revoke a token

Pfadparameter

Feld Typ Pflicht Beschreibung
id integer ja Token identifier.

Antworten

200 Token revoked.
401 INVALID_TOKEN: missing, revoked or expired token.
404 NOT_FOUND: unknown resource, or one the account may not see.

GET /watches

Token erforderlich

List the subscriptions of the account

Watched projects and editors, with the personal feed URL when one has been issued.

Antworten

200 The subscriptions and the personal feed URL.
401 INVALID_TOKEN: missing, revoked or expired token.

POST /watches

Token erforderlich

Add or remove a subscription

Toggles the subscription: calling it again on the same target removes it. Exactly one of project_id and editor_id is expected.

Rumpf der Anfrage application/json

Feld Typ Pflicht Beschreibung
project_id integer nein
editor_id integer nein
focus array of string nein Restrict the subscription to these focuses. Werte: doc, cleanup, feature_minor, feature_major, bugfix_minor, bugfix_major, security, compat, eol
maturity array of string nein Restrict the subscription to these maturities. Werte: alpha, beta, rc, stable, deprecated

Antworten

200 State after the toggle.
401 INVALID_TOKEN: missing, revoked or expired token.
422 VALIDATION_FAILED: invalid payload. detail names the offending fields.

POST /watches/feed-token

Token erforderlich

Issue or regenerate the personal feed token

The personal feed is a tokenised URL: a feed reader cannot authenticate, so the URL carries the secret. Treat it as one. Regenerating revokes the previous URL immediately.

Rumpf der Anfrage application/json

Feld Typ Pflicht Beschreibung
regenerate boolean nein Revoke the current URL and issue a new one.

Antworten

200 The personal feed URL.
401 INVALID_TOKEN: missing, revoked or expired token.

Specification

This document, served by the instance itself.

GET /openapi.json

ohne Konto

This specification

The OpenAPI document of the instance, with its own base URL filled in. Served without an account so a client generator can fetch it.

Antworten

200 The OpenAPI 3.1 document.

Fehlercodes

Ein Fehler antwortet in dieser Form: {"error": "CODE", "message": "...", "detail": {...}}. Binden Sie Ihre Integration an den Code, nie an die Meldung.

Code HTTP-Status
INVALID_TOKEN 401
ACCOUNT_INACTIVE 403
CONTRIBUTOR_REQUIRED 403
FORBIDDEN 403
NOT_FOUND 404
CONFLICT 409
ALREADY_PUBLISHED 409
PAYLOAD_TOO_LARGE 413
UNSUPPORTED_MEDIA 415
VALIDATION_FAILED 422
RATE_LIMITED 429
QUOTA_BUCKET_EMPTY 429
QUEUE_CEILING_REACHED 429
INTERNAL 500