Scribd Logo
Upload

Welcome to Scribd!

  • Document A Pi

    Uploaded by

    Adwoa Asare
    9 views1 page
    This document describes the URIs, parameters, message bodies, and authentication requirements for an API that allows retrieving, creating, editing, and deleting articles and comments. There are URIs listed for getting articles by ID or tag, getting articles in a specified section, and getting or creating comments for an article. Authentication is required for URIs that create, edit, or delete data, while retrieval-only URIs do not require authentication.

    Original Description:

    Original Title

    Document a Pi

    Copyright

    © © All Rights Reserved

    Available Formats

    PDF, TXT or read online from Scribd

    Did you find this document useful?

    Is this content inappropriate?

    Report this Document
    This document describes the URIs, parameters, message bodies, and authentication requirements for an API that allows retrieving, creating, editing, and deleting articles and comments. There are URIs listed for getting articles by ID or tag, getting articles in a specified section, and getting or creating comments for an article. Authentication is required for URIs that create, edit, or delete data, while retrieval-only URIs do not require authentication.

    Copyright:

    © All Rights Reserved
    Download as PDF, TXT or read online from Scribd
    Flag for inappropriate content
    Download as pdf or txt
    9 views1 page

    Document A Pi

    Uploaded by

    Adwoa Asare
    This document describes the URIs, parameters, message bodies, and authentication requirements for an API that allows retrieving, creating, editing, and deleting articles and comments. There are URIs listed for getting articles by ID or tag, getting articles in a specified section, and getting or creating comments for an article. Authentication is required for URIs that create, edit, or delete data, while retrieval-only URIs do not require authentication.

    Copyright:

    © All Rights Reserved
    Download as PDF, TXT or read online from Scribd
    Flag for inappropriate content
    Download as pdf or txt
    of 1

    URI URI Parameters Message Body Input Description Requires

    Authentication
    ?
    GET /v1/articles/{articleId} articleId (required): The unique ID of the article None Get an article by ID No
    you want to receive information about.
    POST /v1/articles None articleTitle (required): the title of the article Creates a new article for the Yes
    articleSubtitle (optional): the subtitle of the authenticated user
    article
    articleAuthor (required): the author of the article
    articleContent (required): the content you want in
    your article
    PUT /v1/articles/{articleId} articleId (required): The unique ID of the article articleTitle (required): the title of the article Edit an article for the Yes
    you want to receive information about. articleSubtitle (optional): the subtitle of the authenticated user
    article
    articleAuthor (required): the author of the article
    articleContent (required): the content you want in
    your article
    DELETE /v1/articles/{articleId} articleId (required): The unique ID of the article None Delete an article for the Yes
    you want to receive information about. authenticated user
    GET /v1/articles?tag={tag} tag (required): The name of the tag that you want to None Get all the articles tagged with
    see articles with. a specific value Yes
    GET /v1/articles/{section} section (required): The section that you want to see None Get all the articles in a section
    articles in. Options are: humor, politics, news, of your choice. Sections include
    finance, sports. humor, politics, news, finance,
    and sports. Yes
    GET /v1/articles/{articleId}/comments articleId (required): The unique ID of the article None Get all the comments for an
    you are trying to receive information about. article Yes
    GET /v1/articles/{articleId}/comments/ articleId (required): The unique ID of the article None Get a specific comment in an
    {commentId} you want to receive information about. article
    commentId(required): The unique ID of the comment
    you want to receive information about. Yes
    POST /v1/articles/{articleId}/comments articleId (required): The unique ID of the article commentContent (required): The content of the Create a new comment for a
    you want to receive information about. comment you want to make on the article. specific article Yes
    GET /v1/articles/{section}?sort={sortMethod} section (required): The section that you want to see None Get all the articles in a section
    articles in. and sort them by most recently
    sortMethod(optional): The method you want to sort created or alphabetically
    your results in. Options are recently_created and
    alphabetical . Yes

    You might also like