Skip to content

Swagger docs for get /contacts endpoint - $@ 100,000 #300

Description

@kevkevinpal

[Description]

Building off of this file
https://raw.githubusercontent.com/stakwork/sphinx-relay/73fb40d40eaa53b255b387c4fa01f2c262dde64b/docs/deep/openapi.yml
we want to add documentation for /contacts endpoint which calls contacts.getContacts

you should be able to go to
https://petstore.swagger.io/#/
and plug in the link with the updated .yml file and you should see the /contacts endpoint


[Complexity] (1,2,3,5,7)

1


[To Reproduce]
go to
https://petstore.swagger.io/#/
and put in this file https://raw.githubusercontent.com/stakwork/sphinx-relay/73fb40d40eaa53b255b387c4fa01f2c262dde64b/docs/deep/openapi.yml
and you should see what we currently have
we want to add a new endpoint for /contacts


[Acceptance Criteria]

Given We have the updated yml file
When we plug in your new yml file's location
Then it should display the /contacts endpoint with the correct inputs and outputs


[Dependecies/Parent Tasks]

still waiting on this PR to be merged which includes this yml file but you should be able to update it from what was included above

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions