docs: add guide to using the api by arjun988 · Pull Request #3 · verifiable-presentation/identity

arjun988 · 2022-10-12T15:22:08Z

Closes #2

gamemaker1

Thanks @arjun988 for taking this up!

I've left a few comments with feedback on how we could improve this PR before merging it, please do take a look.

gamemaker1 · 2022-10-13T16:54:40Z

Hi @arjun988,

Thanks for adding the example cURL command, and the different responses the API returns.

Currently, the document does not have a proper structure (1) or proper formatting (2).

Could you please structure it as follows:

## Title

### Overview

<a brief about what the API does, and the end goal of creating a DID document for Ramesh>

### APIs

#### Creating a DID Document

<explain what calling the API does, and what the expected response is>

##### Request

<add in the raw HTTP request, as well as the cURL and HTTPie commands>

##### Response

<add the responses>

Please take a look at this guide on Markdown formatting, which is used in all .md files such as the calling-the-api.md file.

gamemaker1 · 2022-10-18T12:51:22Z

@@ -0,0 +1,166 @@
+## CALLING THE API


Please capitalise only the first letter of each word.

gamemaker1 · 2022-10-18T13:32:04Z

+### This API is used to generate and decentralized identity documents for all entities that are stored in a registry.
+### These documents contain the ID of the entity they describe, as well as the assertion or verification methods used by the entity to sign and verify credentials or ### presentations (respectively) generated or issued by them. student creating a DID using their school-issued email address.


The ### is used to create a heading, whereas these two lines are just text. Please remove the ###.

gamemaker1 · 2022-10-18T13:32:56Z

+### API
+
+#### Creating API document:
+#### POST /identity


Suggested change

#### POST /identity

#### POST /identity

gamemaker1 · 2022-10-18T13:37:17Z

+ ##### Request
+
+
+`A student creating a DID using their school-issued email address could make the following request:
+
+POST /identity HTTP/1.1`


Suggested change

##### Request

`A student creating a DID using their school-issued email address could make the following request:

POST /identity HTTP/1.1`

##### Request

A student creating a DID using their school-issued email address could make the following request:

<add the triple ` here>

POST /identity HTTP/1.1

gamemaker1 · 2022-10-18T13:38:14Z

+	}
+}
+```
+//Post  request body with curl


Please add this as a subheading and not a "comment":

Suggested change

//Post request body with curl

##### Post request body with curl

gamemaker1 · 2022-10-18T13:42:19Z

+4)The overhead/ header data is used as an identifier, and its sole purpose is to indicate the source and destination of the information being transmitted.
+
+
+#### Response


Suggested change

#### Response

#### Response

gamemaker1 · 2022-10-18T13:43:27Z

+	  }]
+	}
+}
+```


Please add some description here about the fields returned in the response, and what the user can do with it.

(See the readme, it already contains these details)

gamemaker1 · 2022-10-18T13:43:52Z

+}
+```
+
+//Error


Again, please use headings and not "comments"

gamemaker1 · 2022-10-18T13:44:03Z

+//Error
+
+```
+1) Invalid Identitifier Type


Please move this outside the code block

gamemaker1 · 2022-10-18T13:44:21Z

+}
+
+```
+


Please add a couple of lines explaining each error and why it could have occurred.

gamemaker1 requested changes Oct 13, 2022

View reviewed changes

Comment thread docs/calling-the-api.md Outdated

Comment thread docs/calling-the-api.md

Comment thread docs/calling-the-api.md

Comment thread docs/calling-the-api.md

arjun988 added 2 commits October 13, 2022 22:04

Created calling-the-api.md

be9ed72

Update calling-the-api.md

673a919

gamemaker1 force-pushed the patch-1 branch from 09ec107 to 673a919 Compare October 13, 2022 16:35

Update calling-api-md

b605ce0

arjun988 requested a review from gamemaker1 October 17, 2022 16:24

gamemaker1 requested changes Oct 18, 2022

View reviewed changes

gamemaker1 changed the title ~~Created calling-the-api.md~~ docs: add guide to using the api Oct 18, 2022

gamemaker1 mentioned this pull request Feb 8, 2023

docs: add guide to calling the API #2

Open

		### This API is used to generate and decentralized identity documents for all entities that are stored in a registry.
		### These documents contain the ID of the entity they describe, as well as the assertion or verification methods used by the entity to sign and verify credentials or ### presentations (respectively) generated or issued by them. student creating a DID using their school-issued email address.

	//Post request body with curl

	##### Post request body with curl

		4)The overhead/ header data is used as an identifier, and its sole purpose is to indicate the source and destination of the information being transmitted.


		#### Response

+              }
+              ```
+              //Error

Uh oh!

Conversation

arjun988 commented Oct 12, 2022 • edited by gamemaker1 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gamemaker1 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gamemaker1 commented Oct 13, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

arjun988 commented Oct 12, 2022 •

edited by gamemaker1

Loading