Adding section that details API Endpoints by Component #384
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adding fields to support new tables by endpoints
added new fields to support new tables by compenent
added new fields to support new tables by component
adding new tables by component
added more descriptive language to component table section
added function to build the component tables
testing swagger
testing swagger
updated yaml to use the servers property of the various post/get/delete openapi specifiction
updated to use server parameter
swapped to using server parameter
updated buildComponentTables to use the servers parameter
fixing spelling
fixing some language
adding server parameter to paths
fixed error if specified path is not defined in the yaml currently
|
From review on 5/14 call:
|
…rloading the server property, updated the respec-oas.js table generation function to match
…nent-table section, fixing const variable error in respec-oas
|
Updated to use the new parameter x-expectedCaller in yml files, also added x-expectedCaller to the new exchanges.yml endpoints. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR looks to resolve #285
A section has been added to the "The VC API " section of the document called "API Component Overview". This section summarizes all endpoints in the VC-API, grouping them by the component the endpoint is expected to live on, along with a table for each of these components that lists the API endpoint, as well as the component that is the expected caller of the endpoint.
The workflow/exchanges endpoints are not currently indexed but should be added after the following PR is completed:
#382
Preview | Diff