APIDocumentApi


Update an Webapp Document

Update document details.\n

URL

http://apis.wso2.com/api/appm/publisher/v1.1/apps/{appType}/id/{appId}/docs/{documentId}

HTTP Method

PUT

Scope

appm:create

CURL Example

curl -k -H "Authorization:Bearer b0982cd2aacd463ff5f63cd5ebe58f4a" -H "Content-Type: application/json" -X PUT -d data.json "http://127.0.0.1:9763/api/am/publisher/v0.9/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/documents"

Sample Request

{ "visibility": "API_LEVEL", "sourceType": "INLINE", "sourceUrl": null, "otherTypeName": null, "documentId": "0bcb7f05-599d-4e1a-adce-5cb89bfe58d5", "summary": "This is a sample documentation for v1.0.0", "name": "PhoneVerification API Documentation", "type": "HOWTO" }

Sample Response

HTTP/1.1 200 OK Content-Type: application/json { "visibility": "API_LEVEL", "sourceType": "INLINE", "sourceUrl": null, "otherTypeName": null, "documentId": "0bcb7f05-599d-4e1a-adce-5cb89bfe58d5", "summary": "This is a sample documentation for v1.0.0", "name": "PhoneVerification API Documentation", "type": "HOWTO" }

Parameters

Type Name Description Schema Default
Path

appId

required

**APP ID** consisting of the **UUID** of the App.\nThe following combination is also accepted as a valid APP ID: the provider of the app, name of the app and the version.\nShould be formatted as **provider-name-version**.\n

String

Path

documentId

required

Document UUID.\n

String

Path

appType

required

The App type (either Webapp/Mobile app).\n

String

Body

body

required

Document object that needs to be added\n

Document (Document)

Header

Content-Type

required

Media type of the entity in the body. Default is JSON.\n

String

JSON

Header

If-Match

optional

Validator for conditional requests; based on the ETag.\n

String

Header

If-Unmodified-Since

optional

Validator for conditional requests; based on the Last Modified header.\n

String

Responses

HTTP Code Description Schema

200

OK.\nDocument updated\n

Document

400

Bad Request.\nInvalid request or validation error.\n

Error

404

Not Found.\nThe resource to be updated does not exist.\n

Error

412

Precondition Failed.\nThe request has not been performed because one of the preconditions is not met.\n

Error