Topics

This REST API is used to manage topics. You can add topics for required APIs and packages. You can also upvote, downvote, flag, or bookmark a topic.

List of resources

  • POST /apis/{id}/topics

    Creates a topic for the given API.

  • POST /packages/{id}/topics

    Creates a topic for the given package.

  • GET /topics/{id}

    Retrieves the details of the given topic.

  • PUT /topics/{id}

    Updates the specified topic with the given details.

  • DELETE /topics/{id}

    Deletes the specified topic.

  • PUT /topics/{id}/upvote

    Upvotes the specified topic.

  • PUT /topics/{id}/downvote

    Downvotes the specified topic.

  • PUT /topics/{id}/flag

    Adds or removes flag from the specified topic.

  • PUT /topics/{id}/pin

    Adds or removes pin from the specified topic.

  • PUT /topics/{id}/bookmarks

    Adds or removes bookmark from the specified topic.

  • GET /topics/{id}/upvote/_count

    Retrieves the number of upvotes for the specified topic.

  • GET /topics/{id}/downvote/_count

    Retrieves the number of downvotes for the specified topic.

  • GET /topics/{id}/flag/_count

    Retrieves the number of flags for the specified topic.

  • GET /topics/{id}/_count

    Retrieves the number of upvotes, downvotes, and flags for the specified topic.

  • GET /collaboration/flags

    Retrieves the number of topics and comments that are flagged.

  • GET /collaboration/flagged

    Retrieves the number of topics and comments that are flagged by administrators.

Sample cURL Command

curl --location --request 
GET 'developer_portal_rest_base/topics/59d97968-7b25-4964-a0b7-d783ba910db2' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic basic_auth' \
--data-raw ''

The topic.yaml file is located at InstallDir\DeveloperPortal\developers\openapis.